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

NodeReport()

Method Summary

abstract Resource	getCapability() Get the total Resource on the node.
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 NodeId	getNodeId() Get the NodeId of the node.
abstract NodeState	getNodeState() Get the NodeState of the node.
abstract int	getNumContainers() Get the number of allocated containers on the node.
abstract String	getRackName() Get the rack name for the node.
abstract Resource	getUsed() Get used Resource on the node.
static NodeReport	newInstance(NodeId nodeId, NodeState nodeState, String httpAddress, String rackName, Resource used, Resource capability, int numContainers, String healthReport, long lastHealthReportTime)
abstract void	setCapability(Resource capability)
abstract void	setHealthReport(String healthReport)
abstract void	setHttpAddress(String httpAddress)
abstract void	setLastHealthReportTime(long lastHealthReport)
abstract void	setNodeId(NodeId nodeId)
abstract void	setNodeState(NodeState nodeState)
abstract void	setNumContainers(int numContainers)
abstract void	setRackName(String rackName)
abstract void	setUsed(Resource used)

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

newInstance

@InterfaceAudience.Private
@InterfaceStability.Unstable
public static NodeReport newInstance(NodeId nodeId,
                                                                                           NodeState nodeState,
                                                                                           String httpAddress,
                                                                                           String rackName,
                                                                                           Resource used,
                                                                                           Resource capability,
                                                                                           int numContainers,
                                                                                           String healthReport,
                                                                                           long lastHealthReportTime)

getNodeId

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

Get the NodeId of the node.

Returns:

NodeId of the node

setNodeId

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

getNodeState

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

Get the NodeState of the node.

Returns:

NodeState of the node

setNodeState

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setNodeState(NodeState nodeState)

getHttpAddress

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

Get the http address of the node.

Returns:

http address of the node

setHttpAddress

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

getRackName

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

Get the rack name for the node.

Returns:

rack name for the node

setRackName

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

getUsed

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

Get used Resource on the node.

Returns:

used Resource on the node

setUsed

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

getCapability

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

Get the total Resource on the node.

Returns:

total Resource on the node

setCapability

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

getNumContainers

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract int getNumContainers()

Get the number of allocated containers on the node.

Returns:

number of allocated containers on the node

setNumContainers

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

getHealthReport

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

Get the diagnostic health report of the node.

Returns:

diagnostic health report of the node

setHealthReport

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setHealthReport(String healthReport)

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

setLastHealthReportTime

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setLastHealthReportTime(long lastHealthReport)