blob: f1c85f7be00f3f9df311ddd6fe2d7b3dd07a4ad3 [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.monitor.capacity (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.monitor.capacity (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/monitor/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/invariants/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/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.monitor.capacity</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/monitor/capacity/CapacitySchedulerPreemptionContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">CapacitySchedulerPreemptionContext</a></td>
<td class="colLast">
<div class="block">This interface provides context for the calculation of ideal allocation
and preemption for the <code>CapacityScheduler</code>.</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/monitor/capacity/AbstractPreemptableResourceCalculator.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">AbstractPreemptableResourceCalculator</a></td>
<td class="colLast">
<div class="block">Calculate how much resources need to be preempted for each queue,
will be used by <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/PreemptionCandidatesSelector.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity"><code>PreemptionCandidatesSelector</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/AbstractPreemptionEntity.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">AbstractPreemptionEntity</a></td>
<td class="colLast">
<div class="block">Abstract temporary data-structure for tracking resource availability,pending
resource need, current utilization for app/queue.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/CapacitySchedulerPreemptionUtils.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">CapacitySchedulerPreemptionUtils</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/FifoCandidatesSelector.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">FifoCandidatesSelector</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/FifoIntraQueuePreemptionPlugin.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">FifoIntraQueuePreemptionPlugin</a></td>
<td class="colLast">
<div class="block">FifoIntraQueuePreemptionPlugin will handle intra-queue preemption for
priority and user-limit.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/IntraQueueCandidatesSelector.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">IntraQueueCandidatesSelector</a></td>
<td class="colLast">
<div class="block">Identifies over utilized resources within a queue and tries to normalize
them to resolve resource allocation anomalies w.r.t priority and user-limit.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/PreemptableResourceCalculator.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">PreemptableResourceCalculator</a></td>
<td class="colLast">
<div class="block">Calculate how much resources need to be preempted for each queue,
will be used by <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/PreemptionCandidatesSelector.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity"><code>PreemptionCandidatesSelector</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/PreemptionCandidatesSelector.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">PreemptionCandidatesSelector</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/ProportionalCapacityPreemptionPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">ProportionalCapacityPreemptionPolicy</a></td>
<td class="colLast">
<div class="block">This class implement a <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/SchedulingEditPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.monitor"><code>SchedulingEditPolicy</code></a> that is designed to be
paired with the <code>CapacityScheduler</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/QueuePriorityContainerCandidateSelector.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">QueuePriorityContainerCandidateSelector</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/ReservedContainerCandidatesSelector.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">ReservedContainerCandidatesSelector</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/TempAppPerPartition.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">TempAppPerPartition</a></td>
<td class="colLast">
<div class="block">Temporary data-structure tracking resource availability, pending resource
need, current utilization for an application.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/TempQueuePerPartition.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">TempQueuePerPartition</a></td>
<td class="colLast">
<div class="block">Temporary data-structure tracking resource availability, pending resource
need, current utilization.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/TempSchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">TempSchedulerNode</a></td>
<td class="colLast">
<div class="block">This class will save necessary information which copied from
FiCaSchedulerNode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/TempUserPerPartition.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">TempUserPerPartition</a></td>
<td class="colLast">
<div class="block">Temporary data-structure tracking resource availability, pending resource
need, current utilization for an application.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/ProportionalCapacityPreemptionPolicy.IntraQueuePreemptionOrderPolicy.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity">ProportionalCapacityPreemptionPolicy.IntraQueuePreemptionOrderPolicy</a></td>
<td class="colLast">
<div class="block">IntraQueuePreemptionOrder will be used to define various priority orders
which could be configured by admin.</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/monitor/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/monitor/invariants/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/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>