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

Class ContainerUpdateRequest

java.lang.Object

org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest

@Public
@Unstable
public abstract class ContainerUpdateRequest
extends Object

The request sent by Application Master to the Node Manager to change the resource quota of a container.

See Also:

• ContainerManagementProtocol.updateContainer(ContainerUpdateRequest)

Constructor Summary

Constructors

Constructor	Description
ContainerUpdateRequest()

Method Summary

Modifier and Type	Method	Description
abstract List<Token>	getContainersToUpdate()	Get a list of container tokens to be used for authorization during container resource update.
static ContainerUpdateRequest	newInstance(List<Token> containersToIncrease)
abstract void	setContainersToUpdate(List<Token> containersToUpdate)	Set container tokens to be used during container resource increase.

Methods inherited from class java.lang.Object

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

Constructor Details

ContainerUpdateRequest

public ContainerUpdateRequest()

Method Details

newInstance

@Public
@Unstable
public static ContainerUpdateRequest newInstance(List<Token> containersToIncrease)

getContainersToUpdate

@Public
@Unstable
public abstract List<Token> getContainersToUpdate()

Get a list of container tokens to be used for authorization during container resource update.

Note: NMToken will be used for authenticating communication with NodeManager.

Returns:

the list of container tokens to be used for authorization during container resource update.

See Also:

• NMToken

setContainersToUpdate

@Public
@Unstable
public abstract void setContainersToUpdate(List<Token> containersToUpdate)

Set container tokens to be used during container resource increase. The token is acquired from AllocateResponse.getUpdatedContainers. The token contains the container id and resource capability required for container resource update.

Parameters:

containersToUpdate - the list of container tokens to be used for container resource increase.