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

Class SubClusterDeregisterRequest

java.lang.Object

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

Direct Known Subclasses:

SubClusterDeregisterRequestPBImpl

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

The request sent to set the state of a subcluster to either SC_DECOMMISSIONED, SC_LOST, or SC_DEREGISTERED.

The update includes details such as:

• SubClusterId
• SubClusterState

Constructor Summary

Constructors

Constructor	Description
SubClusterDeregisterRequest()

Method Summary

Modifier and Type	Method	Description
abstract SubClusterState	getState()	Get the SubClusterState of the subcluster.
abstract SubClusterId	getSubClusterId()	Get the SubClusterId representing the unique identifier of the subcluster.
static SubClusterDeregisterRequest	newInstance(SubClusterId subClusterId, SubClusterState subClusterState)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubClusterDeregisterRequest

public SubClusterDeregisterRequest()

Method Detail

newInstance

@Private
@Unstable
public static SubClusterDeregisterRequest newInstance(SubClusterId subClusterId,
                                                      SubClusterState subClusterState)

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

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