Package org.elasticsearch.cluster.routing.allocation.command

Interface AllocationCommand

All Superinterfaces:
NamedWriteable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, Writeable
All Known Implementing Classes:
AbstractAllocateAllocationCommand, AllocateEmptyPrimaryAllocationCommand, AllocateReplicaAllocationCommand, AllocateStalePrimaryAllocationCommand, BasePrimaryAllocationCommand, CancelAllocationCommand, MoveAllocationCommand
public interface AllocationCommand
extends NamedWriteable, org.elasticsearch.common.xcontent.ToXContentObject
A command to move shards in some way. Commands are registered in NetworkModule.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>

  • Field Summary

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type Method Description
    RerouteExplanation execute​(RoutingAllocation allocation, boolean explain)
    Executes the command on a RoutingAllocation setup
    default java.util.Optional<java.lang.String> getMessage()
    Returns any feedback the command wants to provide for logging.
    default java.lang.String getWriteableName()
    Returns the name of the writeable object
    java.lang.String name()
    Get the name of the command

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

    toXContent

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment

    Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

    writeTo

  • Method Details

    • name

      java.lang.String name()
      Get the name of the command
      Returns:
      name of the command

    • execute

      RerouteExplanation execute​(RoutingAllocation allocation, boolean explain)
      Executes the command on a RoutingAllocation setup
      Parameters:
      allocation - RoutingAllocation to modify
      Throws:
      ElasticsearchException - if something happens during reconfiguration

    • getWriteableName

      default java.lang.String getWriteableName()
      Description copied from interface: NamedWriteable
      Returns the name of the writeable object
      Specified by:
      getWriteableName in interface NamedWriteable

    • getMessage

      default java.util.Optional<java.lang.String> getMessage()
      Returns any feedback the command wants to provide for logging. This message should be appropriate to expose to the user after the command has been applied