Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-server / hadoop-yarn-server-resourcemanager / apidocs / org / apache / hadoop / yarn / server / resourcemanager / webapp / package-summary.html
blob: 9110084383ff6d17f3124bbc232b9c6f01dbb698 [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.webapp (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.webapp (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/volume/csi/provisioner/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/webapp/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.webapp</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/webapp/RMWebServiceProtocol.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMWebServiceProtocol</a></td>
<td class="colLast">
<div class="block">
The protocol between clients and the <code>ResourceManager</code> to
submit/abort jobs and to get information on applications, cluster metrics,
nodes, queues, ACLs and reservations via REST calls.</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/webapp/AboutBlock.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">AboutBlock</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/AboutPage.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">AboutPage</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/AppAttemptPage.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">AppAttemptPage</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/ApplicationsRequestBuilder.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">ApplicationsRequestBuilder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/AppLogAggregationStatusPage.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">AppLogAggregationStatusPage</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/AppPage.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">AppPage</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/ColumnHeader.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">ColumnHeader</a></td>
<td class="colLast">
<div class="block">Header for a Web UI column.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/ContainerPage.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">ContainerPage</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/DeSelectFields.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">DeSelectFields</a></td>
<td class="colLast">
<div class="block">DeSelectFields make the <code>/apps</code> api more flexible.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/ErrorBlock.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">ErrorBlock</a></td>
<td class="colLast">
<div class="block">This class is used to display an error message to the user in the UI.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/FairSchedulerAppsBlock.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">FairSchedulerAppsBlock</a></td>
<td class="colLast">
<div class="block">Shows application information specific to the fair
scheduler as part of the fair scheduler page.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/FairSchedulerPage.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">FairSchedulerPage</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/JAXBContextResolver.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">JAXBContextResolver</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/MetricsOverviewTable.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">MetricsOverviewTable</a></td>
<td class="colLast">
<div class="block">Provides an table with an overview of many cluster wide metrics and if
per user metrics are enabled it will show an overview of what the
current user is using on the cluster.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/NavBlock.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">NavBlock</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/NodeIDsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">NodeIDsInfo</a></td>
<td class="colLast">
<div class="block">XML element uses to represent NodeIds' list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/NodeLabelsPage.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">NodeLabelsPage</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RedirectionErrorPage.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RedirectionErrorPage</a></td>
<td class="colLast">
<div class="block">This class is used to display a message that the proxy request failed
because of a redirection issue.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMAppAttemptBlock.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMAppAttemptBlock</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMAppBlock.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMAppBlock</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMAppLogAggregationStatusBlock.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMAppLogAggregationStatusBlock</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMAppsBlock.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMAppsBlock</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMContainerBlock.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMContainerBlock</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RmController.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RmController</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMErrorsAndWarningsPage.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMErrorsAndWarningsPage</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RmView.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RmView</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebApp.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMWebApp</a></td>
<td class="colLast">
<div class="block">The RM webapp</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebAppFilter.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMWebAppFilter</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebAppUtil.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMWebAppUtil</a></td>
<td class="colLast">
<div class="block">Util class for ResourceManager WebApp.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServices.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMWebServices</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMWSConsts</a></td>
<td class="colLast">
<div class="block">Constants for <code>RMWebServiceProtocol</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/SchedulerPageUtil.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">SchedulerPageUtil</a></td>
<td class="colLast">&nbsp;</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/webapp/DeSelectFields.DeSelectType.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.webapp">DeSelectFields.DeSelectType</a></td>
<td class="colLast">
<div class="block">Deselect field type, can be boost in future.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.ActivitiesGroupBy.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMWSConsts.ActivitiesGroupBy</a></td>
<td class="colLast">
<div class="block">Defines the groupBy types of activities, currently only support
DIAGNOSTIC with which user can query aggregated activities
grouped by allocation state and diagnostic.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.AppActivitiesRequiredAction.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMWSConsts.AppActivitiesRequiredAction</a></td>
<td class="colLast">
<div class="block">Defines the required action of app activities:
REFRESH means to turn on activities recording for the required app,
GET means the required app activities should be involved in response.</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/volume/csi/provisioner/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/webapp/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>