Package org.opensearch.client.opensearch.cat

Class AllocationRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

org.opensearch.client.opensearch.cat.AllocationRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

AllocationRequest

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

Builder for AllocationRequest.

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
AllocationRequest	build()	Builds a AllocationRequest.
final AllocationRequest.Builder	bytes(Bytes value)	The units used to display byte values.
final AllocationRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	A timeout for connection to the cluster manager node.
final AllocationRequest.Builder	clusterManagerTimeout(Time value)	A timeout for connection to the cluster manager node.
AllocationRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AllocationRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final AllocationRequest.Builder	masterTimeout(Time value)	Deprecated.
final AllocationRequest.Builder	nodeId(String value, String... values)	A comma-separated list of node IDs or names used to limit the returned information.
final AllocationRequest.Builder	nodeId(List<String> list)	A comma-separated list of node IDs or names used to limit the returned information.
protected AllocationRequest.Builder	self()

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

Returns:

a new builder instance.

self

@Nonnull
protected AllocationRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<AllocationRequest.Builder>

bytes

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

The units used to display byte values.

API name: bytes

clusterManagerTimeout

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

A timeout for connection to the cluster manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

A timeout for connection to the cluster manager node.

API name: cluster_manager_timeout

masterTimeout

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

Deprecated.

A timeout for connection to the cluster manager node.

API name: master_timeout

masterTimeout

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

Deprecated.

A timeout for connection to the cluster manager node.

API name: master_timeout

nodeId

@Nonnull
public final AllocationRequest.Builder nodeId(List<String> list)

A comma-separated list of node IDs or names used to limit the returned information.

API name: node_id

Adds all elements of list to nodeId.

nodeId

@Nonnull
public final AllocationRequest.Builder nodeId(String value,
 String... values)

A comma-separated list of node IDs or names used to limit the returned information.

API name: node_id

Adds one or more values to nodeId.

build

@Nonnull
public AllocationRequest build()

Builds a AllocationRequest.

Specified by:

build in interface ObjectBuilder<AllocationRequest>

Throws:

NullPointerException - if some of the required fields are null.