Package org.apache.hadoop.yarn.api.protocolrecords

Class GetClusterMetricsResponse

java.lang.Object

org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse

@Public
@Stable
public abstract class GetClusterMetricsResponse
extends Object

The response sent by the ResourceManager to a client requesting cluster metrics.

See Also:

• YarnClusterMetrics
• ApplicationClientProtocol.getClusterMetrics(GetClusterMetricsRequest)

Constructor Summary

Constructors

Constructor	Description
GetClusterMetricsResponse()

Method Summary

Modifier and Type	Method	Description
abstract YarnClusterMetrics	getClusterMetrics()	Get the YarnClusterMetrics for the cluster.
static GetClusterMetricsResponse	newInstance(YarnClusterMetrics metrics)
abstract void	setClusterMetrics(YarnClusterMetrics metrics)

Methods inherited from class java.lang.Object

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

Constructor Details

GetClusterMetricsResponse

public GetClusterMetricsResponse()

Method Details

newInstance

@Private
@Unstable
public static GetClusterMetricsResponse newInstance(YarnClusterMetrics metrics)

getClusterMetrics

@Public
@Stable
public abstract YarnClusterMetrics getClusterMetrics()

Get the YarnClusterMetrics for the cluster.

Returns:

YarnClusterMetrics for the cluster

setClusterMetrics

@Private
@Unstable
public abstract void setClusterMetrics(YarnClusterMetrics metrics)