Package org.apache.hadoop.yarn.api.protocolrecords

Class RegisterApplicationMasterResponse

java.lang.Object

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

@Public
@Stable
public abstract class RegisterApplicationMasterResponse
extends java.lang.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	Description
RegisterApplicationMasterResponse()

Method Summary

Modifier and Type	Method	Description
abstract java.util.Map<ApplicationAccessType,java.lang.String>	getApplicationACLs()	Get the ApplicationACLs for the application.
abstract java.nio.ByteBuffer	getClientToAMTokenMasterKey()	Get ClientToAMToken master key.
abstract java.util.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 java.util.List<NMToken>	getNMTokensFromPreviousAttempts()	Get the list of NMTokens for communicating with the NMs where the containers of previous application attempts are running.
abstract java.lang.String	getQueue()	Get the queue that the application was placed in.
abstract java.util.Map<java.lang.String,Resource>	getResourceProfiles()	Get list of supported resource profiles from RM.
abstract java.util.List<ResourceTypeInfo>	getResourceTypes()	Get available resource types supported by RM.
abstract java.util.EnumSet<org.apache.hadoop.yarn.proto.YarnServiceProtos.SchedulerResourceTypes>	getSchedulerResourceTypes()	Get a set of the resource types considered by the scheduler.
static RegisterApplicationMasterResponse	newInstance(Resource minCapability, Resource maxCapability, java.util.Map<ApplicationAccessType,java.lang.String> acls, java.nio.ByteBuffer key, java.util.List<Container> containersFromPreviousAttempt, java.lang.String queue, java.util.List<NMToken> nmTokensFromPreviousAttempts)
abstract void	setApplicationACLs(java.util.Map<ApplicationAccessType,java.lang.String> acls)	Set the ApplicationACLs for the application.
abstract void	setClientToAMTokenMasterKey(java.nio.ByteBuffer key)	Set ClientToAMToken master key.
abstract void	setContainersFromPreviousAttempts(java.util.List<Container> containersFromPreviousAttempt)	Set the list of running containers as viewed by ResourceManager from previous application attempts.
abstract void	setMaximumResourceCapability(Resource capability)
abstract void	setNMTokensFromPreviousAttempts(java.util.List<NMToken> nmTokens)	Set the list of NMTokens for communicating with the NMs where the the containers of previous application attempts are running.
abstract void	setQueue(java.lang.String queue)	Set the queue that the application was placed in.
abstract void	setResourceProfiles(java.util.Map<java.lang.String,Resource> profiles)	Set supported resource profiles for RM.
abstract void	setResourceTypes(java.util.List<ResourceTypeInfo> types)	Set the resource types used by RM.
abstract void	setSchedulerResourceTypes(java.util.EnumSet<org.apache.hadoop.yarn.proto.YarnServiceProtos.SchedulerResourceTypes> types)	Set the resource types used by the scheduler.

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

newInstance

@Private
@Unstable
public static RegisterApplicationMasterResponse newInstance(Resource minCapability,
                                                            Resource maxCapability,
                                                            java.util.Map<ApplicationAccessType,java.lang.String> acls,
                                                            java.nio.ByteBuffer key,
                                                            java.util.List<Container> containersFromPreviousAttempt,
                                                            java.lang.String queue,
                                                            java.util.List<NMToken> nmTokensFromPreviousAttempts)

getMaximumResourceCapability

@Public
@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

setMaximumResourceCapability

@Private
@Unstable
public abstract void setMaximumResourceCapability(Resource capability)

getApplicationACLs

@Public
@Stable
public abstract java.util.Map<ApplicationAccessType,java.lang.String> getApplicationACLs()

Get the ApplicationACLs for the application.

Returns:

all the ApplicationACLs

setApplicationACLs

@Private
@Unstable
public abstract void setApplicationACLs(java.util.Map<ApplicationAccessType,java.lang.String> acls)

Set the ApplicationACLs for the application.

Parameters:

acls - ApplicationACLs for the application.

getClientToAMTokenMasterKey

@Public
@Stable
public abstract java.nio.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

@Public
@Stable
public abstract void setClientToAMTokenMasterKey(java.nio.ByteBuffer key)

Set ClientToAMToken master key.

Parameters:

key - ClientToAMToken master key.

getQueue

@Public
@Stable
public abstract java.lang.String getQueue()

Get the queue that the application was placed in.

Returns:

the queue that the application was placed in.

setQueue

@Public
@Stable
public abstract void setQueue(java.lang.String queue)

Set the queue that the application was placed in.

Parameters:

queue - queue.

getContainersFromPreviousAttempts

@Public
@Unstable
public abstract java.util.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()

setContainersFromPreviousAttempts

@Private
@Unstable
public abstract void setContainersFromPreviousAttempts(java.util.List<Container> containersFromPreviousAttempt)

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

Parameters:

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

getNMTokensFromPreviousAttempts

@Public
@Stable
public abstract java.util.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()

setNMTokensFromPreviousAttempts

@Private
@Unstable
public abstract void setNMTokensFromPreviousAttempts(java.util.List<NMToken> nmTokens)

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

Parameters:

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

getSchedulerResourceTypes

@Public
@Unstable
public abstract java.util.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

setSchedulerResourceTypes

@Private
@Unstable
public abstract void setSchedulerResourceTypes(java.util.EnumSet<org.apache.hadoop.yarn.proto.YarnServiceProtos.SchedulerResourceTypes> types)

Set the resource types used by the scheduler.

Parameters:

types - a set of the resource types that the scheduler considers during scheduling

getResourceProfiles

@Public
@Unstable
public abstract java.util.Map<java.lang.String,Resource> getResourceProfiles()

Get list of supported resource profiles from RM.

Returns:

a map of resource profiles and its capabilities.

setResourceProfiles

@Private
@Unstable
public abstract void setResourceProfiles(java.util.Map<java.lang.String,Resource> profiles)

Set supported resource profiles for RM.

Parameters:

profiles - a map of resource profiles with its capabilities.

getResourceTypes

@Public
@Unstable
public abstract java.util.List<ResourceTypeInfo> getResourceTypes()

Get available resource types supported by RM.

Returns:

a Map of RM settings

setResourceTypes

@Private
@Unstable
public abstract void setResourceTypes(java.util.List<ResourceTypeInfo> types)

Set the resource types used by RM.

Parameters:

types - a set of the resource types supported by RM.