Package org.opensearch.client.opensearch.cluster

Class RerouteRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cluster.RerouteRequest

All Implemented Interfaces:

ToJsonp

public final class RerouteRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RerouteRequest.Builder	Builder for RerouteRequest.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<RerouteRequest>	DESERIALIZER	Json deserializer for RerouteRequest
static Endpoint<RerouteRequest,RerouteResponse,OpenSearchError>	ENDPOINT	Endpoint "cluster.reroute".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RerouteRequest(RerouteRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.util.List<Command>	commands()	Defines the commands to perform.
java.lang.Boolean	dryRun()	If true, then the request simulates the operation only and returns the resulting state.
java.lang.Boolean	explain()	If true, then the response contains an explanation of why the commands can or cannot be executed.
jakarta.json.JsonValue	masterTimeout()	Period to wait for a connection to the master node.
java.util.List<java.lang.String>	metric()	Limits the information returned to the specified metrics.
java.lang.Boolean	retryFailed()	If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.
protected static void	setupRerouteRequestDeserializer(DelegatingDeserializer<RerouteRequest.Builder> op)
jakarta.json.JsonValue	timeout()	Period to wait for a response.
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<RerouteRequest> DESERIALIZER

Json deserializer for RerouteRequest

ENDPOINT

public static final Endpoint<RerouteRequest,RerouteResponse,OpenSearchError> ENDPOINT

Endpoint "cluster.reroute".

Constructor Details

RerouteRequest

protected RerouteRequest(RerouteRequest.Builder builder)

Method Details

dryRun

@Nullable public java.lang.Boolean dryRun()

If true, then the request simulates the operation only and returns the resulting state. API name: dry_run

explain

@Nullable public java.lang.Boolean explain()

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

metric

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

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

retryFailed

@Nullable public java.lang.Boolean retryFailed()

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

masterTimeout

@Nullable public jakarta.json.JsonValue masterTimeout()

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

@Nullable public jakarta.json.JsonValue timeout()

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

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

Defines the commands to perform. API name: commands

toJsonp

public void toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

protected void toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

setupRerouteRequestDeserializer

protected static void setupRerouteRequestDeserializer(DelegatingDeserializer<RerouteRequest.Builder> op)