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

Class SubClusterId

java.lang.Object

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

All Implemented Interfaces:

java.lang.Comparable<SubClusterId>

Direct Known Subclasses:

SubClusterIdPBImpl

@Private
@Unstable
public abstract class SubClusterId
extends java.lang.Object
implements java.lang.Comparable<SubClusterId>

SubClusterId represents the globally unique identifier for a subcluster that is participating in federation.

The globally unique nature of the identifier is obtained from the FederationMembershipStateStore on initialization.

Constructor Summary

Constructors

Constructor	Description
SubClusterId()

Method Summary

Modifier and Type	Method	Description
int	compareTo(SubClusterId other)
boolean	equals(java.lang.Object obj)
abstract java.lang.String	getId()	Get the string identifier of the subcluster which is unique across the federated cluster.
int	hashCode()
static SubClusterId	newInstance(java.lang.Integer subClusterId)
static SubClusterId	newInstance(java.lang.String subClusterId)
protected abstract void	setId(java.lang.String subClusterId)	Set the string identifier of the subcluster which is unique across the federated cluster.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SubClusterId

public SubClusterId()

Method Detail

newInstance

@Private
@Unstable
public static SubClusterId newInstance(java.lang.String subClusterId)

newInstance

@Private
@Unstable
public static SubClusterId newInstance(java.lang.Integer subClusterId)

getId

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

Get the string identifier of the subcluster which is unique across the federated cluster. The identifier is static, i.e. preserved across restarts and failover.

Returns:

unique identifier of the subcluster

setId

@Private
@Unstable
protected abstract void setId(java.lang.String subClusterId)

Set the string identifier of the subcluster which is unique across the federated cluster. The identifier is static, i.e. preserved across restarts and failover.

Parameters:

subClusterId - unique identifier of the subcluster

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

compareTo

public int compareTo(SubClusterId other)

Specified by:

compareTo in interface java.lang.Comparable<SubClusterId>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object