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

Class NodeHealthStatus

java.lang.Object

org.apache.hadoop.yarn.server.api.records.NodeHealthStatus

Direct Known Subclasses:

NodeHealthStatusPBImpl

@Public
@Stable
public abstract class NodeHealthStatus
extends Object

NodeHealthStatus is a summary of the health status of the node.

It includes information such as:

• An indicator of whether the node is healthy, as determined by the health-check script.
• The previous time at which the health status was reported.
• A diagnostic report on the health status.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
NodeHealthStatus()

Method Summary

Modifier and Type	Method	Description
abstract String	getHealthReport()	Get the diagnostic health report of the node.
abstract boolean	getIsNodeHealthy()	Is the node healthy?
abstract long	getLastHealthReportTime()	Get the last timestamp at which the health report was received.
static NodeHealthStatus	newInstance(boolean isNodeHealthy, String healthReport, long lastHealthReport)
abstract void	setHealthReport(String healthReport)
abstract void	setIsNodeHealthy(boolean isNodeHealthy)
abstract void	setLastHealthReportTime(long lastHealthReport)

Methods inherited from class java.lang.Object

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

Constructor Details

NodeHealthStatus

public NodeHealthStatus()

Method Details

newInstance

@Private
public static NodeHealthStatus newInstance(boolean isNodeHealthy,
 String healthReport,
 long lastHealthReport)

getIsNodeHealthy

@Public
@Stable
public abstract boolean getIsNodeHealthy()

Is the node healthy?

Returns:

true if the node is healthy, else false

setIsNodeHealthy

@Private
@Unstable
public abstract void setIsNodeHealthy(boolean isNodeHealthy)

getHealthReport

@Public
@Stable
public abstract String getHealthReport()

Get the diagnostic health report of the node.

Returns:

diagnostic health report of the node

setHealthReport

@Private
@Unstable
public abstract void setHealthReport(String healthReport)

getLastHealthReportTime

@Public
@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

@Private
@Unstable
public abstract void setLastHealthReportTime(long lastHealthReport)