Package org.opensearch.client.opensearch.cluster

Class RerouteRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<RerouteRequest>

Enclosing class:

RerouteRequest

public static class RerouteRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<RerouteRequest>

Builder for RerouteRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RerouteRequest	build()	Builds a RerouteRequest.
RerouteRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the cluster-manager node.
RerouteRequest.Builder	clusterManagerTimeout(Time value)	Period to wait for a connection to the cluster-manager node.
RerouteRequest.Builder	commands(java.util.function.Function<Command.Builder,ObjectBuilder<Command>> fn)	Defines the commands to perform.
RerouteRequest.Builder	commands(java.util.List<Command> list)	Defines the commands to perform.
RerouteRequest.Builder	commands(Command value, Command... values)	Defines the commands to perform.
RerouteRequest.Builder	dryRun(java.lang.Boolean value)	If true, then the request simulates the operation only and returns the resulting state.
RerouteRequest.Builder	explain(java.lang.Boolean value)	If true, then the response contains an explanation of why the commands can or cannot be executed.
RerouteRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
RerouteRequest.Builder	masterTimeout(Time value)	Deprecated.
RerouteRequest.Builder	metric(java.lang.String value, java.lang.String... values)	Limits the information returned to the specified metrics.
RerouteRequest.Builder	metric(java.util.List<java.lang.String> list)	Limits the information returned to the specified metrics.
RerouteRequest.Builder	retryFailed(java.lang.Boolean value)	If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.
RerouteRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
RerouteRequest.Builder	timeout(Time value)	Period to wait for a response.

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

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

commands

public final RerouteRequest.Builder commands(java.util.List<Command> list)

Defines the commands to perform.

API name: commands

Adds all elements of list to commands.

commands

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

Defines the commands to perform.

API name: commands

Adds one or more values to commands.

commands

public final RerouteRequest.Builder commands(java.util.function.Function<Command.Builder,ObjectBuilder<Command>> fn)

Defines the commands to perform.

API name: commands

Adds a value to commands using a builder lambda.

dryRun

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

If true, then the request simulates the operation only and returns the resulting state.

API name: dry_run

explain

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

If true, then the response contains an explanation of why the commands can or cannot be executed.

API name: explain

masterTimeout

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

Deprecated.

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

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

Deprecated.

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

clusterManagerTimeout

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

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

clusterManagerTimeout

public final RerouteRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

metric

public final RerouteRequest.Builder metric(java.util.List<java.lang.String> list)

Limits the information returned to the specified metrics.

API name: metric

Adds all elements of list to metric.

metric

public final RerouteRequest.Builder metric(java.lang.String value,
                                           java.lang.String... values)

Limits the information returned to the specified metrics.

API name: metric

Adds one or more values to metric.

retryFailed

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

If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.

API name: retry_failed

timeout

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

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

timeout

public final RerouteRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

build

public RerouteRequest build()

Builds a RerouteRequest.

Specified by:

build in interface ObjectBuilder<RerouteRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.