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

Class YarnClusterMetrics

java.lang.Object

org.apache.hadoop.yarn.api.records.YarnClusterMetrics

@Public
@Stable
public abstract class YarnClusterMetrics
extends java.lang.Object

YarnClusterMetrics represents cluster metrics.

Currently only number of NodeManagers is provided.

Constructor Summary

Constructors

Constructor	Description
YarnClusterMetrics()

Method Summary

Modifier and Type	Method	Description
abstract int	getNumActiveNodeManagers()	Get the number of ActiveNodeManagers in the cluster.
abstract int	getNumDecommissionedNodeManagers()	Get the number of DecommissionedNodeManagers in the cluster.
abstract int	getNumDecommissioningNodeManagers()	Get the number of DecommissioningNodeManagers in the cluster.
abstract int	getNumLostNodeManagers()	Get the number of LostNodeManagers in the cluster.
abstract int	getNumNodeManagers()	Get the number of NodeManagers in the cluster.
abstract int	getNumRebootedNodeManagers()	Get the number of RebootedNodeManagers in the cluster.
abstract int	getNumShutdownNodeManagers()	Get the number of ShutdownNodeManagers in the cluster.
abstract int	getNumUnhealthyNodeManagers()	Get the number of UnhealthyNodeManagers in the cluster.
static YarnClusterMetrics	newInstance(int numNodeManagers)
abstract void	setNumActiveNodeManagers(int numActiveNodeManagers)
abstract void	setNumDecommissionedNodeManagers(int numDecommissionedNodeManagers)
abstract void	setNumDecommissioningNodeManagers(int numDecommissioningNodeManagers)
abstract void	setNumLostNodeManagers(int numLostNodeManagers)
abstract void	setNumNodeManagers(int numNodeManagers)
abstract void	setNumRebootedNodeManagers(int numRebootedNodeManagers)
abstract void	setNumShutdownNodeManagers(int numShutdownNodeManagers)
abstract void	setNumUnhealthyNodeManagers(int numUnhealthNodeManagers)

Methods inherited from class java.lang.Object

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

Constructor Detail

YarnClusterMetrics

public YarnClusterMetrics()

Method Detail

newInstance

@Private
@Unstable
public static YarnClusterMetrics newInstance(int numNodeManagers)

getNumNodeManagers

@Public
@Stable
public abstract int getNumNodeManagers()

Get the number of NodeManagers in the cluster.

Returns:

number of NodeManagers in the cluster

setNumNodeManagers

@Private
@Unstable
public abstract void setNumNodeManagers(int numNodeManagers)

getNumDecommissioningNodeManagers

@Public
@Unstable
public abstract int getNumDecommissioningNodeManagers()

Get the number of DecommissioningNodeManagers in the cluster.

Returns:

number of DecommissioningNodeManagers in the cluster

setNumDecommissioningNodeManagers

@Private
@Unstable
public abstract void setNumDecommissioningNodeManagers(int numDecommissioningNodeManagers)

getNumDecommissionedNodeManagers

@Public
@Unstable
public abstract int getNumDecommissionedNodeManagers()

Get the number of DecommissionedNodeManagers in the cluster.

Returns:

number of DecommissionedNodeManagers in the cluster

setNumDecommissionedNodeManagers

@Private
@Unstable
public abstract void setNumDecommissionedNodeManagers(int numDecommissionedNodeManagers)

getNumActiveNodeManagers

@Public
@Unstable
public abstract int getNumActiveNodeManagers()

Get the number of ActiveNodeManagers in the cluster.

Returns:

number of ActiveNodeManagers in the cluster

setNumActiveNodeManagers

@Private
@Unstable
public abstract void setNumActiveNodeManagers(int numActiveNodeManagers)

getNumLostNodeManagers

@Public
@Unstable
public abstract int getNumLostNodeManagers()

Get the number of LostNodeManagers in the cluster.

Returns:

number of LostNodeManagers in the cluster

setNumLostNodeManagers

@Private
@Unstable
public abstract void setNumLostNodeManagers(int numLostNodeManagers)

getNumUnhealthyNodeManagers

@Public
@Unstable
public abstract int getNumUnhealthyNodeManagers()

Get the number of UnhealthyNodeManagers in the cluster.

Returns:

number of UnhealthyNodeManagers in the cluster

setNumUnhealthyNodeManagers

@Private
@Unstable
public abstract void setNumUnhealthyNodeManagers(int numUnhealthNodeManagers)

getNumRebootedNodeManagers

@Public
@Unstable
public abstract int getNumRebootedNodeManagers()

Get the number of RebootedNodeManagers in the cluster.

Returns:

number of RebootedNodeManagers in the cluster

setNumRebootedNodeManagers

@Private
@Unstable
public abstract void setNumRebootedNodeManagers(int numRebootedNodeManagers)

getNumShutdownNodeManagers

@Public
@Unstable
public abstract int getNumShutdownNodeManagers()

Get the number of ShutdownNodeManagers in the cluster.

Returns:

number of ShutdownNodeManagers in the cluster

setNumShutdownNodeManagers

@Private
@Unstable
public abstract void setNumShutdownNodeManagers(int numShutdownNodeManagers)