org.apache.hadoop.yarn.api.records

Enum AMCommand

java.lang.Object

java.lang.Enum<AMCommand>

org.apache.hadoop.yarn.api.records.AMCommand

All Implemented Interfaces:

Serializable, Comparable<AMCommand>

@InterfaceAudience.Public
@InterfaceStability.Unstable
public enum AMCommand
extends Enum<AMCommand>

Command sent by the Resource Manager to the Application Master in the AllocateResponse

See Also:

AllocateResponse

Enum Constant Summary

Enum Constants

Enum Constant and Description
AM_RESYNC Sent by Resource Manager when it is out of sync with the AM and wants the AM get back in sync.
AM_SHUTDOWN Sent by Resource Manager when it wants the AM to shutdown.

Method Summary

Methods

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

AM_RESYNC

public static final AMCommand AM_RESYNC

Sent by Resource Manager when it is out of sync with the AM and wants the AM get back in sync.

AM_SHUTDOWN

public static final AMCommand AM_SHUTDOWN

Sent by Resource Manager when it wants the AM to shutdown. Eg. when the node is going down for maintenance. The AM should save any state and prepare to be restarted at a later time.

Method Detail

values

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

Returns:

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

valueOf

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