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

Interface SchedulerQueue<T extends SchedulerQueue>

All Superinterfaces:

Queue

All Known Subinterfaces:

CSQueue

All Known Implementing Classes:

AbstractAutoCreatedLeafQueue, AbstractCSQueue, AbstractLeafQueue, AbstractManagedParentQueue, AbstractParentQueue, AutoCreatedLeafQueue, LeafQueue, ManagedParentQueue, ParentQueue, PlanQueue, ReservationQueue

@LimitedPrivate("yarn")
public interface SchedulerQueue<T extends SchedulerQueue>
extends Queue

Represents a queue in Scheduler.

Method Summary

Modifier and Type	Method	Description
void	activateQueue()	Activate the queue.
List<T>	getChildQueues()	Get list of child queues.
T	getParent()	Get the parent queue.
org.apache.hadoop.yarn.api.records.QueueState	getState()	Get current queue state.
void	stopQueue()	Stop the queue.
void	updateQueueState(org.apache.hadoop.yarn.api.records.QueueState state)	Update the queue state.

Methods inherited from interface org.apache.hadoop.yarn.server.resourcemanager.scheduler.Queue

decPendingResource, decReservedResource, getAbstractUsersManager, getAccessibleNodeLabels, getDefaultApplicationPriority, getDefaultNodeLabelExpression, getMetrics, getQueueInfo, getQueueName, getQueueUserAclInfo, hasAccess, incPendingResource, incReservedResource, recoverContainer

Method Details

getChildQueues

List<T> getChildQueues()

Get list of child queues.

Returns:

a list of child queues

getParent

T getParent()

Get the parent queue.

Returns:

the parent queue

getState

org.apache.hadoop.yarn.api.records.QueueState getState()

Get current queue state.

Returns:

the queue state

updateQueueState

void updateQueueState(org.apache.hadoop.yarn.api.records.QueueState state)

Update the queue state.

Parameters:

state - the queue state

stopQueue

void stopQueue()

Stop the queue.

activateQueue

void activateQueue()
            throws org.apache.hadoop.yarn.exceptions.YarnException

Activate the queue.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the queue can not be activated.