org.apache.hadoop.yarn.api.protocolrecords.impl.pb

Class AllocateResponsePBImpl

java.lang.Object

org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse

org.apache.hadoop.yarn.api.protocolrecords.impl.pb.AllocateResponsePBImpl

@InterfaceAudience.Private
@InterfaceStability.Unstable
public class AllocateResponsePBImpl
extends AllocateResponse

Constructor Summary

Constructors

Constructor and Description
AllocateResponsePBImpl()
AllocateResponsePBImpl(YarnServiceProtos.AllocateResponseProto proto)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
List<Container>	getAllocatedContainers() Get the list of newly allocated Container by the ResourceManager.
AMCommand	getAMCommand() If the ResourceManager needs the ApplicationMaster to take some action then it will send an AMCommand to the ApplicationMaster.
Resource	getAvailableResources() Get the available headroom for resources in the cluster for the application.
List<ContainerStatus>	getCompletedContainersStatuses() Get the list of completed containers' statuses.
List<NMToken>	getNMTokens() Get the list of NMTokens required for communicating with NM.
int	getNumClusterNodes() Get the number of hosts available on the cluster.
PreemptionMessage	getPreemptionMessage() Get the description of containers owned by the AM, but requested back by the cluster.
YarnServiceProtos.AllocateResponseProto	getProto()
int	getResponseId() Get the last response id.
List<NodeReport>	getUpdatedNodes() Get the list of updated NodeReports.
int	hashCode()
void	setAllocatedContainers(List<Container> containers) Set the list of newly allocated Container by the ResourceManager.
void	setAMCommand(AMCommand command)
void	setAvailableResources(Resource limit)
void	setCompletedContainersStatuses(List<ContainerStatus> containers)
void	setNMTokens(List<NMToken> nmTokens)
void	setNumClusterNodes(int numNodes)
void	setPreemptionMessage(PreemptionMessage preempt)
void	setResponseId(int responseId)
void	setUpdatedNodes(List<NodeReport> updatedNodes)
String	toString()

Methods inherited from class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse

newInstance

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AllocateResponsePBImpl

public AllocateResponsePBImpl()

AllocateResponsePBImpl

public AllocateResponsePBImpl(YarnServiceProtos.AllocateResponseProto proto)

Method Detail

getProto

public YarnServiceProtos.AllocateResponseProto getProto()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getAMCommand

public AMCommand getAMCommand()

Description copied from class: AllocateResponse

If the ResourceManager needs the ApplicationMaster to take some action then it will send an AMCommand to the ApplicationMaster. See AMCommand for details on commands and actions for them.

Specified by:

getAMCommand in class AllocateResponse

Returns:

AMCommand if the ApplicationMaster should take action, null otherwise

See Also:

AMCommand

setAMCommand

public void setAMCommand(AMCommand command)

Specified by:

setAMCommand in class AllocateResponse

getResponseId

public int getResponseId()

Description copied from class: AllocateResponse

Get the last response id.

Specified by:

getResponseId in class AllocateResponse

Returns:

last response id

setResponseId

public void setResponseId(int responseId)

Specified by:

setResponseId in class AllocateResponse

getAvailableResources

public Resource getAvailableResources()

Description copied from class: AllocateResponse

Get the available headroom for resources in the cluster for the application.

Specified by:

getAvailableResources in class AllocateResponse

Returns:

limit of available headroom for resources in the cluster for the application

setAvailableResources

public void setAvailableResources(Resource limit)

Specified by:

setAvailableResources in class AllocateResponse

getUpdatedNodes

public List<NodeReport> getUpdatedNodes()

Description copied from class: AllocateResponse

Get the list of updated NodeReports. Updates could be changes in health, availability etc of the nodes.

Specified by:

getUpdatedNodes in class AllocateResponse

Returns:

The delta of updated nodes since the last response

setUpdatedNodes

public void setUpdatedNodes(List<NodeReport> updatedNodes)

Specified by:

setUpdatedNodes in class AllocateResponse

getAllocatedContainers

public List<Container> getAllocatedContainers()

Description copied from class: AllocateResponse

Get the list of newly allocated Container by the ResourceManager.

Specified by:

getAllocatedContainers in class AllocateResponse

Returns:

list of newly allocated Container

setAllocatedContainers

public void setAllocatedContainers(List<Container> containers)

Description copied from class: AllocateResponse

Set the list of newly allocated Container by the ResourceManager.

Specified by:

setAllocatedContainers in class AllocateResponse

Parameters:

containers - list of newly allocated Container

getCompletedContainersStatuses

public List<ContainerStatus> getCompletedContainersStatuses()

Description copied from class: AllocateResponse

Get the list of completed containers' statuses.

Specified by:

getCompletedContainersStatuses in class AllocateResponse

Returns:

the list of completed containers' statuses

setCompletedContainersStatuses

public void setCompletedContainersStatuses(List<ContainerStatus> containers)

Specified by:

setCompletedContainersStatuses in class AllocateResponse

setNMTokens

public void setNMTokens(List<NMToken> nmTokens)

Specified by:

setNMTokens in class AllocateResponse

getNMTokens

public List<NMToken> getNMTokens()

Description copied from class: AllocateResponse

Get the list of NMTokens required for communicating with NM. New NMTokens issued only if

1) AM is receiving first container on underlying NodeManager.
OR
2) NMToken master key rolled over in ResourceManager and AM is getting new container on the same underlying NodeManager.

AM will receive one NMToken per NM irrespective of the number of containers issued on same NM. AM is expected to store these tokens until issued a new token for the same NM.

Specified by:

getNMTokens in class AllocateResponse

getNumClusterNodes

public int getNumClusterNodes()

Description copied from class: AllocateResponse

Get the number of hosts available on the cluster.

Specified by:

getNumClusterNodes in class AllocateResponse

Returns:

the available host count.

setNumClusterNodes

public void setNumClusterNodes(int numNodes)

Specified by:

setNumClusterNodes in class AllocateResponse

getPreemptionMessage

public PreemptionMessage getPreemptionMessage()

Description copied from class: AllocateResponse

Get the description of containers owned by the AM, but requested back by the cluster. Note that the RM may have an inconsistent view of the resources owned by the AM. These messages are advisory, and the AM may elect to ignore them.

The message is a snapshot of the resources the RM wants back from the AM. While demand persists, the RM will repeat its request; applications should not interpret each message as a request for additional resources on top of previous messages. Resources requested consistently over some duration may be forcibly killed by the RM.

Specified by:

getPreemptionMessage in class AllocateResponse

Returns:

A specification of the resources to reclaim from this AM.

setPreemptionMessage

public void setPreemptionMessage(PreemptionMessage preempt)

Specified by:

setPreemptionMessage in class AllocateResponse