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

Enum ContainerState

java.lang.Object

java.lang.Enum<ContainerState>

org.apache.hadoop.yarn.api.records.ContainerState

All Implemented Interfaces:

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

@Public
@Stable
public enum ContainerState
extends java.lang.Enum<ContainerState>

State of a Container.

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPLETE	Completed container
NEW	New container
RUNNING	Running container

Method Summary

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

New container

RUNNING

public static final ContainerState RUNNING

Running container

COMPLETE

public static final ContainerState COMPLETE

Completed container

Method Detail

values

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

Returns:

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

valueOf

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