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

Class AllocateResponse.AllocateResponseBuilder

java.lang.Object

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

Enclosing class:

AllocateResponse

@Private
@Unstable
public static final class AllocateResponse.AllocateResponseBuilder
extends Object

Class to construct instances of AllocateResponse with specific options.

Method Summary

Modifier and Type	Method	Description
AllocateResponse.AllocateResponseBuilder	allocatedContainers(List<Container> allocatedContainers)	Set the allocatedContainers of the response.
AllocateResponse.AllocateResponseBuilder	amCommand(AMCommand amCommand)	Set the amCommand of the response.
AllocateResponse.AllocateResponseBuilder	amRmToken(Token amRmToken)	Set the amRmToken of the response.
AllocateResponse.AllocateResponseBuilder	applicationPriority(Priority applicationPriority)	Set the applicationPriority of the response.
AllocateResponse.AllocateResponseBuilder	availableResources(Resource availableResources)	Set the availableResources of the response.
AllocateResponse	build()	Return generated AllocateResponse object.
AllocateResponse.AllocateResponseBuilder	collectorInfo(CollectorInfo collectorInfo)	Set the collectorInfo of the response.
AllocateResponse.AllocateResponseBuilder	completedContainersStatuses(List<ContainerStatus> completedContainersStatuses)	Set the completedContainersStatuses of the response.
AllocateResponse.AllocateResponseBuilder	containersFromPreviousAttempt(List<Container> containersFromPreviousAttempt)	Set the containersFromPreviousAttempt of the response.
EnhancedHeadroom	getEnhancedHeadroom()
AllocateResponse.AllocateResponseBuilder	nmTokens(List<NMToken> nmTokens)	Set the nmTokens of the response.
AllocateResponse.AllocateResponseBuilder	numClusterNodes(int numClusterNodes)	Set the numClusterNodes of the response.
AllocateResponse.AllocateResponseBuilder	preemptionMessage(PreemptionMessage preemptionMessage)	Set the preemptionMessage of the response.
AllocateResponse.AllocateResponseBuilder	responseId(int responseId)	Set the responseId of the response.
void	setEnhancedHeadroom(EnhancedHeadroom enhancedHeadroom)
AllocateResponse.AllocateResponseBuilder	updatedContainers(List<UpdatedContainer> updatedContainers)	Set the updatedContainers of the response.
AllocateResponse.AllocateResponseBuilder	updatedNodes(List<NodeReport> updatedNodes)	Set the updatedNodes of the response.
AllocateResponse.AllocateResponseBuilder	updateErrors(List<UpdateContainerError> updateErrors)	Set the updateErrors of the response.

Methods inherited from class java.lang.Object

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

Method Details

amCommand

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder amCommand(AMCommand amCommand)

Set the amCommand of the response.

Parameters:

amCommand - amCommand of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setAMCommand(AMCommand)

responseId

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder responseId(int responseId)

Set the responseId of the response.

Parameters:

responseId - responseId of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setResponseId(int)

allocatedContainers

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder allocatedContainers(List<Container> allocatedContainers)

Set the allocatedContainers of the response.

Parameters:

allocatedContainers - allocatedContainers of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setAllocatedContainers(List)

availableResources

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder availableResources(Resource availableResources)

Set the availableResources of the response.

Parameters:

availableResources - availableResources of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setAvailableResources(Resource)

completedContainersStatuses

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder completedContainersStatuses(List<ContainerStatus> completedContainersStatuses)

Set the completedContainersStatuses of the response.

Parameters:

completedContainersStatuses - completedContainersStatuses of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setCompletedContainersStatuses(List)

updatedNodes

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder updatedNodes(List<NodeReport> updatedNodes)

Set the updatedNodes of the response.

Parameters:

updatedNodes - updatedNodes of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setUpdatedNodes(List)

numClusterNodes

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder numClusterNodes(int numClusterNodes)

Set the numClusterNodes of the response.

Parameters:

numClusterNodes - numClusterNodes of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setNumClusterNodes(int)

preemptionMessage

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder preemptionMessage(PreemptionMessage preemptionMessage)

Set the preemptionMessage of the response.

Parameters:

preemptionMessage - preemptionMessage of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setPreemptionMessage(PreemptionMessage)

nmTokens

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder nmTokens(List<NMToken> nmTokens)

Set the nmTokens of the response.

Parameters:

nmTokens - nmTokens of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setNMTokens(List)

updatedContainers

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder updatedContainers(List<UpdatedContainer> updatedContainers)

Set the updatedContainers of the response.

Parameters:

updatedContainers - updatedContainers of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setUpdatedContainers(List)

amRmToken

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder amRmToken(Token amRmToken)

Set the amRmToken of the response.

Parameters:

amRmToken - amRmToken of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setAMRMToken(Token)

applicationPriority

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder applicationPriority(Priority applicationPriority)

Set the applicationPriority of the response.

Parameters:

applicationPriority - applicationPriority of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setApplicationPriority(Priority)

collectorInfo

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder collectorInfo(CollectorInfo collectorInfo)

Set the collectorInfo of the response.

Parameters:

collectorInfo - collectorInfo of the response which contains collector address, RM id, version and collector token.

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setCollectorInfo(CollectorInfo)

updateErrors

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder updateErrors(List<UpdateContainerError> updateErrors)

Set the updateErrors of the response.

Parameters:

updateErrors - updateErrors of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setUpdateErrors(List)

containersFromPreviousAttempt

@Private
@Unstable
public AllocateResponse.AllocateResponseBuilder containersFromPreviousAttempt(List<Container> containersFromPreviousAttempt)

Set the containersFromPreviousAttempt of the response.

Parameters:

containersFromPreviousAttempt - containersFromPreviousAttempt of the response

Returns:

AllocateResponse.AllocateResponseBuilder

See Also:

• AllocateResponse.setContainersFromPreviousAttempts(List)

getEnhancedHeadroom

@Public
@Unstable
public EnhancedHeadroom getEnhancedHeadroom()

setEnhancedHeadroom

@Private
@Unstable
public void setEnhancedHeadroom(EnhancedHeadroom enhancedHeadroom)

build

@Private
@Unstable
public AllocateResponse build()

Return generated AllocateResponse object.

Returns:

AllocateResponse