Package org.apache.hadoop.yarn.server.resourcemanager.placement.csmappingrule

Class MappingRuleActions

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.placement.csmappingrule.MappingRuleActions

public final class MappingRuleActions
extends Object

This class contains all the actions and some helper methods to generate them.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MappingRuleActions.PlaceToQueueAction	PlaceToQueueAction represents a placement action, contains the pattern of the queue name or path in which the path variables will be substituted with the variable context's respective values.
static class	MappingRuleActions.RejectAction	RejectAction represents the action when the application is rejected, this simply will throw an error on the user's side letting it know the submission was rejected.
static class	MappingRuleActions.VariableUpdateAction	VariableUpdateAction represents the action which alters one of the mutable variables in the variable context, but doesn't do anything with the application.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_QUEUE_VARIABLE

Method Summary

Modifier and Type	Method	Description
static MappingRuleAction	createPlaceToDefaultAction()	Convenience method to create an action which places the application to the DEFAULT queue.
static MappingRuleAction	createPlaceToQueueAction(String queue, boolean allowCreate)	Convenience method to create an action which places the application to a queue.
static MappingRuleAction	createRejectAction()	Convenience method to create an action rejects the application.
static MappingRuleAction	createUpdateDefaultAction(String queue)	Convenience method to create an action which changes the default queue.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_QUEUE_VARIABLE

public static final String DEFAULT_QUEUE_VARIABLE

See Also:

• Constant Field Values

Method Details

createUpdateDefaultAction

public static MappingRuleAction createUpdateDefaultAction(String queue)

Convenience method to create an action which changes the default queue.

Parameters:

queue - The new value of the default queue

Returns:

VariableUpdateAction which will change the default queue on execute

createPlaceToQueueAction

public static MappingRuleAction createPlaceToQueueAction(String queue,
 boolean allowCreate)

Convenience method to create an action which places the application to a queue.

Parameters:

queue - The name of the queue the application should be placed to

allowCreate - Determines if the target queue should be created if it does not exist

Returns:

PlaceToQueueAction which will place the application to the specified queue on execute

createPlaceToDefaultAction

public static MappingRuleAction createPlaceToDefaultAction()

Convenience method to create an action which places the application to the DEFAULT queue.

Returns:

PlaceToQueueAction which will place the application to the DEFAULT queue on execute

createRejectAction

public static MappingRuleAction createRejectAction()

Convenience method to create an action rejects the application.

Returns:

RejectAction which will reject the application on execute