Package org.opensearch.index

Enum IndexModule.TieringState

java.lang.Object

java.lang.Enum<IndexModule.TieringState>

org.opensearch.index.IndexModule.TieringState

All Implemented Interfaces:

Serializable, Comparable<IndexModule.TieringState>

Enclosing class:

IndexModule

@ExperimentalApi
public static enum IndexModule.TieringState
extends Enum<IndexModule.TieringState>

Represents the tiering state of the index.

Enum Constant Summary

Enum Constants

Enum Constant	Description
HOT
HOT_TO_WARM
WARM
WARM_TO_HOT

Method Summary

Modifier and Type	Method	Description
static IndexModule.TieringState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IndexModule.TieringState[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HOT

public static final IndexModule.TieringState HOT

HOT_TO_WARM

public static final IndexModule.TieringState HOT_TO_WARM

WARM

public static final IndexModule.TieringState WARM

WARM_TO_HOT

public static final IndexModule.TieringState WARM_TO_HOT

Method Details

values

public static IndexModule.TieringState[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IndexModule.TieringState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null