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

All Known Implementing Classes:

NodeReportPBImpl

@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

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.
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.
void	setCapability(Resource capability)
void	setHttpAddress(String httpAddress)
void	setNodeHealthStatus(NodeHealthStatus nodeHealthStatus)
void	setNodeId(NodeId nodeId)
void	setNumContainers(int numContainers)
void	setRackName(String rackName)
void	setUsed(Resource used)

Method Detail

getNodeId

NodeId getNodeId()

Get the NodeId of the node.

Returns:

NodeId of the node

setNodeId

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setNodeId(NodeId nodeId)

getHttpAddress

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

Get the http address of the node.

Returns:

http address of the node

setHttpAddress

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setHttpAddress(String httpAddress)

getRackName

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

Get the rack name for the node.

Returns:

rack name for the node

setRackName

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setRackName(String rackName)

getUsed

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

Get used Resource on the node.

Returns:

used Resource on the node

setUsed

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setUsed(Resource used)

getCapability

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

Get the total Resource on the node.

Returns:

total Resource on the node

setCapability

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setCapability(Resource capability)

getNumContainers

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

Get the number of running containers on the node.

Returns:

number of running containers on the node

setNumContainers

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setNumContainers(int numContainers)

getNodeHealthStatus

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

Get the NodeHealthStatus of the node.

Returns:

NodeHealthStatus of the node

setNodeHealthStatus

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setNodeHealthStatus(NodeHealthStatus nodeHealthStatus)