Enum UnassignedInfo.Reason

java.lang.Object
java.lang.Enum<UnassignedInfo.Reason>
org.elasticsearch.cluster.routing.UnassignedInfo.Reason
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<UnassignedInfo.Reason>, java.lang.constant.Constable
Enclosing class:
UnassignedInfo

public static enum UnassignedInfo.Reason
extends java.lang.Enum<UnassignedInfo.Reason>
Reason why the shard is in unassigned state.

Note, ordering of the enum is important, make sure to add new values at the end and handle version serialization properly.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    ALLOCATION_FAILED
    Unassigned as a result of a failed allocation of the shard.
    CLUSTER_RECOVERED
    Unassigned as a result of a full cluster recovery.
    DANGLING_INDEX_IMPORTED
    Unassigned as a result of importing a dangling index.
    EXISTING_INDEX_RESTORED
    Unassigned as a result of restoring into a closed index.
    FORCED_EMPTY_PRIMARY
    Unassigned after forcing an empty primary
    INDEX_CLOSED
    Unassigned as a result of closing an index.
    INDEX_CREATED
    Unassigned as a result of an API creation of an index.
    INDEX_REOPENED
    Unassigned as a result of opening a closed index.
    MANUAL_ALLOCATION
    Forced manually to allocate
    NEW_INDEX_RESTORED
    Unassigned as a result of restoring into a new index.
    NODE_LEFT
    Unassigned as a result of the node hosting it leaving the cluster.
    PRIMARY_FAILED
    Unassigned as a result of a failed primary while the replica was initializing.
    REALLOCATED_REPLICA
    A better replica location is identified and causes the existing replica allocation to be cancelled.
    REINITIALIZED
    When a shard moves from started back to initializing.
    REPLICA_ADDED
    Unassigned as a result of explicit addition of a replica.
    REROUTE_CANCELLED
    Unassigned as a result of explicit cancel reroute command.
  • Method Summary

    Modifier and Type Method Description
    static UnassignedInfo.Reason valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static UnassignedInfo.Reason[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • INDEX_CREATED

      public static final UnassignedInfo.Reason INDEX_CREATED
      Unassigned as a result of an API creation of an index.
    • CLUSTER_RECOVERED

      public static final UnassignedInfo.Reason CLUSTER_RECOVERED
      Unassigned as a result of a full cluster recovery.
    • INDEX_REOPENED

      public static final UnassignedInfo.Reason INDEX_REOPENED
      Unassigned as a result of opening a closed index.
    • DANGLING_INDEX_IMPORTED

      public static final UnassignedInfo.Reason DANGLING_INDEX_IMPORTED
      Unassigned as a result of importing a dangling index.
    • NEW_INDEX_RESTORED

      public static final UnassignedInfo.Reason NEW_INDEX_RESTORED
      Unassigned as a result of restoring into a new index.
    • EXISTING_INDEX_RESTORED

      public static final UnassignedInfo.Reason EXISTING_INDEX_RESTORED
      Unassigned as a result of restoring into a closed index.
    • REPLICA_ADDED

      public static final UnassignedInfo.Reason REPLICA_ADDED
      Unassigned as a result of explicit addition of a replica.
    • ALLOCATION_FAILED

      public static final UnassignedInfo.Reason ALLOCATION_FAILED
      Unassigned as a result of a failed allocation of the shard.
    • NODE_LEFT

      public static final UnassignedInfo.Reason NODE_LEFT
      Unassigned as a result of the node hosting it leaving the cluster.
    • REROUTE_CANCELLED

      public static final UnassignedInfo.Reason REROUTE_CANCELLED
      Unassigned as a result of explicit cancel reroute command.
    • REINITIALIZED

      public static final UnassignedInfo.Reason REINITIALIZED
      When a shard moves from started back to initializing.
    • REALLOCATED_REPLICA

      public static final UnassignedInfo.Reason REALLOCATED_REPLICA
      A better replica location is identified and causes the existing replica allocation to be cancelled.
    • PRIMARY_FAILED

      public static final UnassignedInfo.Reason PRIMARY_FAILED
      Unassigned as a result of a failed primary while the replica was initializing.
    • FORCED_EMPTY_PRIMARY

      public static final UnassignedInfo.Reason FORCED_EMPTY_PRIMARY
      Unassigned after forcing an empty primary
    • MANUAL_ALLOCATION

      public static final UnassignedInfo.Reason MANUAL_ALLOCATION
      Forced manually to allocate
    • INDEX_CLOSED

      public static final UnassignedInfo.Reason INDEX_CLOSED
      Unassigned as a result of closing an index.
  • Method Details

    • values

      public static UnassignedInfo.Reason[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static UnassignedInfo.Reason valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null