Package org.elasticsearch.cluster

Enum Class RestoreInProgress.State

<RestoreInProgress.State>
org.elasticsearch.cluster.RestoreInProgress.State
All Implemented Interfaces:
, <
Enclosing class:
RestoreInProgress
public static enum RestoreInProgress.State extends <RestoreInProgress.State>
Shard restore process state

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.

    < extends <>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    FAILURE
    Restore failed
    INIT
    Initializing state
    STARTED
    Started state
    SUCCESS
    Restore finished successfully

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    completed()
    Returns true if restore process completed (either successfully or with failure)
    static RestoreInProgress.State
    fromValue​(byte value)
    Returns state corresponding to state code
    byte
    value()
    Returns state code
    static RestoreInProgress.State
     name)
    Returns the enum constant of this class with the specified name.
    static RestoreInProgress.State[]
    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 RestoreInProgress.State[] 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 state code
      Returns:
      state code

    • completed

      public boolean completed()
      Returns true if restore process completed (either successfully or with failure)
      Returns:
      true if restore process completed

    • fromValue

      public static RestoreInProgress.State fromValue​(byte value)
      Returns state corresponding to state code
      Parameters:
      value - stat code
      Returns:
      state