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 |
AM_RESYNC
Deprecated. Sent by Resource Manager when it is out of sync with the AM and
wants the AM get back in sync.
Note: Instead of sending this command,
ApplicationMasterNotRegisteredException will be thrown
when ApplicationMaster is out of sync with ResourceManager and
ApplicationMaster is expected to re-register with RM by calling
ApplicationMasterProtocol.registerApplicationMaster(RegisterApplicationMasterRequest) |
AM_SHUTDOWN
Deprecated. Sent by Resource Manager when it wants the AM to shutdown.
Note: This command was earlier sent by ResourceManager to
instruct AM to shutdown if RM had restarted. Now
ApplicationAttemptNotFoundException will be thrown in case
that RM has restarted and AM is supposed to handle this
exception by shutting down itself. |
Method Summary |
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. |
AM_RESYNC
public static final AMCommand AM_RESYNC
- Deprecated. Sent by Resource Manager when it is out of sync with the AM and
wants the AM get back in sync.
Note: Instead of sending this command,
ApplicationMasterNotRegisteredException
will be thrown
when ApplicationMaster is out of sync with ResourceManager and
ApplicationMaster is expected to re-register with RM by calling
ApplicationMasterProtocol.registerApplicationMaster(RegisterApplicationMasterRequest)
AM_SHUTDOWN
public static final AMCommand AM_SHUTDOWN
- Deprecated. Sent by Resource Manager when it wants the AM to shutdown.
Note: This command was earlier sent by ResourceManager to
instruct AM to shutdown if RM had restarted. Now
ApplicationAttemptNotFoundException
will be thrown in case
that RM has restarted and AM is supposed to handle this
exception by shutting down itself.
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
Copyright © 2014 Apache Software Foundation. All Rights Reserved.