Package org.opensearch.client.opensearch.cat

Class NodesRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder<NodesRequest.Builder>

org.opensearch.client.opensearch.cat.NodesRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

NodesRequest

public static class NodesRequest.Builder
extends CatRequestBase.AbstractBuilder<NodesRequest.Builder>
implements CopyableBuilder<NodesRequest.Builder,NodesRequest>

Builder for NodesRequest.

Field Summary

Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, sort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NodesRequest	build()	Builds a NodesRequest.
final NodesRequest.Builder	bytes(Bytes value)	The units used to display byte values.
final NodesRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time allowed to establish a connection to the cluster manager node.
final NodesRequest.Builder	clusterManagerTimeout(Time value)	The amount of time allowed to establish a connection to the cluster manager node.
NodesRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final NodesRequest.Builder	fullId(Boolean value)	When true, returns the full node ID.
final NodesRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final NodesRequest.Builder	masterTimeout(Time value)	Deprecated.
protected NodesRequest.Builder	self()
final NodesRequest.Builder	time(TimeUnit value)	Specifies the time units, for example, 5d or 7h.

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, headers, sort, sort

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

Returns:

a new builder instance.

self

@Nonnull
protected NodesRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<NodesRequest.Builder>

bytes

@Nonnull
public final NodesRequest.Builder bytes(@Nullable
 Bytes value)

The units used to display byte values.

API name: bytes

clusterManagerTimeout

@Nonnull
public final NodesRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final NodesRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

fullId

@Nonnull
public final NodesRequest.Builder fullId(@Nullable
 Boolean value)

When true, returns the full node ID. When false, returns the shortened node ID.

API name: full_id

masterTimeout

@Deprecated
@Nonnull
public final NodesRequest.Builder masterTimeout(@Nullable
 Time value)

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

masterTimeout

@Deprecated
@Nonnull
public final NodesRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

time

@Nonnull
public final NodesRequest.Builder time(@Nullable
 TimeUnit value)

Specifies the time units, for example, 5d or 7h. For more information, see Supported units.

API name: time

build

@Nonnull
public NodesRequest build()

Builds a NodesRequest.

Specified by:

build in interface ObjectBuilder<NodesRequest>

Throws:

NullPointerException - if some of the required fields are null.