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

Class SubClusterPolicyConfiguration

java.lang.Object

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

Direct Known Subclasses:

SubClusterPolicyConfigurationPBImpl

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

SubClusterPolicyConfiguration is a class that represents a configuration of a policy. For a single queue, it contains a policy type (resolve to a class name) and its params as an opaque ByteBuffer. Note: by design the params are an opaque ByteBuffer, this allows for enough flexibility to evolve the policies without impacting the protocols to/from the federation state store.

Constructor Summary

Constructors

Constructor	Description
SubClusterPolicyConfiguration()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
abstract java.nio.ByteBuffer	getParams()	Get the policy parameters.
abstract java.lang.String	getQueue()	Get the name of the queue for which we are configuring a policy.
abstract java.lang.String	getType()	Get the type of the policy.
int	hashCode()
static SubClusterPolicyConfiguration	newInstance(java.lang.String queue, java.lang.String policyType, java.nio.ByteBuffer policyParams)
static SubClusterPolicyConfiguration	newInstance(SubClusterPolicyConfiguration conf)
abstract void	setParams(java.nio.ByteBuffer policyParams)	Set the policy parameters.
abstract void	setQueue(java.lang.String queueName)	Sets the name of the queue for which we are configuring a policy.
abstract void	setType(java.lang.String policyType)	Sets the type of the policy.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SubClusterPolicyConfiguration

public SubClusterPolicyConfiguration()

Method Detail

newInstance

@Private
@Unstable
public static SubClusterPolicyConfiguration newInstance(java.lang.String queue,
                                                        java.lang.String policyType,
                                                        java.nio.ByteBuffer policyParams)

newInstance

@Private
@Unstable
public static SubClusterPolicyConfiguration newInstance(SubClusterPolicyConfiguration conf)

getQueue

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

Get the name of the queue for which we are configuring a policy.

Returns:

the name of the queue

setQueue

@Private
@Unstable
public abstract void setQueue(java.lang.String queueName)

Sets the name of the queue for which we are configuring a policy.

Parameters:

queueName - the name of the queue

getType

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

Get the type of the policy. This could be random, round-robin, load-based, etc.

Returns:

the type of the policy

setType

@Private
@Unstable
public abstract void setType(java.lang.String policyType)

Sets the type of the policy. This could be random, round-robin, load-based, etc.

Parameters:

policyType - the type of the policy

getParams

@Public
@Unstable
public abstract java.nio.ByteBuffer getParams()

Get the policy parameters. This affects how the policy behaves and an example could be weight distribution of queues across multiple sub-clusters.

Returns:

the byte array that contains the parameters

setParams

@Private
@Unstable
public abstract void setParams(java.nio.ByteBuffer policyParams)

Set the policy parameters. This affects how the policy behaves and an example could be weight distribution of queues across multiple sub-clusters.

Parameters:

policyParams - byte array that describes the policy

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object