Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.snapshots.get

Enum Class SnapshotSortKey

java.lang.Object

java.lang.Enum<SnapshotSortKey>

org.elasticsearch.action.admin.cluster.snapshots.get.SnapshotSortKey

All Implemented Interfaces:

Serializable, Comparable<SnapshotSortKey>, Constable

public enum SnapshotSortKey
extends Enum<SnapshotSortKey>

Sort key for snapshots e.g. returned from the get-snapshots API. All values break ties using SnapshotInfo.snapshotId() (i.e. by name).

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
DURATION	Sort by snapshot duration (end time minus start time).
FAILED_SHARDS	Sort by number of failed shards in the snapshot.
INDICES	Sort by number of indices in the snapshot.
NAME	Sort by snapshot name.
REPOSITORY	Sort by repository name.
SHARDS	Sort by number of shards in the snapshot.
START_TIME	Sort by snapshot start time.

Method Summary

Modifier and Type	Method	Description
final Comparator<SnapshotInfo>	getSnapshotInfoComparator(SortOrder sortOrder)
static SnapshotSortKey	of(String name)
String	toString()
static SnapshotSortKey	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SnapshotSortKey[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

START_TIME

public static final SnapshotSortKey START_TIME

Sort by snapshot start time.

NAME

public static final SnapshotSortKey NAME

Sort by snapshot name.

DURATION

public static final SnapshotSortKey DURATION

Sort by snapshot duration (end time minus start time).

INDICES

public static final SnapshotSortKey INDICES

Sort by number of indices in the snapshot.

SHARDS

public static final SnapshotSortKey SHARDS

Sort by number of shards in the snapshot.

FAILED_SHARDS

public static final SnapshotSortKey FAILED_SHARDS

Sort by number of failed shards in the snapshot.

REPOSITORY

public static final SnapshotSortKey REPOSITORY

Sort by repository name.

Method Details

values

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

toString

public String toString()

Overrides:

toString in class Enum<SnapshotSortKey>

getSnapshotInfoComparator

public final Comparator<SnapshotInfo> getSnapshotInfoComparator(SortOrder sortOrder)

Returns:

a Comparator which sorts SnapshotInfo instances according to this sort key.

of

public static SnapshotSortKey of(String name)