Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-server / hadoop-yarn-server-resourcemanager / apidocs / org / apache / hadoop / yarn / server / resourcemanager / scheduler / Queue.html
blob: e81e05644190e6470836e0c0caf6a026d7298426 [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_292) on Tue Jun 15 06:12:12 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Queue (Apache Hadoop YARN ResourceManager 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<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="Queue (Apache Hadoop YARN ResourceManager 3.3.1 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};
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/Queue.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/PreemptableResourceScheduler.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueInvalidException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><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/Queue.html" target="_top">Frames</a></li>
<li><a href="Queue.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</div>
<h2 title="Interface Queue" class="title">Interface Queue</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><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>, <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerQueue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerQueue</a>&lt;T&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/fair/FSLeafQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair">FSLeafQueue</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSParentQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair">FSParentQueue</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair">FSQueue</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.Evolving
@InterfaceAudience.LimitedPrivate(value="yarn")
public interface <span class="typeNameLabel">Queue</span></pre>
</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.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="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/Queue.html#decReservedResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">decReservedResource</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;partition,
org.apache.hadoop.yarn.api.records.Resource&nbsp;reservedRes)</code>
<div class="block">Decrement Reserved Capacity</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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/Queue.html#getAbstractUsersManager--">getAbstractUsersManager</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<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/Queue.html#getAccessibleNodeLabels--">getAccessibleNodeLabels</a></span>()</code>
<div class="block">Get labels can be accessed of this queue
labels={*}, means this queue can access any label
labels={ }, means this queue cannot access any label except node without label
labels={a, b, c} means this queue can access a or b or c</div>
</td>
</tr>
<tr id="i4" 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/Queue.html#getDefaultApplicationPriority--">getDefaultApplicationPriority</a></span>()</code>
<div class="block">Get the Default Application Priority for this queue</div>
</td>
</tr>
<tr id="i5" 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/Queue.html#getDefaultNodeLabelExpression--">getDefaultNodeLabelExpression</a></span>()</code>
<div class="block">Get default label expression of this queue.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#getMetrics--">getMetrics</a></span>()</code>
<div class="block">Get the queue metrics</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.QueueInfo</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#getQueueInfo-boolean-boolean-">getQueueInfo</a></span>(boolean&nbsp;includeChildQueues,
boolean&nbsp;recursive)</code>
<div class="block">Get queue information</div>
</td>
</tr>
<tr id="i8" 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/Queue.html#getQueueName--">getQueueName</a></span>()</code>
<div class="block">Get the queue name</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<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;org.apache.hadoop.yarn.api.records.QueueUserACLInfo&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html#getQueueUserAclInfo-org.apache.hadoop.security.UserGroupInformation-">getQueueUserAclInfo</a></span>(org.apache.hadoop.security.UserGroupInformation&nbsp;user)</code>
<div class="block">Get queue ACLs for given <code>user</code>.</div>
</td>
</tr>
<tr id="i10" 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/Queue.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>&nbsp;</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/Queue.html#incPendingResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">incPendingResource</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;resourceToInc)</code>
<div class="block">When new outstanding resource is asked, calling this will increase pending
resource in a queue.</div>
</td>
</tr>
<tr id="i12" 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/Queue.html#incReservedResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">incReservedResource</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;partition,
org.apache.hadoop.yarn.api.records.Resource&nbsp;reservedRes)</code>
<div class="block">Increment Reserved Capacity</div>
</td>
</tr>
<tr id="i13" 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/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></span>(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerApplicationAttempt.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerApplicationAttempt</a>&nbsp;schedulerAttempt,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a>&nbsp;rmContainer)</code>
<div class="block">Recover the state of the queue for a given container.</div>
</td>
</tr>
</table>
</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="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 name</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>queue name</dd>
</dl>
</li>
</ul>
<a name="getMetrics--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetrics</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a>&nbsp;getMetrics()</pre>
<div class="block">Get the queue metrics</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the queue metrics</dd>
</dl>
</li>
</ul>
<a name="getQueueInfo-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueInfo</h4>
<pre>org.apache.hadoop.yarn.api.records.QueueInfo&nbsp;getQueueInfo(boolean&nbsp;includeChildQueues,
boolean&nbsp;recursive)</pre>
<div class="block">Get queue information</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>includeChildQueues</code> - include child queues?</dd>
<dd><code>recursive</code> - recursively get child queue information?</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>queue information</dd>
</dl>
</li>
</ul>
<a name="getQueueUserAclInfo-org.apache.hadoop.security.UserGroupInformation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueUserAclInfo</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;org.apache.hadoop.yarn.api.records.QueueUserACLInfo&gt;&nbsp;getQueueUserAclInfo(org.apache.hadoop.security.UserGroupInformation&nbsp;user)</pre>
<div class="block">Get queue ACLs for given <code>user</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - username</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>queue ACLs for user</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>
</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>
</li>
</ul>
<a name="recoverContainer-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedulerApplicationAttempt-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recoverContainer</h4>
<pre>void&nbsp;recoverContainer(org.apache.hadoop.yarn.api.records.Resource&nbsp;clusterResource,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerApplicationAttempt.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerApplicationAttempt</a>&nbsp;schedulerAttempt,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a>&nbsp;rmContainer)</pre>
<div class="block">Recover the state of the queue for a given container.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clusterResource</code> - the resource of the cluster</dd>
<dd><code>schedulerAttempt</code> - the application for which the container was allocated</dd>
<dd><code>rmContainer</code> - the container that was recovered.</dd>
</dl>
</li>
</ul>
<a name="getAccessibleNodeLabels--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAccessibleNodeLabels</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;getAccessibleNodeLabels()</pre>
<div class="block">Get labels can be accessed of this queue
labels={*}, means this queue can access any label
labels={ }, means this queue cannot access any label except node without label
labels={a, b, c} means this queue can access a or b or c</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>labels</dd>
</dl>
</li>
</ul>
<a name="getDefaultNodeLabelExpression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultNodeLabelExpression</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;getDefaultNodeLabelExpression()</pre>
<div class="block">Get default label expression of this queue. If label expression of
ApplicationSubmissionContext and label expression of Resource Request not
set, this will be used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>default label expression</dd>
</dl>
</li>
</ul>
<a name="incPendingResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incPendingResource</h4>
<pre>void&nbsp;incPendingResource(<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;resourceToInc)</pre>
<div class="block">When new outstanding resource is asked, calling this will increase pending
resource in a queue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeLabel</code> - asked by application</dd>
<dd><code>resourceToInc</code> - new resource asked</dd>
</dl>
</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="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="getDefaultApplicationPriority--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultApplicationPriority</h4>
<pre>org.apache.hadoop.yarn.api.records.Priority&nbsp;getDefaultApplicationPriority()</pre>
<div class="block">Get the Default Application Priority for this queue</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>default application priority</dd>
</dl>
</li>
</ul>
<a name="incReservedResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incReservedResource</h4>
<pre>void&nbsp;incReservedResource(<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;partition,
org.apache.hadoop.yarn.api.records.Resource&nbsp;reservedRes)</pre>
<div class="block">Increment Reserved Capacity</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>partition</code> - asked by application</dd>
<dd><code>reservedRes</code> - reserved resource asked</dd>
</dl>
</li>
</ul>
<a name="decReservedResource-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>decReservedResource</h4>
<pre>void&nbsp;decReservedResource(<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;partition,
org.apache.hadoop.yarn.api.records.Resource&nbsp;reservedRes)</pre>
<div class="block">Decrement Reserved Capacity</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>partition</code> - asked by application</dd>
<dd><code>reservedRes</code> - reserved resource asked</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/Queue.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/PreemptableResourceScheduler.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueInvalidException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><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/Queue.html" target="_top">Frames</a></li>
<li><a href="Queue.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;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>