Package org.elasticsearch.action.admin.cluster.snapshots.status

Enum Class SnapshotIndexShardStage

<SnapshotIndexShardStage>
org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotIndexShardStage
All Implemented Interfaces:
, <
public enum SnapshotIndexShardStage extends <SnapshotIndexShardStage>

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.

    < extends <>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DONE
    Snapshot completed successfully
    FAILURE
    Snapshot failed
    FINALIZE
    Snapshot metadata is being written or this shard's status in the cluster state is being updated
    INIT
    Snapshot hasn't started yet
    STARTED
    Index files are being copied

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    completed()
    Returns true if snapshot completed (successfully or not)
    static SnapshotIndexShardStage
    fromValue​(byte value)
    Generate snapshot state from code
    byte
    value()
    Returns code that represents the snapshot state
    static SnapshotIndexShardStage
     name)
    Returns the enum constant of this class with the specified name.
    static SnapshotIndexShardStage[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.

    , , , , , , , , , ,

    Methods inherited from class java.lang.

    , , , , ,

  • Enum Constant Details

  • Method Details

    • values

      public static SnapshotIndexShardStage[] 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  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:
      - if this enum class has no constant with the specified name
      - if the argument is null

    • value

      public byte value()
      Returns code that represents the snapshot state
      Returns:
      code for the state

    • completed

      public boolean completed()
      Returns true if snapshot completed (successfully or not)
      Returns:
      true if snapshot completed, false otherwise

    • fromValue

      public static SnapshotIndexShardStage fromValue​(byte value)
      Generate snapshot state from code
      Parameters:
      value - the state code
      Returns:
      state