Package org.apache.hadoop.yarn.api.records

Enum NodeState

java.lang.Object

java.lang.Enum<NodeState>

org.apache.hadoop.yarn.api.records.NodeState

All Implemented Interfaces:

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

@Public
@Unstable
public enum NodeState
extends java.lang.Enum<NodeState>

State of a Node.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DECOMMISSIONED	Node is out of service
DECOMMISSIONING	Node decommission is in progress
LOST	Node has not sent a heartbeat for some configured time threshold
NEW	New node
REBOOTED	Node has rebooted
RUNNING	Running node
SHUTDOWN	Node has shutdown gracefully.
UNHEALTHY	Node is unhealthy

Method Summary

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

NEW

public static final NodeState NEW

New node

RUNNING

public static final NodeState RUNNING

Running node

UNHEALTHY

public static final NodeState UNHEALTHY

Node is unhealthy

DECOMMISSIONED

public static final NodeState DECOMMISSIONED

Node is out of service

LOST

public static final NodeState LOST

Node has not sent a heartbeat for some configured time threshold

REBOOTED

public static final NodeState REBOOTED

Node has rebooted

DECOMMISSIONING

public static final NodeState DECOMMISSIONING

Node decommission is in progress

SHUTDOWN

public static final NodeState SHUTDOWN

Node has shutdown gracefully.

Method Detail

values

public static NodeState[] 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 (NodeState c : NodeState.values())
    System.out.println(c);

Returns:

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

valueOf

public static NodeState 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

isUnusable

public boolean isUnusable()

isInactiveState

public boolean isInactiveState()

isActiveState

public boolean isActiveState()