Module org.elasticsearch.server

Package org.elasticsearch.index.snapshots

Enum Class IndexShardSnapshotStatus.AbortStatus

java.lang.Object

java.lang.Enum<IndexShardSnapshotStatus.AbortStatus>

org.elasticsearch.index.snapshots.IndexShardSnapshotStatus.AbortStatus

All Implemented Interfaces:

Serializable, Comparable<IndexShardSnapshotStatus.AbortStatus>, Constable

Enclosing class:

IndexShardSnapshotStatus

public static enum IndexShardSnapshotStatus.AbortStatus
extends Enum<IndexShardSnapshotStatus.AbortStatus>

Used to complete listeners added via IndexShardSnapshotStatus.addAbortListener(org.elasticsearch.action.ActionListener<org.elasticsearch.index.snapshots.IndexShardSnapshotStatus.AbortStatus>) when the shard snapshot is either aborted/paused or it gets past the stages where an abort/pause could have occurred.

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	The shard snapshot stopped before completion, either because the whole snapshot was aborted or because this node is to be removed.
NO_ABORT	The shard snapshot got past the stage where an abort or pause could have occurred, and is either complete or on its way to completion.

Method Summary

Modifier and Type	Method	Description
static IndexShardSnapshotStatus.AbortStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IndexShardSnapshotStatus.AbortStatus[]	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

NO_ABORT

public static final IndexShardSnapshotStatus.AbortStatus NO_ABORT

The shard snapshot got past the stage where an abort or pause could have occurred, and is either complete or on its way to completion.

ABORTED

public static final IndexShardSnapshotStatus.AbortStatus ABORTED

The shard snapshot stopped before completion, either because the whole snapshot was aborted or because this node is to be removed.

Method Details

values

public static IndexShardSnapshotStatus.AbortStatus[] 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 IndexShardSnapshotStatus.AbortStatus 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