Package org.apache.hadoop.yarn.server.federation.store.records

Class SubClusterHeartbeatRequest

java.lang.Object

org.apache.hadoop.yarn.server.federation.store.records.SubClusterHeartbeatRequest

Direct Known Subclasses:

SubClusterHeartbeatRequestPBImpl

@Private
@Unstable
public abstract class SubClusterHeartbeatRequest
extends java.lang.Object

SubClusterHeartbeatRequest is a report of the runtime information of the subcluster that is participating in federation.

It includes information such as:

• SubClusterId
• The URL of the subcluster
• The timestamp representing the last start time of the subCluster
• FederationsubClusterState
• The current capacity and utilization of the subCluster

Constructor Summary

Constructors

Constructor	Description
SubClusterHeartbeatRequest()

Method Summary

Modifier and Type	Method	Description
abstract java.lang.String	getCapability()	Get the current capacity and utilization of the subcluster.
abstract long	getLastHeartBeat()	Get the last heart beat time of the subcluster.
abstract SubClusterState	getState()	Get the SubClusterState of the subcluster.
abstract SubClusterId	getSubClusterId()	Get the SubClusterId representing the unique identifier of the subcluster.
static SubClusterHeartbeatRequest	newInstance(SubClusterId subClusterId, long lastHeartBeat, SubClusterState state, java.lang.String capability)
static SubClusterHeartbeatRequest	newInstance(SubClusterId subClusterId, SubClusterState state, java.lang.String capability)
abstract void	setCapability(java.lang.String capability)	Set the current capacity and utilization of the subCluster.
abstract void	setLastHeartBeat(long time)	Set the last heartbeat time of the subcluster.
abstract void	setState(SubClusterState state)	Set the SubClusterState of the subcluster.
abstract void	setSubClusterId(SubClusterId subClusterId)	Set the SubClusterId representing the unique identifier of the subCluster.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SubClusterHeartbeatRequest

public SubClusterHeartbeatRequest()

Method Detail

newInstance

@Private
@Unstable
public static SubClusterHeartbeatRequest newInstance(SubClusterId subClusterId,
                                                     SubClusterState state,
                                                     java.lang.String capability)

newInstance

@Private
@Unstable
public static SubClusterHeartbeatRequest newInstance(SubClusterId subClusterId,
                                                     long lastHeartBeat,
                                                     SubClusterState state,
                                                     java.lang.String capability)

getSubClusterId

@Public
@Unstable
public abstract SubClusterId getSubClusterId()

Get the SubClusterId representing the unique identifier of the subcluster.

Returns:

the subcluster identifier

setSubClusterId

@Private
@Unstable
public abstract void setSubClusterId(SubClusterId subClusterId)

Set the SubClusterId representing the unique identifier of the subCluster.

Parameters:

subClusterId - the subCluster identifier

getLastHeartBeat

@Public
@Unstable
public abstract long getLastHeartBeat()

Get the last heart beat time of the subcluster.

Returns:

the state of the subcluster

setLastHeartBeat

@Private
@Unstable
public abstract void setLastHeartBeat(long time)

Set the last heartbeat time of the subcluster.

Parameters:

time - the last heartbeat time of the subcluster

getState

@Public
@Unstable
public abstract SubClusterState getState()

Get the SubClusterState of the subcluster.

Returns:

the state of the subcluster

setState

@Private
@Unstable
public abstract void setState(SubClusterState state)

Set the SubClusterState of the subcluster.

Parameters:

state - the state of the subCluster

getCapability

@Public
@Unstable
public abstract java.lang.String getCapability()

Get the current capacity and utilization of the subcluster. This is the JAXB marshalled string representation of the ClusterMetrics.

Returns:

the current capacity and utilization of the subcluster

setCapability

@Private
@Unstable
public abstract void setCapability(java.lang.String capability)

Set the current capacity and utilization of the subCluster. This is the JAXB marshalled string representation of the ClusterMetrics.

Parameters:

capability - the current capacity and utilization of the subcluster

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object