org.apache.hadoop.yarn.api.records

Class Container

java.lang.Object

org.apache.hadoop.yarn.api.records.Container

All Implemented Interfaces:

Comparable<Container>

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract class Container
extends Object
implements Comparable<Container>

Container represents an allocated resource in the cluster.

The ResourceManager is the sole authority to allocate any Container to applications. The allocated Container is always on a single node and has a unique ContainerId. It has a specific amount of Resource allocated.

It includes details such as:

• ContainerId for the container, which is globally unique.
• NodeId of the node on which it is allocated.
• HTTP uri of the node.
• Resource allocated to the container.
• Priority at which the container was allocated.
• Container Token of the container, used to securely verify authenticity of the allocation.

Typically, an ApplicationMaster receives the Container from the ResourceManager during resource-negotiation and then talks to the NodeManager to start/stop containers.

See Also:

ApplicationMasterProtocol.allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest), ContainerManagementProtocol.startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest), ContainerManagementProtocol.stopContainers(org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest)

Constructor Summary

Constructors

Constructor and Description
Container()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Token	getContainerToken() Get the ContainerToken for the container.
abstract ContainerId	getId() Get the globally unique identifier for the container.
abstract String	getNodeHttpAddress() Get the http uri of the node on which the container is allocated.
abstract NodeId	getNodeId() Get the identifier of the node on which the container is allocated.
abstract Priority	getPriority() Get the Priority at which the Container was allocated.
abstract Resource	getResource() Get the Resource allocated to the container.
int	getVersion() Get the version of this container.
static Container	newInstance(ContainerId containerId, NodeId nodeId, String nodeHttpAddress, Resource resource, Priority priority, Token containerToken)
abstract void	setContainerToken(Token containerToken)
abstract void	setId(ContainerId id)
abstract void	setNodeHttpAddress(String nodeHttpAddress)
abstract void	setNodeId(NodeId nodeId)
abstract void	setPriority(Priority priority)
abstract void	setResource(Resource resource)
void	setVersion(int version) Set the version of this container.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

Container

public Container()

Method Detail

newInstance

@InterfaceAudience.Private
@InterfaceStability.Unstable
public static Container newInstance(ContainerId containerId,
                                                                          NodeId nodeId,
                                                                          String nodeHttpAddress,
                                                                          Resource resource,
                                                                          Priority priority,
                                                                          Token containerToken)

getId

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract ContainerId getId()

Get the globally unique identifier for the container.

Returns:

globally unique identifier for the container

setId

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setId(ContainerId id)

getNodeId

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract NodeId getNodeId()

Get the identifier of the node on which the container is allocated.

Returns:

identifier of the node on which the container is allocated

setNodeId

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setNodeId(NodeId nodeId)

getNodeHttpAddress

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract String getNodeHttpAddress()

Get the http uri of the node on which the container is allocated.

Returns:

http uri of the node on which the container is allocated

setNodeHttpAddress

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setNodeHttpAddress(String nodeHttpAddress)

getResource

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract Resource getResource()

Get the Resource allocated to the container.

Returns:

Resource allocated to the container

setResource

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setResource(Resource resource)

getPriority

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract Priority getPriority()

Get the Priority at which the Container was allocated.

Returns:

Priority at which the Container was allocated

setPriority

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setPriority(Priority priority)

getContainerToken

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract Token getContainerToken()

Get the ContainerToken for the container.

ContainerToken is the security token used by the framework to verify authenticity of any Container.

The ResourceManager, on container allocation provides a secure token which is verified by the NodeManager on container launch.

Applications do not need to care about ContainerToken, they are transparently handled by the framework - the allocated Container includes the ContainerToken.

Returns:

ContainerToken for the container

See Also:

ApplicationMasterProtocol.allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest), ContainerManagementProtocol.startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)

setContainerToken

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setContainerToken(Token containerToken)

getVersion

@InterfaceAudience.Private
@InterfaceStability.Unstable
public int getVersion()

Get the version of this container. The version will be incremented when a container is updated.

Returns:

version of this container.

setVersion

@InterfaceAudience.Private
@InterfaceStability.Unstable
public void setVersion(int version)

Set the version of this container.

Parameters:

version - of this container.