Package org.apache.hadoop.yarn.api.records

Class UpdateContainerRequest

java.lang.Object

org.apache.hadoop.yarn.api.records.UpdateContainerRequest

@Public
@Unstable
public abstract class UpdateContainerRequest
extends java.lang.Object

UpdateContainerRequest represents the request made by an application to the ResourceManager to update an attribute of a Container such as its Resource allocation or (@code ExecutionType}

It includes:

• version for the container.
• ContainerId for the container.
• Resource capability of the container after the update request is completed.
• ExecutionType of the container after the update request is completed.

Update rules:

• Currently only ONE aspect of the container can be updated per request (user can either update Capability OR ExecutionType in one request.. not both).
• There must be only 1 update request per container in an allocate call.
• If a new update request is sent for a container (in a subsequent allocate call) before the first one is satisfied by the Scheduler, it will overwrite the previous request.

See Also:

ApplicationMasterProtocol.allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)

Constructor Summary

Constructors

Constructor	Description
UpdateContainerRequest()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
abstract Resource	getCapability()	Get the Resource capability of the request.
abstract ContainerId	getContainerId()	Get the ContainerId of the container.
abstract ContainerUpdateType	getContainerUpdateType()	Get the ContainerUpdateType of the container.
abstract int	getContainerVersion()	Get the ContainerId of the container.
abstract ExecutionType	getExecutionType()	Get the target ExecutionType of the container.
int	hashCode()
static UpdateContainerRequest	newInstance(int version, ContainerId containerId, ContainerUpdateType updateType, Resource targetCapability, ExecutionType targetExecutionType)
abstract void	setCapability(Resource capability)	Set the Resource capability of the request.
abstract void	setContainerId(ContainerId containerId)	Set the ContainerId of the container.
abstract void	setContainerUpdateType(ContainerUpdateType updateType)	Set the ContainerUpdateType of the container.
abstract void	setContainerVersion(int containerVersion)	Set the current version of the container.
abstract void	setExecutionType(ExecutionType executionType)	Set the target ExecutionType of the container.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateContainerRequest

public UpdateContainerRequest()

Method Detail

newInstance

@Public
@Unstable
public static UpdateContainerRequest newInstance(int version,
                                                 ContainerId containerId,
                                                 ContainerUpdateType updateType,
                                                 Resource targetCapability,
                                                 ExecutionType targetExecutionType)

getContainerVersion

@Public
@Unstable
public abstract int getContainerVersion()

Get the ContainerId of the container.

Returns:

ContainerId of the container

setContainerVersion

@Public
@Unstable
public abstract void setContainerVersion(int containerVersion)

Set the current version of the container.

Parameters:

containerVersion - of the container

getContainerUpdateType

@Public
@Unstable
public abstract ContainerUpdateType getContainerUpdateType()

Get the ContainerUpdateType of the container.

Returns:

ContainerUpdateType of the container.

setContainerUpdateType

@Public
@Unstable
public abstract void setContainerUpdateType(ContainerUpdateType updateType)

Set the ContainerUpdateType of the container.

Parameters:

updateType - of the Container

getContainerId

@Public
@Unstable
public abstract ContainerId getContainerId()

Get the ContainerId of the container.

Returns:

ContainerId of the container

setContainerId

@Public
@Unstable
public abstract void setContainerId(ContainerId containerId)

Set the ContainerId of the container.

Parameters:

containerId - ContainerId of the container

getExecutionType

@Public
@Unstable
public abstract ExecutionType getExecutionType()

Get the target ExecutionType of the container.

Returns:

ExecutionType of the container

setExecutionType

@Public
@Unstable
public abstract void setExecutionType(ExecutionType executionType)

Set the target ExecutionType of the container.

Parameters:

executionType - ExecutionType of the container

setCapability

@Public
@Unstable
public abstract void setCapability(Resource capability)

Set the Resource capability of the request.

Parameters:

capability - Resource capability of the request

getCapability

@Public
@Unstable
public abstract Resource getCapability()

Get the Resource capability of the request.

Returns:

Resource capability of the request

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object