org.apache.hadoop.yarn.api.records

Class ContainerStatus

java.lang.Object

org.apache.hadoop.yarn.api.records.ContainerStatus

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract class ContainerStatus
extends Object

ContainerStatus represents the current status of a Container.

It provides details such as:

• ContainerId of the container.
• ExecutionType of the container.
• ContainerState of the container.
• Exit status of a completed container.
• Diagnostic message for a failed container.
• Resource allocated to the container.

Constructor Summary

Constructors

Constructor and Description
ContainerStatus()

Method Summary

Modifier and Type	Method and Description
Resource	getCapability() Get the Resource allocated to the container.
abstract ContainerId	getContainerId() Get the ContainerId of the container.
abstract String	getDiagnostics() Get diagnostic messages for failed containers.
ExecutionType	getExecutionType() Get the ExecutionType of the container.
abstract int	getExitStatus() Get the exit status for the container.
String	getHost() Get the hostname where the container runs.
List<String>	getIPs() Get all the IP addresses with which the container run.
abstract ContainerState	getState() Get the ContainerState of the container.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerStatus

public ContainerStatus()

Method Detail

getContainerId

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

Get the ContainerId of the container.

Returns:

ContainerId of the container

getExecutionType

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public ExecutionType getExecutionType()

Get the ExecutionType of the container.

Returns:

ExecutionType of the container

getState

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract ContainerState getState()

Get the ContainerState of the container.

Returns:

ContainerState of the container

getExitStatus

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract int getExitStatus()

Get the exit status for the container.

Note: This is valid only for completed containers i.e. containers with state ContainerState.COMPLETE. Otherwise, it returns an ContainerExitStatus.INVALID.

Containers killed by the framework, either due to being released by the application or being 'lost' due to node failures etc. have a special exit code of ContainerExitStatus.ABORTED.

When threshold number of the nodemanager-local-directories or threshold number of the nodemanager-log-directories become bad, then container is not launched and is exited with ContainersExitStatus.DISKS_FAILED.

Returns:

exit status for the container

getDiagnostics

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

Get diagnostic messages for failed containers.

Returns:

diagnostic messages for failed containers

getCapability

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public Resource getCapability()

Get the Resource allocated to the container.

Returns:

Resource allocated to the container

getIPs

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public List<String> getIPs()

Get all the IP addresses with which the container run.

Returns:

The IP address where the container runs.

getHost

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public String getHost()

Get the hostname where the container runs.

Returns:

The hostname where the container runs.