Package org.elasticsearch.client.indexlifecycle

Enum Class OperationMode

java.lang.Object

java.lang.Enum<OperationMode>

org.elasticsearch.client.indexlifecycle.OperationMode

All Implemented Interfaces:

Serializable, Comparable<OperationMode>, Constable

public enum OperationMode
extends Enum<OperationMode>

Enum representing the different modes that Index Lifecycle Service can operate in.

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
RUNNING	Normal operation where all policies are executed as normal.
STOPPED	This represents a state where no policies are executed
STOPPING	this represents a state where only sensitive actions (like ShrinkAction) will be executed until they finish, at which point the operation mode will move to STOPPED.

Method Summary

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

STOPPED

public static final OperationMode STOPPED

This represents a state where no policies are executed

STOPPING

public static final OperationMode STOPPING

this represents a state where only sensitive actions (like ShrinkAction) will be executed until they finish, at which point the operation mode will move to STOPPED.

RUNNING

public static final OperationMode RUNNING

Normal operation where all policies are executed as normal.

Method Details

values

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

isValidChange

public abstract boolean isValidChange(OperationMode nextMode)