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

Class ContainerReport

java.lang.Object

org.apache.hadoop.yarn.api.records.ContainerReport

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

ContainerReport is a report of an container.

It includes details such as:

• ContainerId of the container.
• Allocated Resources to the container.
• Assigned Node id.
• Assigned Priority.
• Creation Time.
• Finish Time.
• Container Exit Status.
• ContainerState of the container.
• Diagnostic information in case of errors.
• Log URL.
• nodeHttpAddress

Constructor Summary

Constructors

Constructor	Description
ContainerReport()

Method Summary

Modifier and Type	Method	Description
abstract Resource	getAllocatedResource()	Get the allocated Resource of the container.
abstract NodeId	getAssignedNode()	Get the allocated NodeId where container is running.
abstract int	getContainerExitStatus()	Get the final exit status of the container.
abstract ContainerId	getContainerId()	Get the ContainerId of the container.
abstract ContainerState	getContainerState()	Get the final ContainerState of the container.
abstract long	getCreationTime()	Get the creation time of the container.
abstract java.lang.String	getDiagnosticsInfo()	Get the DiagnosticsInfo of the container.
abstract ExecutionType	getExecutionType()	Get the execution type of the container.
abstract java.lang.String	getExposedPorts()	Get exposed ports of the container.
abstract long	getFinishTime()	Get the Finish time of the container.
abstract java.lang.String	getLogUrl()	Get the LogURL of the container.
abstract java.lang.String	getNodeHttpAddress()	Get the Node Http address of the container.
abstract Priority	getPriority()	Get the allocated Priority of the container.
static ContainerReport	newInstance(ContainerId containerId, Resource allocatedResource, NodeId assignedNode, Priority priority, long creationTime, long finishTime, java.lang.String diagnosticInfo, java.lang.String logUrl, int containerExitStatus, ContainerState containerState, java.lang.String nodeHttpAddress)
static ContainerReport	newInstance(ContainerId containerId, Resource allocatedResource, NodeId assignedNode, Priority priority, long creationTime, long finishTime, java.lang.String diagnosticInfo, java.lang.String logUrl, int containerExitStatus, ContainerState containerState, java.lang.String nodeHttpAddress, ExecutionType executionType)
abstract void	setAllocatedResource(Resource resource)
abstract void	setAssignedNode(NodeId nodeId)
abstract void	setContainerExitStatus(int containerExitStatus)
abstract void	setContainerId(ContainerId containerId)
abstract void	setContainerState(ContainerState containerState)
abstract void	setCreationTime(long creationTime)
abstract void	setDiagnosticsInfo(java.lang.String diagnosticsInfo)
abstract void	setExecutionType(ExecutionType executionType)
abstract void	setExposedPorts(java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.String>>> ports)
abstract void	setFinishTime(long finishTime)
abstract void	setLogUrl(java.lang.String logUrl)
abstract void	setNodeHttpAddress(java.lang.String nodeHttpAddress)
abstract void	setPriority(Priority priority)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerReport

public ContainerReport()

Method Detail

newInstance

@Private
@Unstable
public static ContainerReport newInstance(ContainerId containerId,
                                          Resource allocatedResource,
                                          NodeId assignedNode,
                                          Priority priority,
                                          long creationTime,
                                          long finishTime,
                                          java.lang.String diagnosticInfo,
                                          java.lang.String logUrl,
                                          int containerExitStatus,
                                          ContainerState containerState,
                                          java.lang.String nodeHttpAddress)

newInstance

@Private
@Unstable
public static ContainerReport newInstance(ContainerId containerId,
                                          Resource allocatedResource,
                                          NodeId assignedNode,
                                          Priority priority,
                                          long creationTime,
                                          long finishTime,
                                          java.lang.String diagnosticInfo,
                                          java.lang.String logUrl,
                                          int containerExitStatus,
                                          ContainerState containerState,
                                          java.lang.String nodeHttpAddress,
                                          ExecutionType executionType)

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)

getAllocatedResource

@Public
@Unstable
public abstract Resource getAllocatedResource()

Get the allocated Resource of the container.

Returns:

allocated Resource of the container.

setAllocatedResource

@Public
@Unstable
public abstract void setAllocatedResource(Resource resource)

getAssignedNode

@Public
@Unstable
public abstract NodeId getAssignedNode()

Get the allocated NodeId where container is running.

Returns:

allocated NodeId where container is running.

setAssignedNode

@Public
@Unstable
public abstract void setAssignedNode(NodeId nodeId)

getPriority

@Public
@Unstable
public abstract Priority getPriority()

Get the allocated Priority of the container.

Returns:

allocated Priority of the container.

setPriority

@Public
@Unstable
public abstract void setPriority(Priority priority)

getCreationTime

@Public
@Unstable
public abstract long getCreationTime()

Get the creation time of the container.

Returns:

creation time of the container

setCreationTime

@Public
@Unstable
public abstract void setCreationTime(long creationTime)

getFinishTime

@Public
@Unstable
public abstract long getFinishTime()

Get the Finish time of the container.

Returns:

Finish time of the container

setFinishTime

@Public
@Unstable
public abstract void setFinishTime(long finishTime)

getDiagnosticsInfo

@Public
@Unstable
public abstract java.lang.String getDiagnosticsInfo()

Get the DiagnosticsInfo of the container.

Returns:

DiagnosticsInfo of the container

setDiagnosticsInfo

@Public
@Unstable
public abstract void setDiagnosticsInfo(java.lang.String diagnosticsInfo)

getLogUrl

@Public
@Unstable
public abstract java.lang.String getLogUrl()

Get the LogURL of the container.

Returns:

LogURL of the container

setLogUrl

@Public
@Unstable
public abstract void setLogUrl(java.lang.String logUrl)

getContainerState

@Public
@Unstable
public abstract ContainerState getContainerState()

Get the final ContainerState of the container.

Returns:

final ContainerState of the container.

setContainerState

@Public
@Unstable
public abstract void setContainerState(ContainerState containerState)

getContainerExitStatus

@Public
@Unstable
public abstract int getContainerExitStatus()

Get the final exit status of the container.

Returns:

final exit status of the container.

setContainerExitStatus

@Public
@Unstable
public abstract void setContainerExitStatus(int containerExitStatus)

getExposedPorts

@Public
@Unstable
public abstract java.lang.String getExposedPorts()

Get exposed ports of the container.

Returns:

the node exposed ports of the container

setExposedPorts

@Private
@Unstable
public abstract void setExposedPorts(java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.String>>> ports)

getNodeHttpAddress

@Public
@Unstable
public abstract java.lang.String getNodeHttpAddress()

Get the Node Http address of the container.

Returns:

the node http address of the container

setNodeHttpAddress

@Private
@Unstable
public abstract void setNodeHttpAddress(java.lang.String nodeHttpAddress)

getExecutionType

@Public
@Unstable
public abstract ExecutionType getExecutionType()

Get the execution type of the container.

Returns:

the execution type of the container

setExecutionType

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