Package org.opensearch.client.opensearch.cluster.reroute

Class Command

java.lang.Object
org.opensearch.client.opensearch.cluster.reroute.Command
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<Command.Builder,Command>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class Command extends Object implements PlainJsonSerializable, ToCopyableBuilder<Command.Builder,Command>

  • Field Details

  • Method Details

    • of

      public static Command of(Function<Command.Builder,ObjectBuilder<Command>> fn)

    • allocateEmptyPrimary

      @Nullable public final CommandAllocatePrimaryAction allocateEmptyPrimary()
      Allocate an empty primary shard to a node. Accepts index and shard for index name and shard number, and node to allocate the shard to. Using this command leads to a complete loss of all data that was indexed into this shard, if it was previously started. If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true.

      API name: allocate_empty_primary

    • allocateReplica

      @Nullable public final CommandAllocateReplicaAction allocateReplica()
      Allocate an unassigned replica shard to a node. Accepts index and shard for index name and shard number, and node to allocate the shard to. Takes allocation deciders into account.

      API name: allocate_replica

    • allocateStalePrimary

      @Nullable public final CommandAllocatePrimaryAction allocateStalePrimary()
      Allocate a primary shard to a node that holds a stale copy. Accepts index and shard for index name and shard number, and node to allocate the shard to. Using this command may lead to data loss for the provided shard id. If a node which has the good copy of the data rejoins the cluster later on, that data will be deleted or overwritten with the data of the stale copy that was forcefully allocated with this command. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true.

      API name: allocate_stale_primary

    • cancel

      @Nullable public final CommandCancelAction cancel()
      Cancel allocation of a shard (or recovery). Accepts index and shard for index name and shard number, and node for the node to cancel the shard allocation on. This can be used to force resynchronization of existing replicas from the primary shard by cancelling them and allowing them to be reinitialized through the standard recovery process. By default only replica shard allocations can be cancelled. If it is necessary to cancel the allocation of a primary shard then the allow_primary flag must also be included in the request.

      API name: cancel

    • move

      @Nullable public final CommandMoveAction move()
      Move a started shard from one node to another node. Accepts index and shard for index name and shard number, from_node for the node to move the shard from, and to_node for the node to move the shard to.

      API name: move

    • 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)

    • toBuilder

      @Nonnull public Command.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Command.Builder,Command>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static Command.Builder builder()

    • setupCommandDeserializer

      protected static void setupCommandDeserializer(ObjectDeserializer<Command.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object