Package org.elasticsearch.snapshots
Enum SnapshotState
java.lang.Object
java.lang.Enum<SnapshotState>
org.elasticsearch.snapshots.SnapshotState
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<SnapshotState>
,java.lang.constant.Constable
public enum SnapshotState extends java.lang.Enum<SnapshotState>
Represents the state that a snapshot can be in
-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description FAILED
Snapshot failedIN_PROGRESS
Snapshot process has startedINCOMPATIBLE
Snapshot is incompatible with the current version of the clusterPARTIAL
Snapshot was partial successfulSUCCESS
Snapshot process completed successfully -
Method Summary
Modifier and Type Method Description boolean
completed()
Returns true if snapshot completed (successfully or not)static SnapshotState
fromValue(byte value)
Generate snapshot state from codeboolean
restorable()
Returns true if snapshot can be restored (at least partially)byte
value()
Returns code that represents the snapshot statestatic SnapshotState
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static SnapshotState[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
IN_PROGRESS
Snapshot process has started -
SUCCESS
Snapshot process completed successfully -
FAILED
Snapshot failed -
PARTIAL
Snapshot was partial successful -
INCOMPATIBLE
Snapshot is incompatible with the current version of the cluster
-
-
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
-
restorable
public boolean restorable()Returns true if snapshot can be restored (at least partially)- Returns:
- true if snapshot can be restored, false otherwise
-
fromValue
Generate snapshot state from code- Parameters:
value
- the state code- Returns:
- state
-