Package org.opensearch.client.opensearch.security

Class GetDistinguishedNamesRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.security.GetDistinguishedNamesRequest

All Implemented Interfaces:

ToCopyableBuilder<GetDistinguishedNamesRequest.Builder,GetDistinguishedNamesRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class GetDistinguishedNamesRequest
extends RequestBase
implements ToCopyableBuilder<GetDistinguishedNamesRequest.Builder,GetDistinguishedNamesRequest>

Retrieves all node distinguished names. Requires super admin or REST API permissions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetDistinguishedNamesRequest.Builder	Builder for GetDistinguishedNamesRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetDistinguishedNamesRequest,GetDistinguishedNamesResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.get_distinguished_names".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static GetDistinguishedNamesRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static GetDistinguishedNamesRequest	of(Function<GetDistinguishedNamesRequest.Builder,ObjectBuilder<GetDistinguishedNamesRequest>> fn)
final Boolean	showAll()	Whether to include or exclude any static node's DN settings from the final result.
GetDistinguishedNamesRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<GetDistinguishedNamesRequest,GetDistinguishedNamesResponse,ErrorResponse> _ENDPOINT

Endpoint "security.get_distinguished_names".

Method Details

of

public static GetDistinguishedNamesRequest of(Function<GetDistinguishedNamesRequest.Builder,ObjectBuilder<GetDistinguishedNamesRequest>> fn)

showAll

@Nullable
public final Boolean showAll()

Whether to include or exclude any static node's DN settings from the final result.

API name: show_all

toBuilder

@Nonnull
public GetDistinguishedNamesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetDistinguishedNamesRequest.Builder,GetDistinguishedNamesRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static GetDistinguishedNamesRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object