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
  • Field Details

  • Method Details

    • of

      public static RerouteRequest of​(java.util.function.Function<RerouteRequest.Builder,​ObjectBuilder<RerouteRequest>> fn)
    • commands

      public final java.util.List<Command> 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

      @Nullable public final Time 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

      @Nullable public final Time 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

      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​(ObjectDeserializer<RerouteRequest.Builder> op)