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.
• ContainerState of the container.
• Exit status of a completed container.
• Diagnostic message for a failed container.

Constructor Summary

Constructors

Constructor and Description
ContainerStatus()

Method Summary

Modifier and Type	Method and Description
abstract ContainerId	getContainerId() Get the ContainerId of the container.
abstract String	getDiagnostics() Get diagnostic messages for failed containers.
abstract int	getExitStatus() Get the exit status for the container.
abstract ContainerState	getState() Get the ContainerState of the container.
static ContainerStatus	newInstance(ContainerId containerId, ContainerState containerState, String diagnostics, int exitStatus)
abstract void	setContainerId(ContainerId containerId)
abstract void	setDiagnostics(String diagnostics)
abstract void	setExitStatus(int exitStatus)
abstract void	setState(ContainerState state)

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

newInstance

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public static ContainerStatus newInstance(ContainerId containerId,
                                                                                                   ContainerState containerState,
                                                                                                   String diagnostics,
                                                                                                   int exitStatus)

getContainerId

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

Get the ContainerId of the container.

Returns:

ContainerId of the container

setContainerId

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public abstract void setContainerId(ContainerId containerId)

getState

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

Get the ContainerState of the container.

Returns:

ContainerState of the container

setState

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public abstract void setState(ContainerState state)

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

setExitStatus

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public abstract void setExitStatus(int exitStatus)

getDiagnostics

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

Get diagnostic messages for failed containers.

Returns:

diagnostic messages for failed containers

setDiagnostics

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public abstract void setDiagnostics(String diagnostics)