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

Class ReservationHomeSubCluster

java.lang.Object

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

Direct Known Subclasses:

ReservationHomeSubClusterPBImpl

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

ReservationHomeSubCluster is a report of the runtime information of the reservation that is running in the federated cluster.

It includes information such as:

• ReservationId
• SubClusterId

Constructor Summary

Constructors

Constructor	Description
ReservationHomeSubCluster()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
abstract SubClusterId	getHomeSubCluster()	Get the SubClusterId representing the unique identifier of the home subcluster in which the reservation is mapped to.
abstract org.apache.hadoop.yarn.api.records.ReservationId	getReservationId()	Get the ReservationId representing the unique identifier of the Reservation.
int	hashCode()
static ReservationHomeSubCluster	newInstance(org.apache.hadoop.yarn.api.records.ReservationId resId, SubClusterId homeSubCluster)
abstract void	setHomeSubCluster(SubClusterId subClusterId)	Set the SubClusterId representing the unique identifier of the home subcluster in which the ReservationMaster of the reservation is running.
abstract void	setReservationId(org.apache.hadoop.yarn.api.records.ReservationId resId)	Set the ReservationId representing the unique identifier of the Reservation.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReservationHomeSubCluster

public ReservationHomeSubCluster()

Method Detail

newInstance

@Private
@Unstable
public static ReservationHomeSubCluster newInstance(org.apache.hadoop.yarn.api.records.ReservationId resId,
                                                    SubClusterId homeSubCluster)

getReservationId

@Public
@Unstable
public abstract org.apache.hadoop.yarn.api.records.ReservationId getReservationId()

Get the ReservationId representing the unique identifier of the Reservation.

Returns:

the reservation identifier

setReservationId

@Private
@Unstable
public abstract void setReservationId(org.apache.hadoop.yarn.api.records.ReservationId resId)

Set the ReservationId representing the unique identifier of the Reservation.

Parameters:

resId - the reservation identifier

getHomeSubCluster

@Public
@Unstable
public abstract SubClusterId getHomeSubCluster()

Get the SubClusterId representing the unique identifier of the home subcluster in which the reservation is mapped to.

Returns:

the home subcluster identifier

setHomeSubCluster

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

Set the SubClusterId representing the unique identifier of the home subcluster in which the ReservationMaster of the reservation is running.

Parameters:

subClusterId - the home subcluster identifier

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object