Package org.opensearch.client.opensearch.security

Class GetDistinguishedNameRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<GetDistinguishedNameRequest.Builder>

org.opensearch.client.opensearch.security.GetDistinguishedNameRequest.Builder

All Implemented Interfaces:

CopyableBuilder<GetDistinguishedNameRequest.Builder,GetDistinguishedNameRequest>, MutableBuilder<GetDistinguishedNameRequest.Builder,GetDistinguishedNameRequest>, ObjectBuilder<GetDistinguishedNameRequest>

Enclosing class:

GetDistinguishedNameRequest

public static class GetDistinguishedNameRequest.Builder
extends RequestBase.AbstractBuilder<GetDistinguishedNameRequest.Builder>
implements CopyableBuilder<GetDistinguishedNameRequest.Builder,GetDistinguishedNameRequest>

Builder for GetDistinguishedNameRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetDistinguishedNameRequest	build()	Builds a GetDistinguishedNameRequest.
final GetDistinguishedNameRequest.Builder	clusterName(String value)	Required - The name of the cluster to retrieve that cluster's nodes DN settings.
GetDistinguishedNameRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected GetDistinguishedNameRequest.Builder	self()
final GetDistinguishedNameRequest.Builder	showAll(Boolean value)	Whether to include or exclude any static node's DN settings from the final result.

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public GetDistinguishedNameRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<GetDistinguishedNameRequest.Builder,GetDistinguishedNameRequest>

Returns:

a new builder instance.

self

@Nonnull
protected GetDistinguishedNameRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetDistinguishedNameRequest.Builder>

clusterName

@Nonnull
public final GetDistinguishedNameRequest.Builder clusterName(String value)

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

API name: cluster_name

showAll

@Nonnull
public final GetDistinguishedNameRequest.Builder showAll(@Nullable
 Boolean value)

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

API name: show_all

build

@Nonnull
public GetDistinguishedNameRequest build()

Builds a GetDistinguishedNameRequest.

Specified by:

build in interface ObjectBuilder<GetDistinguishedNameRequest>

Throws:

NullPointerException - if some of the required fields are null.