org.springframework.yarn.am.cluster

Enum ClusterState

java.lang.Object

java.lang.Enum<ClusterState>

org.springframework.yarn.am.cluster.ClusterState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ClusterState>

public enum ClusterState
extends java.lang.Enum<ClusterState>

Possible states of this machine.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOCATING State where cluster is allocating and configuring itself.
DESTROYED State for cluster when it has been destroyed and no further state changes are allowed except transition to final state.
DESTROYING State when cluster is entering into a mode to be destroyed.
FINAL Final state for cluster.
INITIAL Initial state when cluster has been created.
RUNNING State where cluster is ready to go allocation mode or to be stopped or destroyed.
STOPPED State where cluster is stopped.
STOPPING State where cluster has been requested to be stopped.

Method Summary

Methods

Modifier and Type	Method and Description
static ClusterState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ClusterState[]	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 Detail

INITIAL

public static final ClusterState INITIAL

Initial state when cluster has been created. Once we enter away from this state, we never get back from any other state.

RUNNING

public static final ClusterState RUNNING

State where cluster is ready to go allocation mode or to be stopped or destroyed.

ALLOCATING

public static final ClusterState ALLOCATING

State where cluster is allocating and configuring itself.

STOPPING

public static final ClusterState STOPPING

State where cluster has been requested to be stopped.

STOPPED

public static final ClusterState STOPPED

State where cluster is stopped. Cluster can either be started or destroyed.

DESTROYING

public static final ClusterState DESTROYING

State when cluster is entering into a mode to be destroyed. This is similar when cluster is stopped but instead ending into a stopped state, we end into a destroyed state.

DESTROYED

public static final ClusterState DESTROYED

State for cluster when it has been destroyed and no further state changes are allowed except transition to final state.

FINAL

public static final ClusterState FINAL

Final state for cluster. Cluster object can be safely removed and possibly recreated.

Method Detail

values

public static ClusterState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClusterState c : ClusterState.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClusterState valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null