org.apache.hadoop.yarn.api.protocolrecords

Class RegisterApplicationMasterResponse

java.lang.Object

org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract class RegisterApplicationMasterResponse
extends Object

The response sent by the ResourceManager to a new ApplicationMaster on registration.

The response contains critical details such as:

• Maximum capability for allocated resources in the cluster.
• ApplicationACLs for the application.
• ClientToAMToken master key.

See Also:

ApplicationMasterProtocol.registerApplicationMaster(RegisterApplicationMasterRequest)

Constructor Summary

Constructors

Constructor and Description
RegisterApplicationMasterResponse()

Method Summary

Modifier and Type	Method and Description
abstract Map<ApplicationAccessType,String>	getApplicationACLs() Get the ApplicationACLs for the application.
abstract ByteBuffer	getClientToAMTokenMasterKey() Get ClientToAMToken master key.
abstract List<Container>	getContainersFromPreviousAttempts() Get the list of running containers as viewed by ResourceManager from previous application attempts.
abstract Resource	getMaximumResourceCapability() Get the maximum capability for any Resource allocated by the ResourceManager in the cluster.
abstract List<NMToken>	getNMTokensFromPreviousAttempts() Get the list of NMTokens for communicating with the NMs where the containers of previous application attempts are running.
abstract String	getQueue() Get the queue that the application was placed in.
abstract Map<String,Resource>	getResourceProfiles() Get list of supported resource profiles from RM.
abstract List<org.apache.hadoop.yarn.api.records.ResourceTypeInfo>	getResourceTypes() Get available resource types supported by RM.
abstract EnumSet<org.apache.hadoop.yarn.proto.YarnServiceProtos.SchedulerResourceTypes>	getSchedulerResourceTypes() Get a set of the resource types considered by the scheduler.
abstract void	setClientToAMTokenMasterKey(ByteBuffer key) Set ClientToAMToken master key.
abstract void	setQueue(String queue) Set the queue that the application was placed in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegisterApplicationMasterResponse

public RegisterApplicationMasterResponse()

Method Detail

getMaximumResourceCapability

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract Resource getMaximumResourceCapability()

Get the maximum capability for any Resource allocated by the ResourceManager in the cluster.

Returns:

maximum capability of allocated resources in the cluster

getApplicationACLs

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract Map<ApplicationAccessType,String> getApplicationACLs()

Get the ApplicationACLs for the application.

Returns:

all the ApplicationACLs

getClientToAMTokenMasterKey

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract ByteBuffer getClientToAMTokenMasterKey()

Get ClientToAMToken master key.

The ClientToAMToken master key is sent to ApplicationMaster by ResourceManager via RegisterApplicationMasterResponse , used to verify corresponding ClientToAMToken.

Returns:

ClientToAMToken master key

setClientToAMTokenMasterKey

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract void setClientToAMTokenMasterKey(ByteBuffer key)

Set ClientToAMToken master key.

Parameters:

key - ClientToAMToken master key.

getQueue

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract String getQueue()

Get the queue that the application was placed in.

Returns:

the queue that the application was placed in.

setQueue

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract void setQueue(String queue)

Set the queue that the application was placed in.

Parameters:

queue - queue.

getContainersFromPreviousAttempts

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract List<Container> getContainersFromPreviousAttempts()

Get the list of running containers as viewed by ResourceManager from previous application attempts.

Returns:

the list of running containers as viewed by ResourceManager from previous application attempts

See Also:

getNMTokensFromPreviousAttempts()

getNMTokensFromPreviousAttempts

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract List<NMToken> getNMTokensFromPreviousAttempts()

Get the list of NMTokens for communicating with the NMs where the containers of previous application attempts are running.

Returns:

the list of NMTokens for communicating with the NMs where the containers of previous application attempts are running.

See Also:

getContainersFromPreviousAttempts()

getSchedulerResourceTypes

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract EnumSet<org.apache.hadoop.yarn.proto.YarnServiceProtos.SchedulerResourceTypes> getSchedulerResourceTypes()

Get a set of the resource types considered by the scheduler.

Returns:

a Map of RM settings

getResourceProfiles

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract Map<String,Resource> getResourceProfiles()

Get list of supported resource profiles from RM.

Returns:

a map of resource profiles and its capabilities.

getResourceTypes

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract List<org.apache.hadoop.yarn.api.records.ResourceTypeInfo> getResourceTypes()

Get available resource types supported by RM.

Returns:

a Map of RM settings