blob: 3111b464337b71a5c2dc75371c37606d7e7139f3 [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>FairOrderingPolicy (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="FairOrderingPolicy (Apache Hadoop YARN ResourceManager 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/FairOrderingPolicy.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/policy/AbstractComparatorOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.FairComparator.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><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/policy/FairOrderingPolicy.html" target="_top">Frames</a></li>
<li><a href="FairOrderingPolicy.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.policy</div>
<h2 title="Class FairOrderingPolicy" class="title">Class FairOrderingPolicy&lt;S extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.AbstractComparatorOrderingPolicy</a>&lt;S&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.FairOrderingPolicy&lt;S&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">OrderingPolicy</a>&lt;S&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">FairOrderingPolicy&lt;S extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</span>
extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">AbstractComparatorOrderingPolicy</a>&lt;S&gt;</pre>
<div class="block">FairOrderingPolicy comparison goes through following steps.
1.Fairness based comparison. SchedulableEntities with lesser usage would be
preferred when compared to another. If sizedBasedWeight is set to true then
an application with high demand may be prioritized ahead of an application
with less usage. This is to offset the tendency to favor small apps, which
could result in starvation for large apps if many small ones enter and leave
the queue continuously (optional, default false)
2. Compare using job submit time. SchedulableEntities submitted earlier would
be preferred than later.
3. Compare demands. SchedulableEntities without resource demand get lower
priority than ones which have demands.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.FairComparator.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">FairOrderingPolicy.FairComparator</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/policy/FairOrderingPolicy.html#ENABLE_SIZE_BASED_WEIGHT">ENABLE_SIZE_BASED_WEIGHT</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.AbstractComparatorOrderingPolicy">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">AbstractComparatorOrderingPolicy</a></h3>
<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#comparator">comparator</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#entitiesToReorder">entitiesToReorder</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#schedulableEntities">schedulableEntities</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html#FairOrderingPolicy--">FairOrderingPolicy</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/policy/FairOrderingPolicy.html#configure-java.util.Map-">configure</a></span>(<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/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;conf)</code>
<div class="block">Provides configuration information for the policy from the scheduler
configuration.</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/policy/FairOrderingPolicy.html#containerAllocated-S-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">containerAllocated</a></span>(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a>&nbsp;schedulableEntity,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a>&nbsp;r)</code>
<div class="block">Notify the <code>OrderingPolicy</code> that the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a>
has been allocated the given <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer"><code>RMContainer</code></a>, enabling the
<code>OrderingPolicy</code> to take appropriate action.</div>
</td>
</tr>
<tr id="i2" 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/policy/FairOrderingPolicy.html#containerReleased-S-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">containerReleased</a></span>(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a>&nbsp;schedulableEntity,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a>&nbsp;r)</code>
<div class="block">Notify the <code>OrderingPolicy</code> that the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a>
has released the given <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer"><code>RMContainer</code></a>, enabling the
<code>OrderingPolicy</code> to take appropriate action.</div>
</td>
</tr>
<tr id="i3" 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/policy/FairOrderingPolicy.html#demandUpdated-S-">demandUpdated</a></span>(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a>&nbsp;schedulableEntity)</code>
<div class="block">Notify the <code>OrderingPolicy</code> that the demand for the
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a> has been updated, enabling the
<code>OrderingPolicy</code> to reorder the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a> if needed.</div>
</td>
</tr>
<tr id="i4" 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/policy/FairOrderingPolicy.html#getConfigName--">getConfigName</a></span>()</code>
<div class="block">Return configuration name (which will be used to set ordering policy).</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/policy/FairOrderingPolicy.html#getInfo--">getInfo</a></span>()</code>
<div class="block">Return information regarding configuration and status.</div>
</td>
</tr>
<tr id="i6" 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/policy/FairOrderingPolicy.html#getSizeBasedWeight--">getSizeBasedWeight</a></span>()</code>&nbsp;</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/policy/FairOrderingPolicy.html#setSizeBasedWeight-boolean-">setSizeBasedWeight</a></span>(boolean&nbsp;sizeBasedWeight)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.AbstractComparatorOrderingPolicy">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">AbstractComparatorOrderingPolicy</a></h3>
<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#addAllSchedulableEntities-java.util.Collection-">addAllSchedulableEntities</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#addSchedulableEntity-S-">addSchedulableEntity</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#entityRequiresReordering-S-">entityRequiresReordering</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#getAssignmentIterator-org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.IteratorSelector-">getAssignmentIterator</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#getComparator--">getComparator</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#getNumSchedulableEntities--">getNumSchedulableEntities</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#getPreemptionIterator--">getPreemptionIterator</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#getSchedulableEntities--">getSchedulableEntities</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#removeSchedulableEntity-S-">removeSchedulableEntity</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#reorderSchedulableEntity-S-">reorderSchedulableEntity</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#reorderScheduleEntities--">reorderScheduleEntities</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#updateSchedulingResourceUsage-org.apache.hadoop.yarn.server.resourcemanager.scheduler.ResourceUsage-">updateSchedulingResourceUsage</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ENABLE_SIZE_BASED_WEIGHT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ENABLE_SIZE_BASED_WEIGHT</h4>
<pre>public static final&nbsp;<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> ENABLE_SIZE_BASED_WEIGHT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.FairOrderingPolicy.ENABLE_SIZE_BASED_WEIGHT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FairOrderingPolicy--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FairOrderingPolicy</h4>
<pre>public&nbsp;FairOrderingPolicy()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSizeBasedWeight--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSizeBasedWeight</h4>
<pre>public&nbsp;boolean&nbsp;getSizeBasedWeight()</pre>
</li>
</ul>
<a name="setSizeBasedWeight-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSizeBasedWeight</h4>
<pre>public&nbsp;void&nbsp;setSizeBasedWeight(boolean&nbsp;sizeBasedWeight)</pre>
</li>
</ul>
<a name="configure-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre>public&nbsp;void&nbsp;configure(<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/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;conf)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html#configure-java.util.Map-">OrderingPolicy</a></code></span></div>
<div class="block">Provides configuration information for the policy from the scheduler
configuration.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html#configure-java.util.Map-">configure</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">OrderingPolicy</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a> extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#configure-java.util.Map-">configure</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">AbstractComparatorOrderingPolicy</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a> extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - a map of scheduler configuration properties and values</dd>
</dl>
</li>
</ul>
<a name="containerAllocated-org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.SchedulableEntity-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">
<!-- -->
</a><a name="containerAllocated-S-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containerAllocated</h4>
<pre>public&nbsp;void&nbsp;containerAllocated(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a>&nbsp;schedulableEntity,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a>&nbsp;r)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html#containerAllocated-S-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">OrderingPolicy</a></code></span></div>
<div class="block">Notify the <code>OrderingPolicy</code> that the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a>
has been allocated the given <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer"><code>RMContainer</code></a>, enabling the
<code>OrderingPolicy</code> to take appropriate action. Depending on the
comparator, a reordering of the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a> may be required.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html#containerAllocated-S-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">containerAllocated</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">OrderingPolicy</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a> extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#containerAllocated-S-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">containerAllocated</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">AbstractComparatorOrderingPolicy</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a> extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schedulableEntity</code> - the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a></dd>
<dd><code>r</code> - the allocated <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer"><code>RMContainer</code></a></dd>
</dl>
</li>
</ul>
<a name="containerReleased-org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.SchedulableEntity-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">
<!-- -->
</a><a name="containerReleased-S-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containerReleased</h4>
<pre>public&nbsp;void&nbsp;containerReleased(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a>&nbsp;schedulableEntity,
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a>&nbsp;r)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html#containerReleased-S-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">OrderingPolicy</a></code></span></div>
<div class="block">Notify the <code>OrderingPolicy</code> that the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a>
has released the given <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer"><code>RMContainer</code></a>, enabling the
<code>OrderingPolicy</code> to take appropriate action. Depending on the
comparator, a reordering of the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a> may be required.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html#containerReleased-S-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">containerReleased</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">OrderingPolicy</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a> extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#containerReleased-S-org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer-">containerReleased</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">AbstractComparatorOrderingPolicy</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a> extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schedulableEntity</code> - the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a></dd>
<dd><code>r</code> - the released <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer"><code>RMContainer</code></a></dd>
</dl>
</li>
</ul>
<a name="demandUpdated-org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy.SchedulableEntity-">
<!-- -->
</a><a name="demandUpdated-S-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>demandUpdated</h4>
<pre>public&nbsp;void&nbsp;demandUpdated(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a>&nbsp;schedulableEntity)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html#demandUpdated-S-">OrderingPolicy</a></code></span></div>
<div class="block">Notify the <code>OrderingPolicy</code> that the demand for the
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a> has been updated, enabling the
<code>OrderingPolicy</code> to reorder the <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a> if needed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html#demandUpdated-S-">demandUpdated</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">OrderingPolicy</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a> extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#demandUpdated-S-">demandUpdated</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">AbstractComparatorOrderingPolicy</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a> extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schedulableEntity</code> - the updated <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>SchedulableEntity</code></a></dd>
</dl>
</li>
</ul>
<a name="getInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInfo</h4>
<pre>public&nbsp;<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;getInfo()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html#getInfo--">OrderingPolicy</a></code></span></div>
<div class="block">Return information regarding configuration and status.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html#getInfo--">getInfo</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">OrderingPolicy</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a> extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#getInfo--">getInfo</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">AbstractComparatorOrderingPolicy</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a> extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>configuration and status information</dd>
</dl>
</li>
</ul>
<a name="getConfigName--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getConfigName</h4>
<pre>public&nbsp;<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;getConfigName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html#getConfigName--">OrderingPolicy</a></code></span></div>
<div class="block">Return configuration name (which will be used to set ordering policy).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html#getConfigName--">getConfigName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">OrderingPolicy</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a> extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html#getConfigName--">getConfigName</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/AbstractComparatorOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">AbstractComparatorOrderingPolicy</a>&lt;<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="type parameter in FairOrderingPolicy">S</a> extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/SchedulableEntity.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">SchedulableEntity</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>configuration name</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/FairOrderingPolicy.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/policy/AbstractComparatorOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.FairComparator.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><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/policy/FairOrderingPolicy.html" target="_top">Frames</a></li>
<li><a href="FairOrderingPolicy.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>