blob: 0638b98fca986a294e0e2003327d295728099942 [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:13 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy (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="org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy (Apache Hadoop YARN ResourceManager 3.3.1 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/placement/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/security/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><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 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;</td>
<td class="colLast">
<div class="block">OrderingPolicy is used by the scheduler to order SchedulableEntities for
container assignment and preemption.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">A SchedulableEntity is a process to be scheduled.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><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 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;</td>
<td class="colLast">
<div class="block">An OrderingPolicy which can serve as a baseclass for policies which can be
expressed in terms of comparators</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FairOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">FairOrderingPolicy</a>&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;</td>
<td class="colLast">
<div class="block">FairOrderingPolicy comparison goes through following steps.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FifoComparator.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">FifoComparator</a></td>
<td class="colLast">
<div class="block">A Comparator which orders SchedulableEntities by input order</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FifoOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">FifoOrderingPolicy</a>&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;</td>
<td class="colLast">
<div class="block">An OrderingPolicy which orders SchedulableEntities by input order</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FifoOrderingPolicyForPendingApps.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">FifoOrderingPolicyForPendingApps</a>&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;</td>
<td class="colLast">
<div class="block">This ordering policy is used for pending applications only.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FifoOrderingPolicyWithExclusivePartitions.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">FifoOrderingPolicyWithExclusivePartitions</a>&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;</td>
<td class="colLast">
<div class="block">Similar to <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/FifoOrderingPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>FifoOrderingPolicy</code></a>, but with separate ordering policies
for each partition in
<code>yarn.scheduler.capacity.&lt;queue-path&gt;.ordering-policy.exclusive-enforced-partitions</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/IteratorSelector.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">IteratorSelector</a></td>
<td class="colLast">
<div class="block">IteratorSelector contains information needed to tell an
<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/OrderingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy"><code>OrderingPolicy</code></a> what to return in an iterator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/PriorityComparator.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">PriorityComparator</a></td>
<td class="colLast">
<div class="block">A Comparator which orders SchedulableEntities by priority.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/RecoveryComparator.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy">RecoveryComparator</a></td>
<td class="colLast">
<div class="block">A Comparator which orders SchedulableEntities by isRecovering flag.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/placement/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/security/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>