org.elasticsearch.snapshots

Enum SnapshotState

java.lang.Object

java.lang.Enum<SnapshotState>

org.elasticsearch.snapshots.SnapshotState

All Implemented Interfaces:

Serializable, Comparable<SnapshotState>

public enum SnapshotState
extends Enum<SnapshotState>

Represents the state that a snapshot can be in

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED Snapshot failed
IN_PROGRESS Snapshot process has started
PARTIAL Snapshot was partial successful
SUCCESS Snapshot process completed successfully

Method Summary

Modifier and Type	Method and Description
boolean	completed() Returns true if snapshot completed (successfully or not)
static SnapshotState	fromValue(byte value) Generate snapshot state from code
boolean	restorable() Returns true if snapshot can be restored (at least partially)
byte	value() Returns code that represents the snapshot state
static SnapshotState	valueOf(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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IN_PROGRESS

public static final SnapshotState IN_PROGRESS

Snapshot process has started

SUCCESS

public static final SnapshotState SUCCESS

Snapshot process completed successfully

FAILED

public static final SnapshotState FAILED

Snapshot failed

PARTIAL

public static final SnapshotState PARTIAL

Snapshot was partial successful

Method Detail

values

public static SnapshotState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SnapshotState c : SnapshotState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SnapshotState valueOf(String name)

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:

IllegalArgumentException - if this enum type has no constant with the specified name

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

public static SnapshotState fromValue(byte value)

Generate snapshot state from code

Parameters:

value - the state code

Returns:

state