Package co.elastic.clients.elasticsearch.cluster

Class RerouteRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cluster.RerouteRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class RerouteRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
RerouteRequest(RerouteRequest.Builder builder)
RerouteRequest(java.util.function.Function<RerouteRequest.Builder,RerouteRequest.Builder> fn)

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.
java.lang.String	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.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRerouteRequestDeserializer(DelegatingDeserializer<RerouteRequest.Builder> op)
java.lang.String	timeout()	Period to wait for a response.

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,ElasticsearchError> ENDPOINT

Endpoint "cluster.reroute".

Constructor Details

RerouteRequest

public RerouteRequest(RerouteRequest.Builder builder)

RerouteRequest

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

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 java.lang.String 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 java.lang.String 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

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

setupRerouteRequestDeserializer

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