Enum SnapshotIndexShardStage
java.lang.Object
java.lang.Enum<SnapshotIndexShardStage>
org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotIndexShardStage
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<SnapshotIndexShardStage>
,java.lang.constant.Constable
public enum SnapshotIndexShardStage extends java.lang.Enum<SnapshotIndexShardStage>
-
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
-
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 codebyte
value()
Returns code that represents the snapshot statestatic SnapshotIndexShardStage
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static SnapshotIndexShardStage[]
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
-
INIT
Snapshot hasn't started yet -
STARTED
Index files are being copied -
FINALIZE
Snapshot metadata is being written or this shard's status in the cluster state is being updated -
DONE
Snapshot completed successfully -
FAILURE
Snapshot failed
-
-
Method Details
-
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
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 namejava.lang.NullPointerException
- 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
Generate snapshot state from code- Parameters:
value
- the state code- Returns:
- state
-