Package co.elastic.clients.elasticsearch.cat

Enum Class CatSnapshotsColumn

java.lang.Object

java.lang.Enum<CatSnapshotsColumn>

co.elastic.clients.elasticsearch.cat.CatSnapshotsColumn

All Implemented Interfaces:

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

@JsonpDeserializable
public enum CatSnapshotsColumn
extends Enum<CatSnapshotsColumn>
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
Duration	The time it took the snapshot process to complete in time units.
EndEpoch	The unix epoch time at which the snapshot process ended.
EndTime	'HH:MM:SS' time at which the snapshot process ended.
FailedShards	The number of failed shards in the snapshot.
Id	The ID of the snapshot, such as 'snap1'.
Indices	The number of indices in the snapshot.
Reason	The reason for any snapshot failures.
Repository	The name of the repository, such as 'repo1'.
StartEpoch	The unix epoch time at which the snapshot process started.
StartTime	'HH:MM:SS' time at which the snapshot process started.
Status	State of the snapshot process.
SuccessfulShards	The number of successful shards in the snapshot.
TotalShards	The total number of shards in the snapshot.

Field Summary

Fields

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

Method Summary

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

serialize

Enum Constant Details

Id

public static final CatSnapshotsColumn Id

The ID of the snapshot, such as 'snap1'.

Repository

public static final CatSnapshotsColumn Repository

The name of the repository, such as 'repo1'.

Status

public static final CatSnapshotsColumn Status

State of the snapshot process. Returned values are: 'FAILED': The snapshot process failed. 'INCOMPATIBLE': The snapshot process is incompatible with the current cluster version. 'IN_PROGRESS': The snapshot process started but has not completed. 'PARTIAL': The snapshot process completed with a partial success. 'SUCCESS': The snapshot process completed with a full success.

StartEpoch

public static final CatSnapshotsColumn StartEpoch

The unix epoch time at which the snapshot process started.

StartTime

public static final CatSnapshotsColumn StartTime

'HH:MM:SS' time at which the snapshot process started.

EndEpoch

public static final CatSnapshotsColumn EndEpoch

The unix epoch time at which the snapshot process ended.

EndTime

public static final CatSnapshotsColumn EndTime

'HH:MM:SS' time at which the snapshot process ended.

Duration

public static final CatSnapshotsColumn Duration

The time it took the snapshot process to complete in time units.

Indices

public static final CatSnapshotsColumn Indices

The number of indices in the snapshot.

SuccessfulShards

public static final CatSnapshotsColumn SuccessfulShards

The number of successful shards in the snapshot.

FailedShards

public static final CatSnapshotsColumn FailedShards

The number of failed shards in the snapshot.

TotalShards

public static final CatSnapshotsColumn TotalShards

The total number of shards in the snapshot.

Reason

public static final CatSnapshotsColumn Reason

The reason for any snapshot failures.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<CatSnapshotsColumn> _DESERIALIZER

Method Details

values

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

aliases

public String[] aliases()

Specified by:

aliases in interface JsonEnum