org.apache.hadoop.yarn.api.records

Interface NodeReport

@InterfaceAudience.Public
@InterfaceStability.Stable
public interface NodeReport

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.
• NodeHealthStatus of the node.

See Also:

NodeHealthStatus, ClientRMProtocol.getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)

Method Summary

Methods

Modifier and Type	Method and Description
Resource	getCapability() Get the total Resource on the node.
String	getHttpAddress() Get the http address of the node.
NodeHealthStatus	getNodeHealthStatus() Get the NodeHealthStatus of the node.
NodeId	getNodeId() Get the NodeId of the node.
org.apache.hadoop.yarn.api.records.NodeState	getNodeState() Get the NodeState of the node.
int	getNumContainers() Get the number of running containers on the node.
String	getRackName() Get the rack name for the node.
Resource	getUsed() Get used Resource on the node.

Method Detail

getNodeId

NodeId getNodeId()

Get the NodeId of the node.

Returns:

NodeId of the node

getNodeState

org.apache.hadoop.yarn.api.records.NodeState getNodeState()

Get the NodeState of the node.

Returns:

NodeState of the node

getHttpAddress

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

Get the http address of the node.

Returns:

http address of the node

getRackName

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

Get the rack name for the node.

Returns:

rack name for the node

getUsed

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

Get used Resource on the node.

Returns:

used Resource on the node

getCapability

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

Get the total Resource on the node.

Returns:

total Resource on the node

getNumContainers

@InterfaceAudience.Public
@InterfaceStability.Stable
int getNumContainers()

Get the number of running containers on the node.

Returns:

number of running containers on the node

getNodeHealthStatus

@InterfaceAudience.Public
@InterfaceStability.Stable
NodeHealthStatus getNodeHealthStatus()

Get the NodeHealthStatus of the node.

Returns:

NodeHealthStatus of the node