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

Class GetSubClustersInfoRequest

java.lang.Object

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

Direct Known Subclasses:

GetSubClustersInfoRequestPBImpl

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

Request class to obtain information about all sub-clusters that are participating in federation. If filterInactiveSubClusters is set to true, only active sub-clusters will be returned; otherwise, all sub-clusters will be returned regardless of state. By default, filterInactiveSubClusters is true.

Constructor Summary

Constructors

Constructor	Description
GetSubClustersInfoRequest()

Method Summary

Modifier and Type	Method	Description
abstract boolean	getFilterInactiveSubClusters()	Get the flag that indicates whether only active sub-clusters should be returned.
static GetSubClustersInfoRequest	newInstance(boolean filterInactiveSubClusters)
abstract void	setFilterInactiveSubClusters(boolean filterInactiveSubClusters)	Set the flag that indicates whether only active sub-clusters should be returned.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetSubClustersInfoRequest

public GetSubClustersInfoRequest()

Method Detail

newInstance

@Public
@Unstable
public static GetSubClustersInfoRequest newInstance(boolean filterInactiveSubClusters)

getFilterInactiveSubClusters

@Public
@Unstable
public abstract boolean getFilterInactiveSubClusters()

Get the flag that indicates whether only active sub-clusters should be returned.

Returns:

whether to filter out inactive sub-clusters

setFilterInactiveSubClusters

@Public
@Unstable
public abstract void setFilterInactiveSubClusters(boolean filterInactiveSubClusters)

Set the flag that indicates whether only active sub-clusters should be returned.

Parameters:

filterInactiveSubClusters - whether to filter out inactive sub-clusters