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

All Known Implementing Classes:

NodeHealthStatusPBImpl

@InterfaceAudience.Public
@InterfaceStability.Stable
public interface NodeHealthStatus

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, ClientRMProtocol.getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)

Method Summary

String	getHealthReport() Get the diagnostic health report of the node.
boolean	getIsNodeHealthy() Is the node healthy?
long	getLastHealthReportTime() Get the last timestamp at which the health report was received.
void	setHealthReport(String healthReport)
void	setIsNodeHealthy(boolean isNodeHealthy)
void	setLastHealthReportTime(long lastHealthReport)

Method Detail

getIsNodeHealthy

@InterfaceAudience.Public
@InterfaceStability.Stable
boolean getIsNodeHealthy()

Is the node healthy?

Returns:

true if the node is healthy, else false

setIsNodeHealthy

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setIsNodeHealthy(boolean isNodeHealthy)

getHealthReport

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

Get the diagnostic health report of the node.

Returns:

diagnostic health report of the node

setHealthReport

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

getLastHealthReportTime

@InterfaceAudience.Public
@InterfaceStability.Stable
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
void setLastHealthReportTime(long lastHealthReport)