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

Class Command.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.cluster.reroute.Command.Builder
All Implemented Interfaces:
CopyableBuilder<Command.Builder,Command>, MutableBuilder<Command.Builder,Command>, ObjectBuilder<Command>
Enclosing class:
Command
public static class Command.Builder extends ObjectBuilderBase implements CopyableBuilder<Command.Builder,Command>
Builder for Command.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public Command.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<Command.Builder,Command>
      Returns:
      a new builder instance.

    • allocateEmptyPrimary

      @Nonnull public final Command.Builder allocateEmptyPrimary(@Nullable CommandAllocatePrimaryAction value)
      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

    • allocateEmptyPrimary

      @Nonnull public final Command.Builder allocateEmptyPrimary(Function<CommandAllocatePrimaryAction.Builder,ObjectBuilder<CommandAllocatePrimaryAction>> fn)
      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

      @Nonnull public final Command.Builder allocateReplica(@Nullable CommandAllocateReplicaAction value)
      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

    • allocateReplica

      @Nonnull public final Command.Builder allocateReplica(Function<CommandAllocateReplicaAction.Builder,ObjectBuilder<CommandAllocateReplicaAction>> fn)
      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

      @Nonnull public final Command.Builder allocateStalePrimary(@Nullable CommandAllocatePrimaryAction value)
      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

    • allocateStalePrimary

      @Nonnull public final Command.Builder allocateStalePrimary(Function<CommandAllocatePrimaryAction.Builder,ObjectBuilder<CommandAllocatePrimaryAction>> fn)
      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

      @Nonnull public final Command.Builder cancel(@Nullable CommandCancelAction value)
      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

    • cancel

      @Nonnull public final Command.Builder cancel(Function<CommandCancelAction.Builder,ObjectBuilder<CommandCancelAction>> fn)
      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

      @Nonnull public final Command.Builder move(@Nullable CommandMoveAction value)
      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

    • move

      @Nonnull public final Command.Builder move(Function<CommandMoveAction.Builder,ObjectBuilder<CommandMoveAction>> fn)
      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

    • build

      @Nonnull public Command build()
      Builds a Command.
      Specified by:
      build in interface ObjectBuilder<Command>
      Throws:
      NullPointerException - if some of the required fields are null.