Package org.opensearch.client.opensearch.cluster

Class RerouteRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.cluster.RerouteRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

RerouteRequest

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

Builder for RerouteRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RerouteRequest	build()	Builds a RerouteRequest.
final RerouteRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response from the cluster manager node.
final RerouteRequest.Builder	clusterManagerTimeout(Time value)	The amount of time to wait for a response from the cluster manager node.
final RerouteRequest.Builder	commands(Function<Command.Builder,ObjectBuilder<Command>> fn)	Defines the reroute commands to perform, either move, cancel, or allocate.
final RerouteRequest.Builder	commands(List<Command> list)	Defines the reroute commands to perform, either move, cancel, or allocate.
final RerouteRequest.Builder	commands(Command value, Command... values)	Defines the reroute commands to perform, either move, cancel, or allocate.
RerouteRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RerouteRequest.Builder	dryRun(Boolean value)	When true, the request simulates the operation and returns the resulting state.
final RerouteRequest.Builder	explain(Boolean value)	When true, the response contains an explanation of why reroute certain commands can or cannot be executed.
final RerouteRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final RerouteRequest.Builder	masterTimeout(Time value)	Deprecated.
final RerouteRequest.Builder	metric(List<ClusterRerouteMetric> list)	Limits the information returned to the specified metrics.
final RerouteRequest.Builder	metric(ClusterRerouteMetric value, ClusterRerouteMetric... values)	Limits the information returned to the specified metrics.
final RerouteRequest.Builder	retryFailed(Boolean value)	When true, retries shard allocation if it was blocked because of too many subsequent failures.
protected RerouteRequest.Builder	self()
final RerouteRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	A duration.
final RerouteRequest.Builder	timeout(Time value)	A duration.

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

Returns:

a new builder instance.

self

@Nonnull
protected RerouteRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RerouteRequest.Builder>

clusterManagerTimeout

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

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

clusterManagerTimeout

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

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

commands

@Nonnull
public final RerouteRequest.Builder commands(List<Command> list)

Defines the reroute commands to perform, either move, cancel, or allocate.

API name: commands

Adds all elements of list to commands.

commands

@Nonnull
public final RerouteRequest.Builder commands(Command value,
 Command... values)

Defines the reroute commands to perform, either move, cancel, or allocate.

API name: commands

Adds one or more values to commands.

commands

@Nonnull
public final RerouteRequest.Builder commands(Function<Command.Builder,ObjectBuilder<Command>> fn)

Defines the reroute commands to perform, either move, cancel, or allocate.

API name: commands

Adds a value to commands using a builder lambda.

dryRun

@Nonnull
public final RerouteRequest.Builder dryRun(@Nullable
 Boolean value)

When true, the request simulates the operation and returns the resulting state.

API name: dry_run

explain

@Nonnull
public final RerouteRequest.Builder explain(@Nullable
 Boolean value)

When true, the response contains an explanation of why reroute certain commands can or cannot be executed.

API name: explain

masterTimeout

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

Deprecated.

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: master_timeout

masterTimeout

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

Deprecated.

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: master_timeout

metric

@Nonnull
public final RerouteRequest.Builder metric(List<ClusterRerouteMetric> list)

Limits the information returned to the specified metrics.

API name: metric

Adds all elements of list to metric.

metric

@Nonnull
public final RerouteRequest.Builder metric(ClusterRerouteMetric value,
 ClusterRerouteMetric... values)

Limits the information returned to the specified metrics.

API name: metric

Adds one or more values to metric.

retryFailed

@Nonnull
public final RerouteRequest.Builder retryFailed(@Nullable
 Boolean value)

When true, retries shard allocation if it was blocked because of too many subsequent failures.

API name: retry_failed

timeout

@Nonnull
public final RerouteRequest.Builder timeout(@Nullable
 Time value)

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: timeout

timeout

@Nonnull
public final RerouteRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: timeout

build

@Nonnull
public RerouteRequest build()

Builds a RerouteRequest.

Specified by:

build in interface ObjectBuilder<RerouteRequest>

Throws:

NullPointerException - if some of the required fields are null.