Class RerouteRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cluster.RerouteRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class RerouteRequest extends RequestBase implements JsonpSerializable
Allows to manually change the allocation of individual shards in the cluster.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RerouteRequest.Builder
Builder forRerouteRequest
.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 forRerouteRequest
static Endpoint<RerouteRequest,RerouteResponse,ErrorResponse>
_ENDPOINT
Endpoint "cluster.reroute
". -
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.Time
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.static RerouteRequest
of(java.util.function.Function<RerouteRequest.Builder,ObjectBuilder<RerouteRequest>> fn)
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(ObjectDeserializer<RerouteRequest.Builder> op)
Time
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
Json deserializer forRerouteRequest
-
_ENDPOINT
Endpoint "cluster.reroute
".
-
-
Method Details
-
of
public static RerouteRequest of(java.util.function.Function<RerouteRequest.Builder,ObjectBuilder<RerouteRequest>> fn) -
commands
Defines the commands to perform.API name:
commands
-
dryRun
@Nullable public final 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 final java.lang.Boolean explain()If true, then the response contains an explanation of why the commands can or cannot be executed.API name:
explain
-
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
-
metric
public final java.util.List<java.lang.String> metric()Limits the information returned to the specified metrics.API name:
metric
-
retryFailed
@Nullable public final 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
-
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
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupRerouteRequestDeserializer
protected static void setupRerouteRequestDeserializer(ObjectDeserializer<RerouteRequest.Builder> op)
-