org.apache.hadoop.yarn.api.records

Class NodeReport

java.lang.Object

org.apache.hadoop.yarn.api.records.NodeReport

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

NodeReport is a summary of runtime information of a node in the cluster.

It includes details such as:

• NodeId of the node.
• HTTP Tracking URL of the node.
• Rack name for the node.
• Used Resource on the node.
• Total available Resource of the node.
• Number of running containers on the node.

See Also:

ApplicationClientProtocol.getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)

Constructor Summary

Constructors

Constructor and Description
NodeReport()

Method Summary

Modifier and Type	Method and Description
ResourceUtilization	getAggregatedContainersUtilization() Get containers aggregated resource utilization in a node.
abstract Resource	getCapability() Get the total Resource on the node.
Integer	getDecommissioningTimeout() Optional decommissioning timeout in seconds (null indicates absent timeout).
abstract String	getHealthReport() Get the diagnostic health report of the node.
abstract String	getHttpAddress() Get the http address of the node.
abstract long	getLastHealthReportTime() Get the last timestamp at which the health report was received.
abstract Set<NodeAttribute>	getNodeAttributes() Get node attributes of node.
abstract NodeId	getNodeId() Get the NodeId of the node.
abstract Set<String>	getNodeLabels() Get labels of this node.
abstract NodeState	getNodeState() Get the NodeState of the node.
org.apache.hadoop.yarn.api.records.NodeUpdateType	getNodeUpdateType() Optional node update type (null indicates absent update type).
abstract ResourceUtilization	getNodeUtilization() Get node resource utilization.
abstract String	getRackName() Get the rack name for the node.
abstract Resource	getUsed() Get used Resource on the node.
void	setDecommissioningTimeout(Integer decommissioningTimeout) Set the decommissioning timeout in seconds (null indicates absent timeout).
abstract void	setNodeAttributes(Set<NodeAttribute> nodeAttributes) Set the node attributes of node.
void	setNodeUpdateType(org.apache.hadoop.yarn.api.records.NodeUpdateType nodeUpdateType) Set the node update type (null indicates absent node update type).

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeReport

public NodeReport()

Method Detail

getNodeId

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

Get the NodeId of the node.

Returns:

NodeId of the node

getNodeState

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract NodeState getNodeState()

Get the NodeState of the node.

Returns:

NodeState of the node

getHttpAddress

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

Get the http address of the node.

Returns:

http address of the node

getRackName

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

Get the rack name for the node.

Returns:

rack name for the node

getUsed

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

Get used Resource on the node.

Returns:

used Resource on the node

getCapability

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

Get the total Resource on the node.

Returns:

total Resource on the node

getHealthReport

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

Get the diagnostic health report of the node.

Returns:

diagnostic health report of the node

getLastHealthReportTime

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract long getLastHealthReportTime()

Get the last timestamp at which the health report was received.

Returns:

last timestamp at which the health report was received

getNodeLabels

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract Set<String> getNodeLabels()

Get labels of this node.

Returns:

labels of this node.

getAggregatedContainersUtilization

@InterfaceAudience.Public
 @InterfaceStability.Stable
public ResourceUtilization getAggregatedContainersUtilization()

Get containers aggregated resource utilization in a node.

Returns:

containers resource utilization.

getNodeUtilization

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract ResourceUtilization getNodeUtilization()

Get node resource utilization.

Returns:

node resource utilization.

getDecommissioningTimeout

public Integer getDecommissioningTimeout()

Optional decommissioning timeout in seconds (null indicates absent timeout).

Returns:

the decommissioning timeout in second.

setDecommissioningTimeout

public void setDecommissioningTimeout(Integer decommissioningTimeout)

Set the decommissioning timeout in seconds (null indicates absent timeout).

Parameters:

decommissioningTimeout - decommissioning time out.

getNodeUpdateType

public org.apache.hadoop.yarn.api.records.NodeUpdateType getNodeUpdateType()

Optional node update type (null indicates absent update type).

Returns:

the node update.

setNodeUpdateType

public void setNodeUpdateType(org.apache.hadoop.yarn.api.records.NodeUpdateType nodeUpdateType)

Set the node update type (null indicates absent node update type).

Parameters:

nodeUpdateType - node update type.

setNodeAttributes

public abstract void setNodeAttributes(Set<NodeAttribute> nodeAttributes)

Set the node attributes of node.

Parameters:

nodeAttributes - set of node attributes.

getNodeAttributes

public abstract Set<NodeAttribute> getNodeAttributes()

Get node attributes of node.

Returns:

the set of node attributes.