Module org.elasticsearch.server
Package org.elasticsearch.indices.cluster

Enum Class IndexRemovalReason

java.lang.Object
java.lang.Enum<IndexRemovalReason>
org.elasticsearch.indices.cluster.IndexRemovalReason
All Implemented Interfaces:
Serializable, Comparable<IndexRemovalReason>, Constable
public enum IndexRemovalReason extends Enum<IndexRemovalReason>
The reasons why an index or shard is being removed from a node.

  • Enum Constant Details

    • NO_LONGER_ASSIGNED

      public static final IndexRemovalReason NO_LONGER_ASSIGNED
      Shard of this index were previously assigned to this node but all shards have been relocated. The index should be removed and all associated resources released. Persistent parts of the index like the shards files, state and transaction logs are kept around in the case of a disaster recovery.

    • DELETED

      public static final IndexRemovalReason DELETED
      The index is deleted. Persistent parts of the index like the shards files, state and transaction logs are removed once all resources are released.

    • CLOSED

      public static final IndexRemovalReason CLOSED
      The index has been closed. The index should be removed and all associated resources released. Persistent parts of the index like the shards files, state and transaction logs are kept around in the case of a disaster recovery.

    • FAILURE

      public static final IndexRemovalReason FAILURE
      Something around index management has failed and the index should be removed. Persistent parts of the index like the shards files, state and transaction logs are kept around in the case of a disaster recovery.

    • REOPENED

      public static final IndexRemovalReason REOPENED
      The index has been reopened. The index should be removed and all associated resources released. Persistent parts of the index like the shards files, state and transaction logs are kept around in the case of a disaster recovery.

    • SHUTDOWN

      public static final IndexRemovalReason SHUTDOWN
      The index is closed as part of the node shutdown process. The index should be removed and all associated resources released. Persistent parts of the index like the shards files, state and transaction logs should be kept around in the case the node restarts.

  • Method Details

    • values

      public static IndexRemovalReason[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static IndexRemovalReason valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null