Module org.elasticsearch.server

Package org.elasticsearch.cluster

Enum Class SnapshotsInProgress.ShardState

java.lang.Object

java.lang.Enum<SnapshotsInProgress.ShardState>

org.elasticsearch.cluster.SnapshotsInProgress.ShardState

All Implemented Interfaces:

Serializable, Comparable<SnapshotsInProgress.ShardState>, Constable

Enclosing class:

SnapshotsInProgress

public static enum SnapshotsInProgress.ShardState
extends Enum<SnapshotsInProgress.ShardState>

The current stage/phase of the shard snapshot, and whether it has completed or failed.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABORTED
FAILED
INIT
MISSING	Shard primary is unassigned and shard cannot be snapshotted.
PAUSED_FOR_NODE_REMOVAL	Primary shard is assigned to a node which is marked for removal from the cluster (or which was previously marked for removal and we're still waiting for its other shards to pause).
QUEUED	Shard snapshot is waiting for another shard snapshot for the same shard and to the same repository to finish.
SUCCESS
WAITING	Shard snapshot is waiting for the primary to snapshot to become available.

Method Summary

Modifier and Type	Method	Description
boolean	completed()
boolean	failed()
static SnapshotsInProgress.ShardState	fromValue(byte value)
static SnapshotsInProgress.ShardState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SnapshotsInProgress.ShardState[]	values()	Returns an array containing the constants of this enum class, 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

public static final SnapshotsInProgress.ShardState INIT

SUCCESS

public static final SnapshotsInProgress.ShardState SUCCESS

FAILED

public static final SnapshotsInProgress.ShardState FAILED

ABORTED

public static final SnapshotsInProgress.ShardState ABORTED

MISSING

public static final SnapshotsInProgress.ShardState MISSING

Shard primary is unassigned and shard cannot be snapshotted.

WAITING

public static final SnapshotsInProgress.ShardState WAITING

Shard snapshot is waiting for the primary to snapshot to become available.

QUEUED

public static final SnapshotsInProgress.ShardState QUEUED

Shard snapshot is waiting for another shard snapshot for the same shard and to the same repository to finish.

PAUSED_FOR_NODE_REMOVAL

public static final SnapshotsInProgress.ShardState PAUSED_FOR_NODE_REMOVAL

Primary shard is assigned to a node which is marked for removal from the cluster (or which was previously marked for removal and we're still waiting for its other shards to pause).

Method Details

values

public static SnapshotsInProgress.ShardState[] 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 SnapshotsInProgress.ShardState valueOf(String 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:

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

NullPointerException - if the argument is null

completed

public boolean completed()

failed

public boolean failed()

fromValue

public static SnapshotsInProgress.ShardState fromValue(byte value)