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

Class UserPlacementRule

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.placement.PlacementRule

org.apache.hadoop.yarn.server.resourcemanager.placement.FSPlacementRule

org.apache.hadoop.yarn.server.resourcemanager.placement.UserPlacementRule

@Private
@Unstable
public class UserPlacementRule
extends FSPlacementRule

Places apps in queues by username of the submitter.

Field Summary

Fields inherited from class org.apache.hadoop.yarn.server.resourcemanager.placement.FSPlacementRule

createQueue

Constructor Summary

Constructors

Constructor	Description
UserPlacementRule()

Method Summary

Modifier and Type	Method	Description
ApplicationPlacementContext	getPlacementForApp(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext asc, java.lang.String user)	Return the scheduler queue name the application should be placed in wrapped in an ApplicationPlacementContext object.

Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.placement.FSPlacementRule

getCreateFlag, getParentRule, initialize, setConfig, setConfig, setConfig, setParentRule

Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.placement.PlacementRule

getName, getPlacementForApp

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPlacementRule

public UserPlacementRule()

Method Detail

getPlacementForApp

public ApplicationPlacementContext getPlacementForApp(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext asc,
                                                      java.lang.String user)
                                               throws org.apache.hadoop.yarn.exceptions.YarnException

Description copied from class: PlacementRule

Return the scheduler queue name the application should be placed in wrapped in an ApplicationPlacementContext object. A non null return value places the application in a queue, a null value means the queue is not yet determined. The next PlacementRule in the list maintained in the PlacementManager will be executed.

Specified by:

getPlacementForApp in class PlacementRule

Parameters:

asc - The context of the application created on submission

user - The name of the user submitting the application

Returns:

The queue name wrapped in ApplicationPlacementContext or null if no queue was resolved

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - for any error while executing the rule