Package org.opensearch.client.opensearch.security

Class GetDistinguishedNameRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.security.GetDistinguishedNameRequest

All Implemented Interfaces:

ToCopyableBuilder<GetDistinguishedNameRequest.Builder,GetDistinguishedNameRequest>

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

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

Nested Class Summary

Nested Classes

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

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<GetDistinguishedNameRequest,GetDistinguishedNameResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.get_distinguished_name".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static GetDistinguishedNameRequest.Builder	builder()
final String	clusterName()	Required - The name of the cluster to retrieve that cluster's nodes DN settings.
boolean	equals(Object o)
int	hashCode()
static GetDistinguishedNameRequest	of(Function<GetDistinguishedNameRequest.Builder,ObjectBuilder<GetDistinguishedNameRequest>> fn)
final Boolean	showAll()	Whether to include or exclude any static node's DN settings from the final result.
GetDistinguishedNameRequest.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<GetDistinguishedNameRequest,GetDistinguishedNameResponse,ErrorResponse> _ENDPOINT

Endpoint "security.get_distinguished_name".

Method Details

of

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

clusterName

@Nonnull
public final String clusterName()

Required - The name of the cluster to retrieve that cluster's nodes DN settings.

API name: cluster_name

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 GetDistinguishedNameRequest.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<GetDistinguishedNameRequest.Builder,GetDistinguishedNameRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static GetDistinguishedNameRequest.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