Package co.elastic.clients.elasticsearch.snapshot

Enum Class SnapshotState

java.lang.Object

java.lang.Enum<SnapshotState>

co.elastic.clients.elasticsearch.snapshot.SnapshotState

All Implemented Interfaces:

JsonEnum, JsonpSerializable, Serializable, Comparable<SnapshotState>, Constable

@JsonpDeserializable
public enum SnapshotState
extends Enum<SnapshotState>
implements JsonEnum

See Also:

• API specification

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Failed	The snapshot failed.
Incompatible	The snapshot is incompatible with the current version of the cluster.
InProgress	The snapshot process has started.
Partial	The snapshot was partially successful.
Success	The snapshot process completed successfully.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<SnapshotState>	_DESERIALIZER

Method Summary

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

Methods inherited from interface co.elastic.clients.json.JsonEnum

aliases, serialize

Enum Constant Details

InProgress

public static final SnapshotState InProgress

The snapshot process has started.

Success

public static final SnapshotState Success

The snapshot process completed successfully.

Failed

public static final SnapshotState Failed

The snapshot failed.

Partial

public static final SnapshotState Partial

The snapshot was partially successful.

Incompatible

public static final SnapshotState Incompatible

The snapshot is incompatible with the current version of the cluster.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<SnapshotState> _DESERIALIZER

Method Details

values

public static SnapshotState[] 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 SnapshotState 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

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum