blob: 60879cb43f877feca57ed1a634924248400f3ab9 [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 (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 (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>Prev&nbsp;Package</li>
<li><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ahs/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/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</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/ClusterMonitor.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">ClusterMonitor</a></td>
<td class="colLast">
<div class="block">Implementations of this class are notified of changes to the cluster's state,
such as node addition, removal and updates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/EmbeddedElector.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">EmbeddedElector</a></td>
<td class="colLast">
<div class="block">Interface that all embedded leader electors must implement.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/NodesListManager.Resolver.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">NodesListManager.Resolver</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ResourceManagerMXBean.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">ResourceManagerMXBean</a></td>
<td class="colLast">
<div class="block">This is the JMX management interface for ResourceManager.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMContext</a></td>
<td class="colLast">
<div class="block">Context of the ResourceManager.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMInfoMXBean.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMInfoMXBean</a></td>
<td class="colLast">
<div class="block">Interface for RMInfo class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMNMInfoBeans.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMNMInfoBeans</a></td>
<td class="colLast">&nbsp;</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/ActiveStandbyElectorBasedElectorService.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">ActiveStandbyElectorBasedElectorService</a></td>
<td class="colLast">
<div class="block">Leader election implementation that uses <code>ActiveStandbyElector</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/AdminService.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">AdminService</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ApplicationMasterService.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">ApplicationMasterService</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ApplicationMasterService.AllocateResponseLock.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">ApplicationMasterService.AllocateResponseLock</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ClientRMService.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">ClientRMService</a></td>
<td class="colLast">
<div class="block">The client interface to the Resource Manager.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ClusterMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">ClusterMetrics</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/CuratorBasedElectorService.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">CuratorBasedElectorService</a></td>
<td class="colLast">
<div class="block">Leader election implementation that uses Curator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/DBManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">DBManager</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/DecommissioningNodesWatcher.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">DecommissioningNodesWatcher</a></td>
<td class="colLast">
<div class="block">DecommissioningNodesWatcher is used by ResourceTrackerService to track
DECOMMISSIONING nodes to decide when, after all running containers on
the node have completed, will be transitioned into DECOMMISSIONED state
(NodeManager will be told to shutdown).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/GenericEventTypeMetricsManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">GenericEventTypeMetricsManager</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/IsResourceManagerActiveServlet.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">IsResourceManagerActiveServlet</a></td>
<td class="colLast">
<div class="block">Used by Load Balancers to find the active ResourceManager.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/NMLivelinessMonitor.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">NMLivelinessMonitor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/NodesListManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">NodesListManager</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/NodesListManager.CachedResolver.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">NodesListManager.CachedResolver</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/NodesListManager.DirectResolver.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">NodesListManager.DirectResolver</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/NodesListManagerEvent.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">NodesListManagerEvent</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/OpportunisticContainerAllocatorAMService.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">OpportunisticContainerAllocatorAMService</a></td>
<td class="colLast">
<div class="block">The OpportunisticContainerAllocatorAMService is started instead of the
ApplicationMasterService if opportunistic scheduling is enabled for the YARN
cluster (either centralized or distributed opportunistic scheduling).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ResourceManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">ResourceManager</a></td>
<td class="colLast">
<div class="block">The ResourceManager is the main class that is a set of components.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ResourceManager.ApplicationAttemptEventDispatcher.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">ResourceManager.ApplicationAttemptEventDispatcher</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ResourceManager.ApplicationEventDispatcher.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">ResourceManager.ApplicationEventDispatcher</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ResourceManager.NodeEventDispatcher.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">ResourceManager.NodeEventDispatcher</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ResourceTrackerService.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">ResourceTrackerService</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMActiveServiceContext.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMActiveServiceContext</a></td>
<td class="colLast">
<div class="block">The RMActiveServiceContext is the class that maintains <b>Active</b> service
context.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMAppManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMAppManager</a></td>
<td class="colLast">
<div class="block">This class manages the list of applications for the resource manager.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMAppManagerEvent.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMAppManagerEvent</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMAuditLogger.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMAuditLogger</a></td>
<td class="colLast">
<div class="block">Manages ResourceManager audit logs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMAuditLogger.ArgsBuilder.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMAuditLogger.ArgsBuilder</a></td>
<td class="colLast">
<div class="block">Builder to create and pass a list of arbitrary key value pairs for logging.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMAuditLogger.AuditConstants.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMAuditLogger.AuditConstants</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMContextImpl.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMContextImpl</a></td>
<td class="colLast">
<div class="block">RMContextImpl class holds two services context.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMCriticalThreadUncaughtExceptionHandler.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMCriticalThreadUncaughtExceptionHandler</a></td>
<td class="colLast">
<div class="block">This class either shuts down <a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ResourceManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager"><code>ResourceManager</code></a> or transitions the
<a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ResourceManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager"><code>ResourceManager</code></a> to standby state if a critical thread throws an
uncaught exception.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMFatalEvent.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMFatalEvent</a></td>
<td class="colLast">
<div class="block">Event that indicates a non-recoverable error for the resource manager.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMInfo</a></td>
<td class="colLast">
<div class="block">JMX bean for RM info.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMNMInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMNMInfo</a></td>
<td class="colLast">
<div class="block">JMX bean listing statuses of all node managers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMSecretManagerService.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMSecretManagerService</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMServerUtils.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMServerUtils</a></td>
<td class="colLast">
<div class="block">Utility methods to aid serving RM data through the REST and RPC APIs</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMServiceContext.html" title="class in org.apache.hadoop.yarn.server.resourcemanager">RMServiceContext</a></td>
<td class="colLast">
<div class="block">RMServiceContext class maintains "Always On" services.</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/DecommissioningNodesWatcher.DecommissioningNodeStatus.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager">DecommissioningNodesWatcher.DecommissioningNodeStatus</a></td>
<td class="colLast">
<div class="block">Status about a specific decommissioning node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/NodesListManagerEventType.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager">NodesListManagerEventType</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMAppManagerEventType.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager">RMAppManagerEventType</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMFatalEventType.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager">RMFatalEventType</a></td>
<td class="colLast">&nbsp;</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>Prev&nbsp;Package</li>
<li><a href="../../../../../../org/apache/hadoop/yarn/server/resourcemanager/ahs/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/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>