Package org.opensearch.client.opensearch.cluster

Class RerouteRequest.Builder

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<RerouteRequest>

Enclosing class:

RerouteRequest

public static class RerouteRequest.Builder
extends java.lang.Object
implements ObjectBuilder<RerouteRequest>

Builder for RerouteRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RerouteRequest.Builder	addCommands(java.util.function.Function<Command.Builder,ObjectBuilder<Command>> fn)	Add a value to commands(List), creating the list if needed.
RerouteRequest.Builder	addCommands(Command value)	Add a value to commands(List), creating the list if needed.
RerouteRequest.Builder	addMetric(java.lang.String value)	Add a value to metric(List), creating the list if needed.
RerouteRequest	build()	Builds a RerouteRequest.
RerouteRequest.Builder	commands(java.util.function.Function<Command.Builder,ObjectBuilder<Command>> fn)	Set commands(List) to a singleton list.
RerouteRequest.Builder	commands(java.util.List<Command> value)	Defines the commands to perform.
RerouteRequest.Builder	commands(Command... value)	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(jakarta.json.JsonValue value)	Period to wait for a connection to the master node.
RerouteRequest.Builder	metric(java.lang.String... value)	Limits the information returned to the specified metrics.
RerouteRequest.Builder	metric(java.util.List<java.lang.String> value)	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(jakarta.json.JsonValue value)	Period to wait for a response.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

dryRun

public 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 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

metric

public RerouteRequest.Builder metric(@Nullable java.util.List<java.lang.String> value)

Limits the information returned to the specified metrics. API name: metric

metric

public RerouteRequest.Builder metric(java.lang.String... value)

Limits the information returned to the specified metrics. API name: metric

addMetric

public RerouteRequest.Builder addMetric(java.lang.String value)

Add a value to metric(List), creating the list if needed.

retryFailed

public 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

masterTimeout

public RerouteRequest.Builder masterTimeout(@Nullable jakarta.json.JsonValue value)

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

timeout

public RerouteRequest.Builder timeout(@Nullable jakarta.json.JsonValue 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

commands

public RerouteRequest.Builder commands(@Nullable java.util.List<Command> value)

Defines the commands to perform. API name: commands

commands

public RerouteRequest.Builder commands(Command... value)

Defines the commands to perform. API name: commands

addCommands

public RerouteRequest.Builder addCommands(Command value)

Add a value to commands(List), creating the list if needed.

commands

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

Set commands(List) to a singleton list.

addCommands

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

Add a value to commands(List), creating the list if needed.

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.