blob: 8273f888e3241505acdc356404d6a4b15d030a1a [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:14 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Overview (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="Overview (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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-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 class="title">Apache Hadoop YARN ResourceManager 3.3.1 API</h1>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation">
<caption><span>Packages</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/ahs/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.ahs</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/amlauncher/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.amlauncher</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/blacklist/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.blacklist</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/federation/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.federation</a></td>
<td class="colLast">
<div class="block">Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/metrics/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.metrics</a></td>
<td class="colLast">
<div class="block">Package org.apache.hadoop.yarn.server.resourcemanager.metrics contains
classes related to publishing app/container events to ATS.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/monitor/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.monitor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/monitor/capacity/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.monitor.capacity</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/monitor/invariants/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.monitor.invariants</a></td>
<td class="colLast">
<div class="block">Monitoring policies, used to check invariants.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/nodelabels/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.nodelabels</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/placement/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.placement</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/preprocessor/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.preprocessor</a></td>
<td class="colLast">
<div class="block">This package contains classes to pre process the application submission
context with server side configs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/recovery/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.recovery</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/recovery/records/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.recovery.records</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/recovery/records/impl/pb/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.recovery.records.impl.pb</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/reservation/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.reservation</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/reservation/exceptions/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.reservation.exceptions</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.reservation.planning</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/resource/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.resource</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/rmapp/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.rmapp</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/event/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt.event</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/rmapp/monitor/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.rmapp.monitor</a></td>
<td class="colLast">
<div class="block">Package org.apache.hadoop.yarn.server.resourcemanager.rmapp.monitor contains
classes related to application monitor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.rmcontainer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/rmnode/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.rmnode</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/activities/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.activities</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/allocator/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.allocator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf</a></td>
<td class="colLast">
<div class="block">Package
org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf
contains classes related to capacity scheduler configuration management.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/policy/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.policy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/preemption/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.preemption</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/queuemanagement/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.queuemanagement</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.common</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/fica/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.fica</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint</a></td>
<td class="colLast">
<div class="block">Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.placement
contains classes related to scheduling containers using placement
constraints.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/algorithm/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.algorithm</a></td>
<td class="colLast">
<div class="block">Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.placement
contains classes related to scheduling containers using placement
constraints.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/algorithm/iterators/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.algorithm.iterators</a></td>
<td class="colLast">
<div class="block">Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.placement
contains classes related to scheduling containers using placement
constraints.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/api/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.api</a></td>
<td class="colLast">
<div class="block">This Package contains classes related to constrained placement of
Requests.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/processor/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.processor</a></td>
<td class="colLast">
<div class="block">Package o.a.h.yarn.server.resourcemanager.scheduler.constraint.processor
contains classes related to scheduling containers using placement
processor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/distributed/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.distributed</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/event/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.event</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/allocation/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair.allocation</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/converter/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair.converter</a></td>
<td class="colLast">
<div class="block">This package contains classes related to the Fair Scheduler -&gt;
Capacity Scheduler conversion.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/policies/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair.policies</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/fifo/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.fifo</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/placement/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.placement</a></td>
<td class="colLast">
<div class="block">Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.placement
contains classes related to application monitor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/scheduler/policy/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.scheduler.policy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/security/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.security</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/security/authorize/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.security.authorize</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/timelineservice/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.timelineservice</a></td>
<td class="colLast">
<div class="block">Package org.apache.hadoop.yarn.server.resourcemanager.timelineservice
contains classes related to handling of app level collectors.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/volume/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.volume</a></td>
<td class="colLast">
<div class="block">This package contains classes to manage storage volumes in YARN.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/volume/csi/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.volume.csi</a></td>
<td class="colLast">
<div class="block">This package contains classes to manage CSI volumes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/volume/csi/event/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.volume.csi.event</a></td>
<td class="colLast">
<div class="block">This package contains volume related events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/volume/csi/lifecycle/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.volume.csi.lifecycle</a></td>
<td class="colLast">
<div class="block">This package contains classes to manage volume lifecycle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/volume/csi/processor/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.volume.csi.processor</a></td>
<td class="colLast">
<div class="block">This package contains AMS processor class for volume handling.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/volume/csi/provisioner/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.volume.csi.provisioner</a></td>
<td class="colLast">
<div class="block">This package contains the volume provisioning classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/webapp/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.webapp</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/package-summary.html">org.apache.hadoop.yarn.server.resourcemanager.webapp.dao</a></td>
<td class="colLast">
<div class="block">This package contains the web data access objects (DAO) for the RM.</div>
</td>
</tr>
</tbody>
</table>
</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 class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-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>