org.apache.hadoop.yarn.server.resourcemanager.scheduler
Interface Queue

All Known Subinterfaces:

CSQueue

All Known Implementing Classes:

FSLeafQueue, FSParentQueue, FSQueue, LeafQueue, ParentQueue

@InterfaceStability.Evolving
@InterfaceAudience.LimitedPrivate(value="yarn")
public interface Queue

Method Summary

QueueMetrics	getMetrics() Get the queue metrics
org.apache.hadoop.yarn.api.records.QueueInfo	getQueueInfo(boolean includeChildQueues, boolean recursive) Get queue information
String	getQueueName() Get the queue name
List<org.apache.hadoop.yarn.api.records.QueueUserACLInfo>	getQueueUserAclInfo(org.apache.hadoop.security.UserGroupInformation user) Get queue ACLs for given user.
boolean	hasAccess(org.apache.hadoop.yarn.api.records.QueueACL acl, org.apache.hadoop.security.UserGroupInformation user)

Method Detail

getQueueName

String getQueueName()

Get the queue name

Returns:

queue name

getMetrics

QueueMetrics getMetrics()

Get the queue metrics

Returns:

the queue metrics

getQueueInfo

org.apache.hadoop.yarn.api.records.QueueInfo getQueueInfo(boolean includeChildQueues,
                                                          boolean recursive)

Get queue information

Parameters:

includeChildQueues - include child queues?

recursive - recursively get child queue information?

Returns:

queue information

getQueueUserAclInfo

List<org.apache.hadoop.yarn.api.records.QueueUserACLInfo> getQueueUserAclInfo(org.apache.hadoop.security.UserGroupInformation user)

Get queue ACLs for given user.

Parameters:

user - username

Returns:

queue ACLs for user

hasAccess

boolean hasAccess(org.apache.hadoop.yarn.api.records.QueueACL acl,
                  org.apache.hadoop.security.UserGroupInformation user)