Google Git
Sign in
apache / hadoop-site / 492776fcef707028e97853d0b0072b2ec326b274 / . / content / docs / r3.3.4 / hadoop-yarn / hadoop-yarn-server / hadoop-yarn-server-resourcemanager / apidocs / org / apache / hadoop / yarn / server / resourcemanager / scheduler / capacity / CSQueue.html
blob: 1cbef648105b8f0d3b73f70b94dca73cb561f85e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_312) on Fri Jul 29 14:12:12 GMT 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CSQueue (Apache Hadoop YARN ResourceManager 3.3.4 API)</title>
<meta name="date" content="2022-07-29">
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CSQueue (Apache Hadoop YARN ResourceManager 3.3.4 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CSQueue.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSMaxRunningAppsEnforcer.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" target="_top">Frames</a></li>
<li><a href="CSQueue.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity</div>
<h2 title="Interface CSQueue" class="title">Interface CSQueue</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Queue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerQueue</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/AbstractAutoCreatedLeafQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">AbstractAutoCreatedLeafQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/AbstractCSQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">AbstractCSQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/AbstractManagedParentQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">AbstractManagedParentQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/AutoCreatedLeafQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">AutoCreatedLeafQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/LeafQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">LeafQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/ManagedParentQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">ManagedParentQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/ParentQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">ParentQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/PlanQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">PlanQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/ReservationQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">ReservationQueue</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceStability.Stable
@InterfaceAudience.Private
public interface <span class="typeNameLabel">CSQueue</span>
extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerQueue</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&gt;</pre>
<div class="block"><code>CSQueue</code> represents a node in the tree of
hierarchical queues in the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CapacityScheduler.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity"><code>CapacityScheduler</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#accept-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.ResourceCommitRequest-">accept</a></span>(org.apache.hadoop.yarn.api.records.Resource&nbsp;cluster,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/ResourceCommitRequest.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common">ResourceCommitRequest</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>,<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerNode</a>&gt;&nbsp;request)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#apply-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.ResourceCommitRequest-">apply</a></span>(org.apache.hadoop.yarn.api.records.Resource&nbsp;cluster,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/ResourceCommitRequest.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common">ResourceCommitRequest</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>,<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerNode</a>&gt;&nbsp;request)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSAssignment.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSAssignment</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#assignContainers-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.placement.CandidateNodeSet-org.apache.hadoop.yarn.server.resourcemanager.scheduler.ResourceLimits-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.SchedulingMode-">assignContainers</a></span>(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/placement/CandidateNodeSet.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.placement">CandidateNodeSet</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerNode</a>&gt;&nbsp;candidates,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceLimits.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ResourceLimits</a>&nbsp;resourceLimits,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/SchedulingMode.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">SchedulingMode</a>&nbsp;schedulingMode)</code>
<div class="block">Assign containers to applications in the queue or it's children (if any).</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSAssignment.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSAssignment</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#assignContainers-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerNode-org.apache.hadoop.yarn.server.resourcemanager.scheduler.ResourceLimits-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.SchedulingMode-">assignContainers</a></span>(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerNode</a>&nbsp;node,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceLimits.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ResourceLimits</a>&nbsp;resourceLimits,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/SchedulingMode.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">SchedulingMode</a>&nbsp;schedulingMode)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#attachContainer-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerApp-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">attachContainer</a></span>(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>&nbsp;application,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a>&nbsp;container)</code>
<div class="block">Attach a container to this queue</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#collectSchedulerApplications-java.util.Collection-">collectSchedulerApplications</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;org.apache.hadoop.yarn.api.records.ApplicationAttemptId&gt;&nbsp;apps)</code>
<div class="block">Adds all applications in the queue and its subqueues to the given collection.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#completedContainer-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerApp-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerNode-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-org.apache.hadoop.yarn.api.records.ContainerStatus-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainerEventType-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CSQueue-boolean-">completedContainer</a></span>(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>&nbsp;application,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerNode</a>&nbsp;node,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a>&nbsp;container,
org.apache.hadoop.yarn.api.records.ContainerStatus&nbsp;containerStatus,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainerEventType.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainerEventType</a>&nbsp;event,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&nbsp;childQueue,
boolean&nbsp;sortQueues)</code>
<div class="block">A container assigned to the queue has completed.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#decPendingResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">decPendingResource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeLabel,
org.apache.hadoop.yarn.api.records.Resource&nbsp;resourceToDec)</code>
<div class="block">When an outstanding resource is fulfilled or canceled, calling this will
decrease pending resource in a queue.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#decUsedResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedulerApplicationAttempt-">decUsedResource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodePartition,
org.apache.hadoop.yarn.api.records.Resource&nbsp;resourceToDec,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerApplicationAttempt.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerApplicationAttempt</a>&nbsp;application)</code>
<div class="block">When partition of node updated, we will update queue's resource usage if it
has container(s) running on that.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#detachContainer-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerApp-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">detachContainer</a></span>(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>&nbsp;application,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a>&nbsp;container)</code>
<div class="block">Detach a container from this queue</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#finishApplication-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-">finishApplication</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId&nbsp;applicationId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user)</code>
<div class="block">An application submitted to this queue has finished.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#finishApplicationAttempt-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerApp-java.lang.String-">finishApplicationAttempt</a></span>(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>&nbsp;application,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queue)</code>
<div class="block">An application attempt submitted to this queue has finished.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getAbsoluteCapacity--">getAbsoluteCapacity</a></span>()</code>
<div class="block">Get capacity of the parent of the queue as a function of the
cumulative capacity in the cluster.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getAbsoluteMaximumCapacity--">getAbsoluteMaximumCapacity</a></span>()</code>
<div class="block">Get maximum-capacity of the queue as a funciton of the cumulative capacity
of the cluster.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getAbsoluteUsedCapacity--">getAbsoluteUsedCapacity</a></span>()</code>
<div class="block">Get the current absolute used capacity of the queue
relative to the entire cluster.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/AbstractUsersManager.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">AbstractUsersManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getAbstractUsersManager--">getAbstractUsersManager</a></span>()</code>
<div class="block">Get the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/AbstractUsersManager.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>AbstractUsersManager</code></a> for the queue.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getCapacity--">getCapacity</a></span>()</code>
<div class="block">Get the configured <em>capacity</em> of the queue.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/AbstractCSQueue.CapacityConfigType.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">AbstractCSQueue.CapacityConfigType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getCapacityConfigType--">getCapacityConfigType</a></span>()</code>
<div class="block">Get CapacityConfigType as PERCENTAGE or ABSOLUTE_RESOURCE.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getChildQueues--">getChildQueues</a></span>()</code>
<div class="block">Get child queues</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getDefaultApplicationLifetime--">getDefaultApplicationLifetime</a></span>()</code>
<div class="block">Get the default lifetime in seconds of an application which is submitted to
this queue.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getDefaultAppLifetimeWasSpecifiedInConfig--">getDefaultAppLifetimeWasSpecifiedInConfig</a></span>()</code>
<div class="block">Get the indicator of whether or not the default application lifetime was
set by a config property or was calculated by the capacity scheduler.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getEffectiveCapacity-java.lang.String-">getEffectiveCapacity</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;label)</code>
<div class="block">Get effective capacity of queue.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getEffectiveCapacityDown-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">getEffectiveCapacityDown</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;label,
org.apache.hadoop.yarn.api.records.Resource&nbsp;factor)</code>
<div class="block">Get effective capacity of queue.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getEffectiveMaxCapacity-java.lang.String-">getEffectiveMaxCapacity</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;label)</code>
<div class="block">Get effective max capacity of queue.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getEffectiveMaxCapacityDown-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">getEffectiveMaxCapacityDown</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;label,
org.apache.hadoop.yarn.api.records.Resource&nbsp;factor)</code>
<div class="block">Get effective max capacity of queue.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getIntraQueuePreemptionDisabled--">getIntraQueuePreemptionDisabled</a></span>()</code>
<div class="block">Check whether intra-queue preemption is disabled for this queue</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getIntraQueuePreemptionDisabledInHierarchy--">getIntraQueuePreemptionDisabledInHierarchy</a></span>()</code>
<div class="block">Determines whether or not the intra-queue preemption disabled switch is set
at any level in this queue's hierarchy.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getMaximumAllocation--">getMaximumAllocation</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getMaximumApplicationLifetime--">getMaximumApplicationLifetime</a></span>()</code>
<div class="block">Get the maximum lifetime in seconds of an application which is submitted to
this queue.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getMaximumCapacity--">getMaximumCapacity</a></span>()</code>
<div class="block">Get the configured maximum-capacity of the queue.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getMinimumAllocation--">getMinimumAllocation</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getMultiNodeSortingPolicyName--">getMultiNodeSortingPolicyName</a></span>()</code>
<div class="block">Get Multi Node scheduling policy name.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getNodeLabelsForQueue--">getNodeLabelsForQueue</a></span>()</code>
<div class="block">Get valid Node Labels for this queue</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getNumApplications--">getNumApplications</a></span>()</code>
<div class="block">Get the number of applications in the queue.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getParent--">getParent</a></span>()</code>
<div class="block">Get the parent <code>Queue</code>.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getPreemptionDisabled--">getPreemptionDisabled</a></span>()</code>
<div class="block">Check whether <em>disable_preemption</em> property is set for this queue</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Priority</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getPriority--">getPriority</a></span>()</code>
<div class="block">Get priority of queue</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.security.PrivilegedEntity</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getPrivilegedEntity--">getPrivilegedEntity</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/QueueCapacities.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">QueueCapacities</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getQueueCapacities--">getQueueCapacities</a></span>()</code>
<div class="block">Get QueueCapacities of this queue</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getQueueName--">getQueueName</a></span>()</code>
<div class="block">Get the queue's internal reference name.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getQueuePath--">getQueuePath</a></span>()</code>
<div class="block">Get the full name of the queue, including the heirarchy.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueResourceQuotas.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueResourceQuotas</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getQueueResourceQuotas--">getQueueResourceQuotas</a></span>()</code>
<div class="block">Get QueueResourceQuotas associated with each queue.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceUsage.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ResourceUsage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getQueueResourceUsage--">getQueueResourceUsage</a></span>()</code>
<div class="block">Get ResourceUsage of this queue</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getQueueShortName--">getQueueShortName</a></span>()</code>
<div class="block">Get the queue's legacy name.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.ReadLock.html?is-external=true" title="class or interface in java.util.concurrent.locks">ReentrantReadWriteLock.ReadLock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getReadLock--">getReadLock</a></span>()</code>
<div class="block">Get readLock associated with the Queue.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.QueueState</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getState--">getState</a></span>()</code>
<div class="block">Get the current run-state of the queue</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getUsedCapacity--">getUsedCapacity</a></span>()</code>
<div class="block">Get the current used capacity of nodes without label(s) of the queue
and it's children (if any).</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getUsedResources--">getUsedResources</a></span>()</code>
<div class="block">Get the currently utilized resources which allocated at nodes without any
labels in the cluster by the queue and children (if any).</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#getUserWeights--">getUserWeights</a></span>()</code>
<div class="block">Get a map of usernames and weights</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#hasAccess-org.apache.hadoop.yarn.api.records.QueueACL-org.apache.hadoop.security.UserGroupInformation-">hasAccess</a></span>(org.apache.hadoop.yarn.api.records.QueueACL&nbsp;acl,
org.apache.hadoop.security.UserGroupInformation&nbsp;user)</code>
<div class="block">Check if the <code>user</code> has permission to perform the operation</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#incUsedResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedulerApplicationAttempt-">incUsedResource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodePartition,
org.apache.hadoop.yarn.api.records.Resource&nbsp;resourceToInc,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerApplicationAttempt.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerApplicationAttempt</a>&nbsp;application)</code>
<div class="block">When partition of node updated, we will update queue's resource usage if it
has container(s) running on that.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#reinitialize-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CSQueue-org.apache.hadoop.yarn.api.records.Resource-">reinitialize</a></span>(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&nbsp;newlyParsedQueue,
org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource)</code>
<div class="block">Reinitialize the queue.</div>
</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#setParent-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CSQueue-">setParent</a></span>(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&nbsp;newParentQueue)</code>
<div class="block">Set the parent <code>Queue</code>.</div>
</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#submitApplication-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-java.lang.String-">submitApplication</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId&nbsp;applicationId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queue)</code>
<div class="block">Submit a new application to the queue.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#submitApplicationAttempt-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerApp-java.lang.String-">submitApplicationAttempt</a></span>(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>&nbsp;application,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userName)</code>
<div class="block">Submit an application attempt to the queue.</div>
</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#submitApplicationAttempt-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerApp-java.lang.String-boolean-">submitApplicationAttempt</a></span>(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>&nbsp;application,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userName,
boolean&nbsp;isMoveApp)</code>
<div class="block">Submit an application attempt to the queue.</div>
</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#updateClusterResource-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.ResourceLimits-">updateClusterResource</a></span>(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceLimits.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ResourceLimits</a>&nbsp;resourceLimits)</code>
<div class="block">Update the cluster resource for queues as we add/remove nodes</div>
</td>
</tr>
<tr id="i57" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html#validateSubmitApplication-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-java.lang.String-">validateSubmitApplication</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId&nbsp;applicationId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queue)</code>
<div class="block">Validate submitApplication api so that moveApplication do a pre-check.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedulerQueue">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.hadoop.yarn.server.resourcemanager.scheduler.<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerQueue</a></h3>
<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html#activeQueue--">activeQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html#stopQueue--">stopQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html#updateQueueState-org.apache.hadoop.yarn.api.records.QueueState-">updateQueueState</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.server.resourcemanager.scheduler.Queue">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.hadoop.yarn.server.resourcemanager.scheduler.<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Queue</a></h3>
<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#decReservedResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">decReservedResource</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#getAccessibleNodeLabels--">getAccessibleNodeLabels</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#getDefaultApplicationPriority--">getDefaultApplicationPriority</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#getDefaultNodeLabelExpression--">getDefaultNodeLabelExpression</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#getMetrics--">getMetrics</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#getQueueInfo-boolean-boolean-">getQueueInfo</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#getQueueUserAclInfo-org.apache.hadoop.security.UserGroupInformation-">getQueueUserAclInfo</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#incPendingResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">incPendingResource</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#incReservedResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">incReservedResource</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#recoverContainer-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedulerApplicationAttempt-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">recoverContainer</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getParent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&nbsp;getParent()</pre>
<div class="block">Get the parent <code>Queue</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html#getParent--">getParent</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerQueue</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parent queue</dd>
</dl>
</li>
</ul>
<a name="setParent-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CSQueue-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParent</h4>
<pre>void&nbsp;setParent(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&nbsp;newParentQueue)</pre>
<div class="block">Set the parent <code>Queue</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newParentQueue</code> - new parent queue</dd>
</dl>
</li>
</ul>
<a name="getQueueName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getQueueName()</pre>
<div class="block">Get the queue's internal reference name.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#getQueueName--">getQueueName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Queue</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the queue name</dd>
</dl>
</li>
</ul>
<a name="getQueueShortName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueShortName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getQueueShortName()</pre>
<div class="block">Get the queue's legacy name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the queue name</dd>
</dl>
</li>
</ul>
<a name="getQueuePath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueuePath</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getQueuePath()</pre>
<div class="block">Get the full name of the queue, including the heirarchy.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the full name of the queue</dd>
</dl>
</li>
</ul>
<a name="getPrivilegedEntity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrivilegedEntity</h4>
<pre>org.apache.hadoop.yarn.security.PrivilegedEntity&nbsp;getPrivilegedEntity()</pre>
</li>
</ul>
<a name="getMaximumAllocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumAllocation</h4>
<pre>org.apache.hadoop.yarn.api.records.Resource&nbsp;getMaximumAllocation()</pre>
</li>
</ul>
<a name="getMinimumAllocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinimumAllocation</h4>
<pre>org.apache.hadoop.yarn.api.records.Resource&nbsp;getMinimumAllocation()</pre>
</li>
</ul>
<a name="getCapacity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCapacity</h4>
<pre>float&nbsp;getCapacity()</pre>
<div class="block">Get the configured <em>capacity</em> of the queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>configured queue capacity</dd>
</dl>
</li>
</ul>
<a name="getAbsoluteCapacity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAbsoluteCapacity</h4>
<pre>float&nbsp;getAbsoluteCapacity()</pre>
<div class="block">Get capacity of the parent of the queue as a function of the
cumulative capacity in the cluster.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>capacity of the parent of the queue as a function of the
cumulative capacity in the cluster</dd>
</dl>
</li>
</ul>
<a name="getMaximumCapacity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumCapacity</h4>
<pre>float&nbsp;getMaximumCapacity()</pre>
<div class="block">Get the configured maximum-capacity of the queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured maximum-capacity of the queue</dd>
</dl>
</li>
</ul>
<a name="getAbsoluteMaximumCapacity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAbsoluteMaximumCapacity</h4>
<pre>float&nbsp;getAbsoluteMaximumCapacity()</pre>
<div class="block">Get maximum-capacity of the queue as a funciton of the cumulative capacity
of the cluster.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>maximum-capacity of the queue as a funciton of the cumulative capacity
of the cluster</dd>
</dl>
</li>
</ul>
<a name="getAbsoluteUsedCapacity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAbsoluteUsedCapacity</h4>
<pre>float&nbsp;getAbsoluteUsedCapacity()</pre>
<div class="block">Get the current absolute used capacity of the queue
relative to the entire cluster.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>queue absolute used capacity</dd>
</dl>
</li>
</ul>
<a name="getUsedCapacity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsedCapacity</h4>
<pre>float&nbsp;getUsedCapacity()</pre>
<div class="block">Get the current used capacity of nodes without label(s) of the queue
and it's children (if any).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>queue used capacity</dd>
</dl>
</li>
</ul>
<a name="getUsedResources--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsedResources</h4>
<pre>org.apache.hadoop.yarn.api.records.Resource&nbsp;getUsedResources()</pre>
<div class="block">Get the currently utilized resources which allocated at nodes without any
labels in the cluster by the queue and children (if any).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>used resources by the queue and it's children</dd>
</dl>
</li>
</ul>
<a name="getState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getState</h4>
<pre>org.apache.hadoop.yarn.api.records.QueueState&nbsp;getState()</pre>
<div class="block">Get the current run-state of the queue</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html#getState--">getState</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerQueue</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>current run-state</dd>
</dl>
</li>
</ul>
<a name="getChildQueues--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildQueues</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&gt;&nbsp;getChildQueues()</pre>
<div class="block">Get child queues</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html#getChildQueues--">getChildQueues</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerQueue</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>child queues</dd>
</dl>
</li>
</ul>
<a name="hasAccess-org.apache.hadoop.yarn.api.records.QueueACL-org.apache.hadoop.security.UserGroupInformation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasAccess</h4>
<pre>boolean&nbsp;hasAccess(org.apache.hadoop.yarn.api.records.QueueACL&nbsp;acl,
org.apache.hadoop.security.UserGroupInformation&nbsp;user)</pre>
<div class="block">Check if the <code>user</code> has permission to perform the operation</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#hasAccess-org.apache.hadoop.yarn.api.records.QueueACL-org.apache.hadoop.security.UserGroupInformation-">hasAccess</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Queue</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>acl</code> - ACL</dd>
<dd><code>user</code> - user</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the user has the permission,
<code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="submitApplication-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>submitApplication</h4>
<pre>void&nbsp;submitApplication(org.apache.hadoop.yarn.api.records.ApplicationId&nbsp;applicationId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queue)
throws org.apache.hadoop.security.AccessControlException</pre>
<div class="block">Submit a new application to the queue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>applicationId</code> - the applicationId of the application being submitted</dd>
<dd><code>user</code> - user who submitted the application</dd>
<dd><code>queue</code> - queue to which the application is submitted</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.AccessControlException</code></dd>
</dl>
</li>
</ul>
<a name="submitApplicationAttempt-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerApp-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>submitApplicationAttempt</h4>
<pre>void&nbsp;submitApplicationAttempt(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>&nbsp;application,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userName)</pre>
<div class="block">Submit an application attempt to the queue.</div>
</li>
</ul>
<a name="submitApplicationAttempt-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerApp-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>submitApplicationAttempt</h4>
<pre>void&nbsp;submitApplicationAttempt(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>&nbsp;application,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userName,
boolean&nbsp;isMoveApp)</pre>
<div class="block">Submit an application attempt to the queue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>application</code> - application whose attempt is being submitted</dd>
<dd><code>userName</code> - user who submitted the application attempt</dd>
<dd><code>isMoveApp</code> - is application being moved across the queue</dd>
</dl>
</li>
</ul>
<a name="finishApplication-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>finishApplication</h4>
<pre>void&nbsp;finishApplication(org.apache.hadoop.yarn.api.records.ApplicationId&nbsp;applicationId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user)</pre>
<div class="block">An application submitted to this queue has finished.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>applicationId</code> - </dd>
<dd><code>user</code> - user who submitted the application</dd>
</dl>
</li>
</ul>
<a name="finishApplicationAttempt-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerApp-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>finishApplicationAttempt</h4>
<pre>void&nbsp;finishApplicationAttempt(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>&nbsp;application,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queue)</pre>
<div class="block">An application attempt submitted to this queue has finished.</div>
</li>
</ul>
<a name="assignContainers-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.placement.CandidateNodeSet-org.apache.hadoop.yarn.server.resourcemanager.scheduler.ResourceLimits-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.SchedulingMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assignContainers</h4>
<pre><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSAssignment.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSAssignment</a>&nbsp;assignContainers(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/placement/CandidateNodeSet.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.placement">CandidateNodeSet</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerNode</a>&gt;&nbsp;candidates,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceLimits.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ResourceLimits</a>&nbsp;resourceLimits,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/SchedulingMode.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">SchedulingMode</a>&nbsp;schedulingMode)</pre>
<div class="block">Assign containers to applications in the queue or it's children (if any).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clusterResource</code> - the resource of the cluster.</dd>
<dd><code>candidates</code> - <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/placement/CandidateNodeSet.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.placement"><code>CandidateNodeSet</code></a> the nodes that are considered
for the current placement.</dd>
<dd><code>resourceLimits</code> - how much overall resource of this queue can use.</dd>
<dd><code>schedulingMode</code> - Type of exclusive check when assign container on a
NodeManager, see <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/SchedulingMode.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity"><code>SchedulingMode</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the assignment</dd>
</dl>
</li>
</ul>
<a name="completedContainer-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerApp-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerNode-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-org.apache.hadoop.yarn.api.records.ContainerStatus-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainerEventType-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CSQueue-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>completedContainer</h4>
<pre>void&nbsp;completedContainer(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>&nbsp;application,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerNode</a>&nbsp;node,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a>&nbsp;container,
org.apache.hadoop.yarn.api.records.ContainerStatus&nbsp;containerStatus,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainerEventType.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainerEventType</a>&nbsp;event,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&nbsp;childQueue,
boolean&nbsp;sortQueues)</pre>
<div class="block">A container assigned to the queue has completed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clusterResource</code> - the resource of the cluster</dd>
<dd><code>application</code> - application to which the container was assigned</dd>
<dd><code>node</code> - node on which the container completed</dd>
<dd><code>container</code> - completed container,
<code>null</code> if it was just a reservation</dd>
<dd><code>containerStatus</code> - <code>ContainerStatus</code> for the completed
container</dd>
<dd><code>childQueue</code> - <code>CSQueue</code> to reinsert in childQueues</dd>
<dd><code>event</code> - event to be sent to the container</dd>
<dd><code>sortQueues</code> - indicates whether it should re-sort the queues</dd>
</dl>
</li>
</ul>
<a name="getNumApplications--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumApplications</h4>
<pre>int&nbsp;getNumApplications()</pre>
<div class="block">Get the number of applications in the queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of applications</dd>
</dl>
</li>
</ul>
<a name="reinitialize-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.CSQueue-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reinitialize</h4>
<pre>void&nbsp;reinitialize(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSQueue</a>&nbsp;newlyParsedQueue,
org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Reinitialize the queue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newlyParsedQueue</code> - new queue to re-initalize from</dd>
<dd><code>clusterResource</code> - resources in the cluster</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="updateClusterResource-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.ResourceLimits-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateClusterResource</h4>
<pre>void&nbsp;updateClusterResource(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceLimits.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ResourceLimits</a>&nbsp;resourceLimits)</pre>
<div class="block">Update the cluster resource for queues as we add/remove nodes</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clusterResource</code> - the current cluster resource</dd>
<dd><code>resourceLimits</code> - the current ResourceLimits</dd>
</dl>
</li>
</ul>
<a name="getAbstractUsersManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAbstractUsersManager</h4>
<pre><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/AbstractUsersManager.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">AbstractUsersManager</a>&nbsp;getAbstractUsersManager()</pre>
<div class="block">Get the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/AbstractUsersManager.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>AbstractUsersManager</code></a> for the queue.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#getAbstractUsersManager--">getAbstractUsersManager</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Queue</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>AbstractUsersManager</code> for the queue</dd>
</dl>
</li>
</ul>
<a name="collectSchedulerApplications-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectSchedulerApplications</h4>
<pre>void&nbsp;collectSchedulerApplications(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;org.apache.hadoop.yarn.api.records.ApplicationAttemptId&gt;&nbsp;apps)</pre>
<div class="block">Adds all applications in the queue and its subqueues to the given collection.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>apps</code> - the collection to add the applications to</dd>
</dl>
</li>
</ul>
<a name="detachContainer-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerApp-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detachContainer</h4>
<pre>void&nbsp;detachContainer(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>&nbsp;application,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a>&nbsp;container)</pre>
<div class="block">Detach a container from this queue</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clusterResource</code> - the current cluster resource</dd>
<dd><code>application</code> - application to which the container was assigned</dd>
<dd><code>container</code> - the container to detach</dd>
</dl>
</li>
</ul>
<a name="attachContainer-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerApp-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>attachContainer</h4>
<pre>void&nbsp;attachContainer(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>&nbsp;application,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a>&nbsp;container)</pre>
<div class="block">Attach a container to this queue</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clusterResource</code> - the current cluster resource</dd>
<dd><code>application</code> - application to which the container was assigned</dd>
<dd><code>container</code> - the container to attach</dd>
</dl>
</li>
</ul>
<a name="getPreemptionDisabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreemptionDisabled</h4>
<pre>boolean&nbsp;getPreemptionDisabled()</pre>
<div class="block">Check whether <em>disable_preemption</em> property is set for this queue</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if <em>disable_preemption</em> is set, false if not</dd>
</dl>
</li>
</ul>
<a name="getIntraQueuePreemptionDisabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIntraQueuePreemptionDisabled</h4>
<pre>boolean&nbsp;getIntraQueuePreemptionDisabled()</pre>
<div class="block">Check whether intra-queue preemption is disabled for this queue</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if either intra-queue preemption or inter-queue preemption
is disabled for this queue, false if neither is disabled.</dd>
</dl>
</li>
</ul>
<a name="getIntraQueuePreemptionDisabledInHierarchy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIntraQueuePreemptionDisabledInHierarchy</h4>
<pre>boolean&nbsp;getIntraQueuePreemptionDisabledInHierarchy()</pre>
<div class="block">Determines whether or not the intra-queue preemption disabled switch is set
at any level in this queue's hierarchy.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>state of the intra-queue preemption switch at this queue level</dd>
</dl>
</li>
</ul>
<a name="getQueueCapacities--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueCapacities</h4>
<pre><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/QueueCapacities.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">QueueCapacities</a>&nbsp;getQueueCapacities()</pre>
<div class="block">Get QueueCapacities of this queue</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>queueCapacities</dd>
</dl>
</li>
</ul>
<a name="getQueueResourceUsage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueResourceUsage</h4>
<pre><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceUsage.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ResourceUsage</a>&nbsp;getQueueResourceUsage()</pre>
<div class="block">Get ResourceUsage of this queue</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>resourceUsage</dd>
</dl>
</li>
</ul>
<a name="incUsedResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedulerApplicationAttempt-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incUsedResource</h4>
<pre>void&nbsp;incUsedResource(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodePartition,
org.apache.hadoop.yarn.api.records.Resource&nbsp;resourceToInc,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerApplicationAttempt.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerApplicationAttempt</a>&nbsp;application)</pre>
<div class="block">When partition of node updated, we will update queue's resource usage if it
has container(s) running on that.</div>
</li>
</ul>
<a name="decUsedResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedulerApplicationAttempt-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decUsedResource</h4>
<pre>void&nbsp;decUsedResource(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodePartition,
org.apache.hadoop.yarn.api.records.Resource&nbsp;resourceToDec,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerApplicationAttempt.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerApplicationAttempt</a>&nbsp;application)</pre>
<div class="block">When partition of node updated, we will update queue's resource usage if it
has container(s) running on that.</div>
</li>
</ul>
<a name="decPendingResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decPendingResource</h4>
<pre>void&nbsp;decPendingResource(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeLabel,
org.apache.hadoop.yarn.api.records.Resource&nbsp;resourceToDec)</pre>
<div class="block">When an outstanding resource is fulfilled or canceled, calling this will
decrease pending resource in a queue.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#decPendingResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">decPendingResource</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Queue</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeLabel</code> - asked by application</dd>
<dd><code>resourceToDec</code> - new resource asked</dd>
</dl>
</li>
</ul>
<a name="getNodeLabelsForQueue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeLabelsForQueue</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getNodeLabelsForQueue()</pre>
<div class="block">Get valid Node Labels for this queue</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>valid node labels</dd>
</dl>
</li>
</ul>
<a name="assignContainers-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica.FiCaSchedulerNode-org.apache.hadoop.yarn.server.resourcemanager.scheduler.ResourceLimits-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.SchedulingMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assignContainers</h4>
<pre><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSAssignment.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CSAssignment</a>&nbsp;assignContainers(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerNode</a>&nbsp;node,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceLimits.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ResourceLimits</a>&nbsp;resourceLimits,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/SchedulingMode.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">SchedulingMode</a>&nbsp;schedulingMode)</pre>
</li>
</ul>
<a name="accept-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.ResourceCommitRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accept</h4>
<pre>boolean&nbsp;accept(org.apache.hadoop.yarn.api.records.Resource&nbsp;cluster,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/ResourceCommitRequest.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common">ResourceCommitRequest</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>,<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerNode</a>&gt;&nbsp;request)</pre>
</li>
</ul>
<a name="apply-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.ResourceCommitRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>apply</h4>
<pre>void&nbsp;apply(org.apache.hadoop.yarn.api.records.Resource&nbsp;cluster,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/ResourceCommitRequest.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common">ResourceCommitRequest</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerApp</a>,<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/FiCaSchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica">FiCaSchedulerNode</a>&gt;&nbsp;request)</pre>
</li>
</ul>
<a name="getReadLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadLock</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.ReadLock.html?is-external=true" title="class or interface in java.util.concurrent.locks">ReentrantReadWriteLock.ReadLock</a>&nbsp;getReadLock()</pre>
<div class="block">Get readLock associated with the Queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>readLock of corresponding queue.</dd>
</dl>
</li>
</ul>
<a name="validateSubmitApplication-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateSubmitApplication</h4>
<pre>void&nbsp;validateSubmitApplication(org.apache.hadoop.yarn.api.records.ApplicationId&nbsp;applicationId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queue)
throws org.apache.hadoop.security.AccessControlException</pre>
<div class="block">Validate submitApplication api so that moveApplication do a pre-check.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>applicationId</code> - Application ID</dd>
<dd><code>userName</code> - User Name</dd>
<dd><code>queue</code> - Queue Name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.AccessControlException</code> - if any acl violation is there.</dd>
</dl>
</li>
</ul>
<a name="getPriority--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPriority</h4>
<pre>org.apache.hadoop.yarn.api.records.Priority&nbsp;getPriority()</pre>
<div class="block">Get priority of queue</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>queue priority</dd>
</dl>
</li>
</ul>
<a name="getUserWeights--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserWeights</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a>&gt;&nbsp;getUserWeights()</pre>
<div class="block">Get a map of usernames and weights</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>map of usernames and corresponding weight</dd>
</dl>
</li>
</ul>
<a name="getQueueResourceQuotas--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueResourceQuotas</h4>
<pre><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueResourceQuotas.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueResourceQuotas</a>&nbsp;getQueueResourceQuotas()</pre>
<div class="block">Get QueueResourceQuotas associated with each queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>QueueResourceQuotas</dd>
</dl>
</li>
</ul>
<a name="getCapacityConfigType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCapacityConfigType</h4>
<pre><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/AbstractCSQueue.CapacityConfigType.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">AbstractCSQueue.CapacityConfigType</a>&nbsp;getCapacityConfigType()</pre>
<div class="block">Get CapacityConfigType as PERCENTAGE or ABSOLUTE_RESOURCE.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>CapacityConfigType</dd>
</dl>
</li>
</ul>
<a name="getEffectiveCapacity-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEffectiveCapacity</h4>
<pre>org.apache.hadoop.yarn.api.records.Resource&nbsp;getEffectiveCapacity(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;label)</pre>
<div class="block">Get effective capacity of queue. If min/max resource is configured,
preference will be given to absolute configuration over normal capacity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>label</code> - partition</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>effective queue capacity</dd>
</dl>
</li>
</ul>
<a name="getEffectiveCapacityDown-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEffectiveCapacityDown</h4>
<pre>org.apache.hadoop.yarn.api.records.Resource&nbsp;getEffectiveCapacityDown(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;label,
org.apache.hadoop.yarn.api.records.Resource&nbsp;factor)</pre>
<div class="block">Get effective capacity of queue. If min/max resource is configured,
preference will be given to absolute configuration over normal capacity.
Also round down the result to normalizeDown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>label</code> - partition</dd>
<dd><code>factor</code> - factor to normalize down</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>effective queue capacity</dd>
</dl>
</li>
</ul>
<a name="getEffectiveMaxCapacity-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEffectiveMaxCapacity</h4>
<pre>org.apache.hadoop.yarn.api.records.Resource&nbsp;getEffectiveMaxCapacity(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;label)</pre>
<div class="block">Get effective max capacity of queue. If min/max resource is configured,
preference will be given to absolute configuration over normal capacity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>label</code> - partition</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>effective max queue capacity</dd>
</dl>
</li>
</ul>
<a name="getEffectiveMaxCapacityDown-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEffectiveMaxCapacityDown</h4>
<pre>org.apache.hadoop.yarn.api.records.Resource&nbsp;getEffectiveMaxCapacityDown(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;label,
org.apache.hadoop.yarn.api.records.Resource&nbsp;factor)</pre>
<div class="block">Get effective max capacity of queue. If min/max resource is configured,
preference will be given to absolute configuration over normal capacity.
Also round down the result to normalizeDown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>label</code> - partition</dd>
<dd><code>factor</code> - factor to normalize down</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>effective max queue capacity</dd>
</dl>
</li>
</ul>
<a name="getMultiNodeSortingPolicyName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMultiNodeSortingPolicyName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getMultiNodeSortingPolicyName()</pre>
<div class="block">Get Multi Node scheduling policy name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>policy name</dd>
</dl>
</li>
</ul>
<a name="getMaximumApplicationLifetime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumApplicationLifetime</h4>
<pre>long&nbsp;getMaximumApplicationLifetime()</pre>
<div class="block">Get the maximum lifetime in seconds of an application which is submitted to
this queue. Apps can set their own lifetime timeout up to this value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>max lifetime in seconds</dd>
</dl>
</li>
</ul>
<a name="getDefaultApplicationLifetime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultApplicationLifetime</h4>
<pre>long&nbsp;getDefaultApplicationLifetime()</pre>
<div class="block">Get the default lifetime in seconds of an application which is submitted to
this queue. If an app doesn't specify its own timeout when submitted, this
value will be used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>default app lifetime</dd>
</dl>
</li>
</ul>
<a name="getDefaultAppLifetimeWasSpecifiedInConfig--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDefaultAppLifetimeWasSpecifiedInConfig</h4>
<pre>boolean&nbsp;getDefaultAppLifetimeWasSpecifiedInConfig()</pre>
<div class="block">Get the indicator of whether or not the default application lifetime was
set by a config property or was calculated by the capacity scheduler.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>indicator whether set or calculated</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CSQueue.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSMaxRunningAppsEnforcer.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CSQueue.html" target="_top">Frames</a></li>
<li><a href="CSQueue.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2022 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>