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

Class PlanQueue

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractCSQueue

org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractParentQueue

org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractManagedParentQueue

org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.PlanQueue

All Implemented Interfaces:

CSQueue, Queue, SchedulerQueue<CSQueue>

public class PlanQueue
extends AbstractManagedParentQueue

This represents a dynamic queue managed by the ReservationSystem. From the user perspective this is equivalent to a LeafQueue that respect reservations, but functionality wise is a sub-class of ParentQueue

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractParentQueue

AbstractParentQueue.QueueCapacityType

Nested classes/interfaces inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractCSQueue

AbstractCSQueue.CapacityConfigType

Field Summary

Fields inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractManagedParentQueue

leafQueueTemplate, queueManagementPolicy

Fields inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractParentQueue

childQueues

Fields inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractCSQueue

activitiesManager, authorizer, capacityConfigType, configuredCapacityVectors, configuredMaxCapacityVectors, queueAllocationSettings, queueContext, queueEntity, queueNodeLabelsSettings, queuePath, readLock, writeLock

Constructor Summary

Constructors

Constructor	Description
PlanQueue(CapacitySchedulerQueueContext queueContext, java.lang.String queueName, CSQueue parent, CSQueue old)

Method Summary

Modifier and Type	Method	Description
int	getMaxApplicationsForReservations()	Number of maximum applications for each of the reservations in this Plan.
int	getMaxApplicationsPerUserForReservation()	Number of maximum applications per user for each of the reservations in this Plan.
float	getUserLimitFactor()	User limit factor value for each of the reservations in this Plan.
float	getUserLimitForReservation()	User limit value for each of the reservations in this Plan.
ReservationQueue	initializeDefaultInternalQueue()
void	reinitialize(CSQueue newlyParsedQueue, org.apache.hadoop.yarn.api.records.Resource clusterResource)	Reinitialize the queue.
boolean	showReservationsAsQueues()	Determine whether to hide/show the ReservationQueues.

Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractManagedParentQueue

addChildQueue, getAutoCreatedQueueManagementPolicy, getLeafQueueTemplate, initializeLeafQueueConfigs, removeChildQueue, removeChildQueue, sumOfChildAbsCapacities, sumOfChildCapacities, validateQueueEntitlementChange

Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractParentQueue

apply, assignContainers, attachContainer, collectSchedulerApplications, completedContainer, createNewQueue, detachContainer, finishApplication, finishApplicationAttempt, getAbstractUsersManager, getAutoCreatedQueueTemplate, getCapacityConfigurationTypeForQueues, getChildQueues, getChildQueuesByTryLock, getNumApplications, getQueueInfo, getQueueOrderingPolicy, getQueueUserAclInfo, getResourceLimitsOfChild, hasChildQueues, isEligibleForAutoDeletion, isEligibleForAutoQueueCreation, isEligibleForLegacyAutoQueueCreation, recoverContainer, refreshAfterResourceCalculation, setDynamicQueueACLProperties, setupQueueConfigs, stopQueue, submitApplication, submitApplicationAttempt, submitApplicationAttempt, toString, updateClusterResource, updateClusterResourceLegacyMode, validateSubmitApplication

Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.AbstractCSQueue

accept, activateQueue, appFinished, assignContainers, checkConfigTypeIsAbsoluteResource, decPendingResource, decReservedResource, decUsedResource, getAbsoluteCapacity, getAbsoluteMaximumCapacity, getAbsoluteUsedCapacity, getAccessibleNodeLabels, getACLs, getCapacity, getCapacityConfigType, getCapacityOrWeightString, getConfiguredCapacityVector, getConfiguredMaxCapacityVector, getConfiguredNodeLabels, getDefaultApplicationLifetime, getDefaultApplicationPriority, getDefaultAppLifetimeWasSpecifiedInConfig, getDefaultNodeLabelExpression, getEffectiveCapacity, getEffectiveCapacityDown, getEffectiveMaxCapacity, getEffectiveMaxCapacityDown, getIntraQueuePreemptionDisabled, getIntraQueuePreemptionDisabledInHierarchy, getKillableContainers, getLabel, getMaximumAbsoluteResource, getMaximumAllocation, getMaximumApplicationLifetime, getMaximumCapacity, getMaxParallelApps, getMetrics, getMinimumAbsoluteResource, getMinimumAllocation, getMultiNodeSortingPolicyName, getNodeLabelsForQueue, getNumContainers, getParent, getPreemptionDisabled, getPriority, getPrivilegedEntity, getQueueCapacities, getQueueContext, getQueueInfo, getQueueName, getQueuePath, getQueuePathObject, getQueueResourceQuotas, getQueueResourceUsage, getQueueShortName, getReadLock, getState, getTotalKillableResource, getUsedCapacity, getUsedResources, getUserWeights, getWriteLock, hasAccess, incPendingResource, incReservedResource, incUsedResource, isDynamicQueue, isInactiveDynamicQueue, isReservationsContinueLooking, overrideCapacityVectorsForSpecialQueues, parseAndSetDynamicTemplates, recoverDrainingState, releaseResource, setConfiguredMaxCapacityVector, setConfiguredMinCapacityVector, setDynamicQueue, setMaxParallelApps, setMultiNodeSortingPolicyName, setParent, setupConfigurableCapacities, updateAbsoluteCapacities, updateCapacityConfigType, updateConfigurableResourceLimits, updateQueueState

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanQueue

public PlanQueue(CapacitySchedulerQueueContext queueContext,
                 java.lang.String queueName,
                 CSQueue parent,
                 CSQueue old)
          throws java.io.IOException

Throws:

java.io.IOException

Method Detail

reinitialize

public void reinitialize(CSQueue newlyParsedQueue,
                         org.apache.hadoop.yarn.api.records.Resource clusterResource)
                  throws java.io.IOException

Description copied from interface: CSQueue

Reinitialize the queue.

Specified by:

reinitialize in interface CSQueue

Overrides:

reinitialize in class AbstractManagedParentQueue

Parameters:

newlyParsedQueue - new queue to re-initalize from

clusterResource - resources in the cluster

Throws:

java.io.IOException - an I/O exception has occurred.

initializeDefaultInternalQueue

public ReservationQueue initializeDefaultInternalQueue()
                                                throws java.io.IOException

Throws:

java.io.IOException

getMaxApplicationsForReservations

public int getMaxApplicationsForReservations()

Number of maximum applications for each of the reservations in this Plan.

Returns:

maxAppsForreservation

getMaxApplicationsPerUserForReservation

public int getMaxApplicationsPerUserForReservation()

Number of maximum applications per user for each of the reservations in this Plan.

Returns:

maxAppsPerUserForreservation

getUserLimitForReservation

public float getUserLimitForReservation()

User limit value for each of the reservations in this Plan.

Returns:

userLimit

getUserLimitFactor

public float getUserLimitFactor()

User limit factor value for each of the reservations in this Plan.

Returns:

userLimitFactor

showReservationsAsQueues

public boolean showReservationsAsQueues()

Determine whether to hide/show the ReservationQueues.

Returns:

true, show ReservationQueues; false, hide ReservationQueues.