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 / RMWebServiceProtocol.html
blob: fe806398f73b94e45fb5193d6bde58f0e952ad3e [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:11 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RMWebServiceProtocol (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="RMWebServiceProtocol (Apache Hadoop YARN ResourceManager 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RMWebServiceProtocol.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/webapp/RMWebAppUtil.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServices.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html" target="_top">Frames</a></li>
<li><a href="RMWebServiceProtocol.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.yarn.server.resourcemanager.webapp</div>
<h2 title="Interface RMWebServiceProtocol" class="title">Interface RMWebServiceProtocol</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServices.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp">RMWebServices</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Private
@InterfaceStability.Evolving
public interface <span class="typeNameLabel">RMWebServiceProtocol</span></pre>
<div class="block"><p>
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.
</p>
The WebService is reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#RM_WEB_SERVICE_PATH"><code>RMWSConsts.RM_WEB_SERVICE_PATH</code></a></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#addToClusterNodeLabels-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeLabelsInfo-javax.servlet.http.HttpServletRequest-">addToClusterNodeLabels</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodeLabelsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodeLabelsInfo</a>&nbsp;newNodeLabels,
javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">This method adds specific node labels for specific nodes, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#ADD_NODE_LABELS"><code>RMWSConsts.ADD_NODE_LABELS</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#cancelDelegationToken-javax.servlet.http.HttpServletRequest-">cancelDelegationToken</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">This method cancel the delegation token from the client, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#DELEGATION_TOKEN"><code>RMWSConsts.DELEGATION_TOKEN</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/RMQueueAclInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">RMQueueAclInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#checkUserAccessToQueue-java.lang.String-java.lang.String-java.lang.String-javax.servlet.http.HttpServletRequest-">checkUserAccessToQueue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queue,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queueAclType,
javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">This method verifies if an user has access to a specified queue.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#createNewApplication-javax.servlet.http.HttpServletRequest-">createNewApplication</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">Generates a new ApplicationId which is then sent to the client.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#createNewReservation-javax.servlet.http.HttpServletRequest-">createNewReservation</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">Generates a new ReservationId which is then sent to the client.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#deleteReservation-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ReservationDeleteRequestInfo-javax.servlet.http.HttpServletRequest-">deleteReservation</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ReservationDeleteRequestInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ReservationDeleteRequestInfo</a>&nbsp;resContext,
javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">Function to delete a Reservation to the RM.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#dumpSchedulerLogs-java.lang.String-javax.servlet.http.HttpServletRequest-">dumpSchedulerLogs</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;time,
javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">This method dumps the scheduler logs for the time got in input, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#SCHEDULER_LOGS"><code>RMWSConsts.SCHEDULER_LOGS</code></a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ClusterInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ClusterInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#get--">get</a></span>()</code>
<div class="block">This method retrieves the cluster information, and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#INFO"><code>RMWSConsts.INFO</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ActivitiesInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ActivitiesInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getActivities-javax.servlet.http.HttpServletRequest-java.lang.String-java.lang.String-">getActivities</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;groupBy)</code>
<div class="block">This method retrieve all the activities in a specific node, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#SCHEDULER_ACTIVITIES"><code>RMWSConsts.SCHEDULER_ACTIVITIES</code></a>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getApp-javax.servlet.http.HttpServletRequest-java.lang.String-java.util.Set-">getApp</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;unselectedFields)</code>
<div class="block">This method retrieves the report for a specific app, and it is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID"><code>RMWSConsts.APPS_APPID</code></a>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppActivitiesInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppActivitiesInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getAppActivities-javax.servlet.http.HttpServletRequest-java.lang.String-java.lang.String-java.util.Set-java.util.Set-java.lang.String-java.lang.String-java.util.Set-boolean-">getAppActivities</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;time,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;requestPriorities,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;allocationRequestIds,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;groupBy,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;limit,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;actions,
boolean&nbsp;summarize)</code>
<div class="block">This method retrieves all the activities for a specific app for a specific
period of time, and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#SCHEDULER_APP_ACTIVITIES"><code>RMWSConsts.SCHEDULER_APP_ACTIVITIES</code></a>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppAttemptsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppAttemptsInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getAppAttempts-javax.servlet.http.HttpServletRequest-java.lang.String-">getAppAttempts</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)</code>
<div class="block">This method retrieves all the attempts information for a specific app, and
it is reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_APPATTEMPTS"><code>RMWSConsts.APPS_APPID_APPATTEMPTS</code></a>.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppPriority.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppPriority</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getAppPriority-javax.servlet.http.HttpServletRequest-java.lang.String-">getAppPriority</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)</code>
<div class="block">This method retrieves the priority for a specific app, and it is reachable
by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_PRIORITY"><code>RMWSConsts.APPS_APPID_PRIORITY</code></a>.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppQueue</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getAppQueue-javax.servlet.http.HttpServletRequest-java.lang.String-">getAppQueue</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)</code>
<div class="block">This method retrieves the queue for a specific app, and it is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_QUEUE"><code>RMWSConsts.APPS_APPID_QUEUE</code></a>.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppsInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getApps-javax.servlet.http.HttpServletRequest-java.lang.String-java.util.Set-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.util.Set-java.util.Set-java.lang.String-java.util.Set-">getApps</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stateQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;statesQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;finalStatusQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queueQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;count,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;startedBegin,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;startedEnd,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;finishBegin,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;finishEnd,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;applicationTypes,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;applicationTags,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;unselectedFields)</code>
<div class="block">This method retrieves all the app reports in the cluster, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS"><code>RMWSConsts.APPS</code></a>.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppState.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getAppState-javax.servlet.http.HttpServletRequest-java.lang.String-">getAppState</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)</code>
<div class="block">This method retrieves the state for a specific app, and it is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_STATE"><code>RMWSConsts.APPS_APPID_STATE</code></a>.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ApplicationStatisticsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ApplicationStatisticsInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getAppStatistics-javax.servlet.http.HttpServletRequest-java.util.Set-java.util.Set-">getAppStatistics</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;stateQueries,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;typeQueries)</code>
<div class="block">This method retrieves all the statistics for a specific app, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APP_STATISTICS"><code>RMWSConsts.APP_STATISTICS</code></a>.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppTimeoutInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppTimeoutInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getAppTimeout-javax.servlet.http.HttpServletRequest-java.lang.String-java.lang.String-">getAppTimeout</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type)</code>
<div class="block">This method retrieves the timeout information for a specific app with a
specific type, and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_TIMEOUTS_TYPE"><code>RMWSConsts.APPS_TIMEOUTS_TYPE</code></a>.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppTimeoutsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppTimeoutsInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getAppTimeouts-javax.servlet.http.HttpServletRequest-java.lang.String-">getAppTimeouts</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)</code>
<div class="block">This method retrieves the timeout information for a specific app, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_TIMEOUTS"><code>RMWSConsts.APPS_TIMEOUTS</code></a>.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ClusterInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ClusterInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getClusterInfo--">getClusterInfo</a></span>()</code>
<div class="block">This method retrieves the cluster information, and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#INFO"><code>RMWSConsts.INFO</code></a>.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ClusterMetricsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ClusterMetricsInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getClusterMetricsInfo--">getClusterMetricsInfo</a></span>()</code>
<div class="block">This method retrieves the cluster metrics information, and it is reachable
by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#METRICS"><code>RMWSConsts.METRICS</code></a>.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodeLabelsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodeLabelsInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getClusterNodeLabels-javax.servlet.http.HttpServletRequest-">getClusterNodeLabels</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">This method retrieves all the node labels in the cluster, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#GET_NODE_LABELS"><code>RMWSConsts.GET_NODE_LABELS</code></a>.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ClusterUserInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ClusterUserInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getClusterUserInfo-javax.servlet.http.HttpServletRequest-">getClusterUserInfo</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">This method retrieves the cluster user information, and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#CLUSTER_USER_INFO"><code>RMWSConsts.CLUSTER_USER_INFO</code></a>.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodeLabelsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodeLabelsInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getLabelsOnNode-javax.servlet.http.HttpServletRequest-java.lang.String-">getLabelsOnNode</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeId)</code>
<div class="block">This method retrieves all the node labels for specific node, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#NODES_NODEID_GETLABELS"><code>RMWSConsts.NODES_NODEID_GETLABELS</code></a>.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/LabelsToNodesInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">LabelsToNodesInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getLabelsToNodes-java.util.Set-">getLabelsToNodes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;labels)</code>
<div class="block">This method retrieves all the node within multiple node labels in the
cluster, and it is reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#LABEL_MAPPINGS"><code>RMWSConsts.LABEL_MAPPINGS</code></a>.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodeInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodeInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getNode-java.lang.String-">getNode</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeId)</code>
<div class="block">This method retrieves a specific node information, and it is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#NODES_NODEID"><code>RMWSConsts.NODES_NODEID</code></a>.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodesInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodesInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getNodes-java.lang.String-">getNodes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;states)</code>
<div class="block">This method retrieves all the nodes information in the cluster, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#NODES"><code>RMWSConsts.NODES</code></a>.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodeToLabelsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodeToLabelsInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getNodeToLabels-javax.servlet.http.HttpServletRequest-">getNodeToLabels</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">This method retrieves all the node labels with the respective nodes in the
cluster, and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#GET_NODE_TO_LABELS"><code>RMWSConsts.GET_NODE_TO_LABELS</code></a>.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/SchedulerTypeInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">SchedulerTypeInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#getSchedulerInfo--">getSchedulerInfo</a></span>()</code>
<div class="block">This method retrieves the current scheduler status, and it is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#SCHEDULER"><code>RMWSConsts.SCHEDULER</code></a>.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#listReservation-java.lang.String-java.lang.String-long-long-boolean-javax.servlet.http.HttpServletRequest-">listReservation</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queue,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;reservationId,
long&nbsp;startTime,
long&nbsp;endTime,
boolean&nbsp;includeResourceAllocations,
javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">Function to retrieve a list of all the reservations.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#postDelegationToken-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.DelegationToken-javax.servlet.http.HttpServletRequest-">postDelegationToken</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/DelegationToken.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">DelegationToken</a>&nbsp;tokenData,
javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">This method posts a delegation token from the client, and it is reachable
by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#DELEGATION_TOKEN"><code>RMWSConsts.DELEGATION_TOKEN</code></a>.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#postDelegationTokenExpiration-javax.servlet.http.HttpServletRequest-">postDelegationTokenExpiration</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">This method updates the expiration for a delegation token from the client,
and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#DELEGATION_TOKEN_EXPIRATION"><code>RMWSConsts.DELEGATION_TOKEN_EXPIRATION</code></a>.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#removeFromCluserNodeLabels-java.util.Set-javax.servlet.http.HttpServletRequest-">removeFromCluserNodeLabels</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;oldNodeLabels,
javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">This method removes all the node labels for specific nodes, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#REMOVE_NODE_LABELS"><code>RMWSConsts.REMOVE_NODE_LABELS</code></a>.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#replaceLabelsOnNode-java.util.Set-javax.servlet.http.HttpServletRequest-java.lang.String-">replaceLabelsOnNode</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;newNodeLabelsName,
javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeId)</code>
<div class="block">This method replaces all the node labels for specific node, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#NODES_NODEID_REPLACE_LABELS"><code>RMWSConsts.NODES_NODEID_REPLACE_LABELS</code></a>.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#replaceLabelsOnNodes-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeToLabelsEntryList-javax.servlet.http.HttpServletRequest-">replaceLabelsOnNodes</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodeToLabelsEntryList.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodeToLabelsEntryList</a>&nbsp;newNodeToLabels,
javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">This method replaces all the node labels for specific nodes, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#REPLACE_NODE_TO_LABELS"><code>RMWSConsts.REPLACE_NODE_TO_LABELS</code></a>.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#signalToContainer-java.lang.String-java.lang.String-javax.servlet.http.HttpServletRequest-">signalToContainer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;containerId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;command,
javax.servlet.http.HttpServletRequest&nbsp;req)</code>
<div class="block">This method sends a signal to container.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#submitApplication-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ApplicationSubmissionContextInfo-javax.servlet.http.HttpServletRequest-">submitApplication</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ApplicationSubmissionContextInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ApplicationSubmissionContextInfo</a>&nbsp;newApp,
javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">Function to submit an app to the RM.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#submitReservation-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ReservationSubmissionRequestInfo-javax.servlet.http.HttpServletRequest-">submitReservation</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ReservationSubmissionRequestInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ReservationSubmissionRequestInfo</a>&nbsp;resContext,
javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">Function to submit a Reservation to the RM.This method is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#RESERVATION_SUBMIT"><code>RMWSConsts.RESERVATION_SUBMIT</code></a>.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#updateApplicationPriority-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.AppPriority-javax.servlet.http.HttpServletRequest-java.lang.String-">updateApplicationPriority</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppPriority.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppPriority</a>&nbsp;targetPriority,
javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)</code>
<div class="block">This method updates the priority for a specific application, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_PRIORITY"><code>RMWSConsts.APPS_APPID_PRIORITY</code></a>.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#updateApplicationTimeout-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.AppTimeoutInfo-javax.servlet.http.HttpServletRequest-java.lang.String-">updateApplicationTimeout</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppTimeoutInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppTimeoutInfo</a>&nbsp;appTimeout,
javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)</code>
<div class="block">This method updates the timeout information for a specific app, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_TIMEOUT"><code>RMWSConsts.APPS_TIMEOUT</code></a>.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#updateAppQueue-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.AppQueue-javax.servlet.http.HttpServletRequest-java.lang.String-">updateAppQueue</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppQueue</a>&nbsp;targetQueue,
javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)</code>
<div class="block">This method updates the queue for a specific application, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_QUEUE"><code>RMWSConsts.APPS_APPID_QUEUE</code></a>.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#updateAppState-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.AppState-javax.servlet.http.HttpServletRequest-java.lang.String-">updateAppState</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppState.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppState</a>&nbsp;targetState,
javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)</code>
<div class="block">This method updates the state of the app in input, and it is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_STATE"><code>RMWSConsts.APPS_APPID_STATE</code></a>.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ResourceInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ResourceInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#updateNodeResource-javax.servlet.http.HttpServletRequest-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ResourceOptionInfo-">updateNodeResource</a></span>(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeId,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ResourceOptionInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ResourceOptionInfo</a>&nbsp;resourceOption)</code>
<div class="block">This method changes the resources of a specific node, and it is reachable
by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#NODE_RESOURCE"><code>RMWSConsts.NODE_RESOURCE</code></a>.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html#updateReservation-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ReservationUpdateRequestInfo-javax.servlet.http.HttpServletRequest-">updateReservation</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ReservationUpdateRequestInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ReservationUpdateRequestInfo</a>&nbsp;resContext,
javax.servlet.http.HttpServletRequest&nbsp;hsr)</code>
<div class="block">Function to update a Reservation to the RM.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="get--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ClusterInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ClusterInfo</a>&nbsp;get()</pre>
<div class="block">This method retrieves the cluster information, and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#INFO"><code>RMWSConsts.INFO</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cluster information</dd>
</dl>
</li>
</ul>
<a name="getClusterInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClusterInfo</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ClusterInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ClusterInfo</a>&nbsp;getClusterInfo()</pre>
<div class="block">This method retrieves the cluster information, and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#INFO"><code>RMWSConsts.INFO</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cluster information</dd>
</dl>
</li>
</ul>
<a name="getClusterUserInfo-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClusterUserInfo</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ClusterUserInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ClusterUserInfo</a>&nbsp;getClusterUserInfo(javax.servlet.http.HttpServletRequest&nbsp;hsr)</pre>
<div class="block">This method retrieves the cluster user information, and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#CLUSTER_USER_INFO"><code>RMWSConsts.CLUSTER_USER_INFO</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cluster user information</dd>
</dl>
</li>
</ul>
<a name="getClusterMetricsInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClusterMetricsInfo</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ClusterMetricsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ClusterMetricsInfo</a>&nbsp;getClusterMetricsInfo()</pre>
<div class="block">This method retrieves the cluster metrics information, and it is reachable
by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#METRICS"><code>RMWSConsts.METRICS</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cluster metrics information</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.getClusterMetrics(org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest)</code></dd>
</dl>
</li>
</ul>
<a name="getSchedulerInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchedulerInfo</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/SchedulerTypeInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">SchedulerTypeInfo</a>&nbsp;getSchedulerInfo()</pre>
<div class="block">This method retrieves the current scheduler status, and it is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#SCHEDULER"><code>RMWSConsts.SCHEDULER</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current scheduler status</dd>
</dl>
</li>
</ul>
<a name="dumpSchedulerLogs-java.lang.String-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dumpSchedulerLogs</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;dumpSchedulerLogs(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;time,
javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">This method dumps the scheduler logs for the time got in input, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#SCHEDULER_LOGS"><code>RMWSConsts.SCHEDULER_LOGS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>time</code> - the period of time. It is a FormParam.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the result of the operation</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - when it cannot create dump log file</dd>
</dl>
</li>
</ul>
<a name="getNodes-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodes</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodesInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodesInfo</a>&nbsp;getNodes(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;states)</pre>
<div class="block">This method retrieves all the nodes information in the cluster, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#NODES"><code>RMWSConsts.NODES</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>states</code> - the states we want to filter. It is a QueryParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all nodes in the cluster. If the states param is given, returns all
nodes that are in the comma-separated list of states</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)</code></dd>
</dl>
</li>
</ul>
<a name="getNode-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNode</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodeInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodeInfo</a>&nbsp;getNode(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeId)</pre>
<div class="block">This method retrieves a specific node information, and it is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#NODES_NODEID"><code>RMWSConsts.NODES_NODEID</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeId</code> - the node we want to retrieve the information. It is a
PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the information about the node in input</dd>
</dl>
</li>
</ul>
<a name="updateNodeResource-javax.servlet.http.HttpServletRequest-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ResourceOptionInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateNodeResource</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ResourceInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ResourceInfo</a>&nbsp;updateNodeResource(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeId,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ResourceOptionInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ResourceOptionInfo</a>&nbsp;resourceOption)
throws org.apache.hadoop.security.authorize.AuthorizationException</pre>
<div class="block">This method changes the resources of a specific node, and it is reachable
by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#NODE_RESOURCE"><code>RMWSConsts.NODE_RESOURCE</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - The servlet request.</dd>
<dd><code>nodeId</code> - The node we want to retrieve the information for.
It is a PathParam.</dd>
<dd><code>resourceOption</code> - The resource change.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - If the user is not authorized.</dd>
</dl>
</li>
</ul>
<a name="getApps-javax.servlet.http.HttpServletRequest-java.lang.String-java.util.Set-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.util.Set-java.util.Set-java.lang.String-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApps</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppsInfo</a>&nbsp;getApps(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stateQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;statesQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;finalStatusQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;userQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queueQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;count,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;startedBegin,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;startedEnd,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;finishBegin,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;finishEnd,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;applicationTypes,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;applicationTags,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;unselectedFields)</pre>
<div class="block">This method retrieves all the app reports in the cluster, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS"><code>RMWSConsts.APPS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>stateQuery</code> - right now the stateQuery is deprecated. It is a
QueryParam.</dd>
<dd><code>statesQuery</code> - filter the result by states. It is a QueryParam.</dd>
<dd><code>finalStatusQuery</code> - filter the result by final states. It is a
QueryParam.</dd>
<dd><code>userQuery</code> - filter the result by user. It is a QueryParam.</dd>
<dd><code>queueQuery</code> - filter the result by queue. It is a QueryParam.</dd>
<dd><code>count</code> - set a limit of the result. It is a QueryParam.</dd>
<dd><code>startedBegin</code> - filter the result by started begin time. It is a
QueryParam.</dd>
<dd><code>startedEnd</code> - filter the result by started end time. It is a
QueryParam.</dd>
<dd><code>finishBegin</code> - filter the result by finish begin time. It is a
QueryParam.</dd>
<dd><code>finishEnd</code> - filter the result by finish end time. It is a QueryParam.</dd>
<dd><code>applicationTypes</code> - filter the result by types. It is a QueryParam.</dd>
<dd><code>applicationTags</code> - filter the result by tags. It is a QueryParam.</dd>
<dd><code>name</code> - filter the name of the application. It is a QueryParam.</dd>
<dd><code>unselectedFields</code> - De-selected params to avoid from report. It is a
QueryParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all apps in the cluster</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationBaseProtocol.getApplications(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest)</code></dd>
</dl>
</li>
</ul>
<a name="getActivities-javax.servlet.http.HttpServletRequest-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActivities</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ActivitiesInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ActivitiesInfo</a>&nbsp;getActivities(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;groupBy)</pre>
<div class="block">This method retrieve all the activities in a specific node, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#SCHEDULER_ACTIVITIES"><code>RMWSConsts.SCHEDULER_ACTIVITIES</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>nodeId</code> - the node we want to retrieve the activities. It is a
QueryParam.</dd>
<dd><code>groupBy</code> - the groupBy type by which the activities should be
aggregated. It is a QueryParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all the activities in the specific node</dd>
</dl>
</li>
</ul>
<a name="getAppActivities-javax.servlet.http.HttpServletRequest-java.lang.String-java.lang.String-java.util.Set-java.util.Set-java.lang.String-java.lang.String-java.util.Set-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppActivities</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppActivitiesInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppActivitiesInfo</a>&nbsp;getAppActivities(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;time,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;requestPriorities,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;allocationRequestIds,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;groupBy,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;limit,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;actions,
boolean&nbsp;summarize)</pre>
<div class="block">This method retrieves all the activities for a specific app for a specific
period of time, and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#SCHEDULER_APP_ACTIVITIES"><code>RMWSConsts.SCHEDULER_APP_ACTIVITIES</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>appId</code> - the applicationId we want to retrieve the activities. It is a
QueryParam.</dd>
<dd><code>time</code> - for how long we want to retrieve the activities. It is a
QueryParam.</dd>
<dd><code>requestPriorities</code> - the request priorities we want to retrieve the
activities. It is a QueryParam.</dd>
<dd><code>allocationRequestIds</code> - the allocation request ids we want to retrieve
the activities. It is a QueryParam.</dd>
<dd><code>groupBy</code> - the groupBy type by which the activities should be
aggregated. It is a QueryParam.</dd>
<dd><code>limit</code> - set a limit of the result. It is a QueryParam.</dd>
<dd><code>actions</code> - the required actions of app activities. It is a QueryParam.</dd>
<dd><code>summarize</code> - whether app activities in multiple scheduling processes
need to be summarized. It is a QueryParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all the activities about a specific app for a specific time</dd>
</dl>
</li>
</ul>
<a name="getAppStatistics-javax.servlet.http.HttpServletRequest-java.util.Set-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppStatistics</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ApplicationStatisticsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ApplicationStatisticsInfo</a>&nbsp;getAppStatistics(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;stateQueries,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;typeQueries)</pre>
<div class="block">This method retrieves all the statistics for a specific app, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APP_STATISTICS"><code>RMWSConsts.APP_STATISTICS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>stateQueries</code> - filter the result by states. It is a QueryParam.</dd>
<dd><code>typeQueries</code> - filter the result by type names. It is a QueryParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the application's statistics for specific states and types</dd>
</dl>
</li>
</ul>
<a name="getApp-javax.servlet.http.HttpServletRequest-java.lang.String-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApp</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppInfo</a>&nbsp;getApp(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;unselectedFields)</pre>
<div class="block">This method retrieves the report for a specific app, and it is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID"><code>RMWSConsts.APPS_APPID</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>appId</code> - the Id of the application we want the report. It is a
PathParam.</dd>
<dd><code>unselectedFields</code> - De-selected param list to avoid from report. It is
a QueryParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the app report for a specific application</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationBaseProtocol.getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)</code></dd>
</dl>
</li>
</ul>
<a name="getAppState-javax.servlet.http.HttpServletRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppState</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppState.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppState</a>&nbsp;getAppState(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)
throws org.apache.hadoop.security.authorize.AuthorizationException</pre>
<div class="block">This method retrieves the state for a specific app, and it is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_STATE"><code>RMWSConsts.APPS_APPID_STATE</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>appId</code> - the Id of the application we want the state. It is a
PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the state for a specific application</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authorized</dd>
</dl>
</li>
</ul>
<a name="updateAppState-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.AppState-javax.servlet.http.HttpServletRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateAppState</h4>
<pre>javax.ws.rs.core.Response&nbsp;updateAppState(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppState.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppState</a>&nbsp;targetState,
javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)
throws org.apache.hadoop.security.authorize.AuthorizationException,
org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">This method updates the state of the app in input, and it is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_STATE"><code>RMWSConsts.APPS_APPID_STATE</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targetState</code> - the target state for the app. It is a content param.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>appId</code> - the Id of the application we want to update the state. It is a
PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authorized to invoke this
method</dd>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if app does not exist</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if doAs action throws an IOException</dd>
</dl>
</li>
</ul>
<a name="getNodeToLabels-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeToLabels</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodeToLabelsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodeToLabelsInfo</a>&nbsp;getNodeToLabels(javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">This method retrieves all the node labels with the respective nodes in the
cluster, and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#GET_NODE_TO_LABELS"><code>RMWSConsts.GET_NODE_TO_LABELS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all the nodes within a node label</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an IOException happened</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.getNodeToLabels(org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest)</code></dd>
</dl>
</li>
</ul>
<a name="getLabelsToNodes-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabelsToNodes</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/LabelsToNodesInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">LabelsToNodesInfo</a>&nbsp;getLabelsToNodes(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;labels)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">This method retrieves all the node within multiple node labels in the
cluster, and it is reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#LABEL_MAPPINGS"><code>RMWSConsts.LABEL_MAPPINGS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>labels</code> - filter the result by node labels. It is a QueryParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all the nodes within multiple node labels</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an IOException happened</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.getLabelsToNodes(org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest)</code></dd>
</dl>
</li>
</ul>
<a name="replaceLabelsOnNodes-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeToLabelsEntryList-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replaceLabelsOnNodes</h4>
<pre>javax.ws.rs.core.Response&nbsp;replaceLabelsOnNodes(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodeToLabelsEntryList.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodeToLabelsEntryList</a>&nbsp;newNodeToLabels,
javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">This method replaces all the node labels for specific nodes, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#REPLACE_NODE_TO_LABELS"><code>RMWSConsts.REPLACE_NODE_TO_LABELS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newNodeToLabels</code> - the list of new labels. It is a content param.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an exception happened</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ResourceManagerAdministrationProtocol.replaceLabelsOnNode(org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeRequest)</code></dd>
</dl>
</li>
</ul>
<a name="replaceLabelsOnNode-java.util.Set-javax.servlet.http.HttpServletRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replaceLabelsOnNode</h4>
<pre>javax.ws.rs.core.Response&nbsp;replaceLabelsOnNode(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;newNodeLabelsName,
javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeId)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">This method replaces all the node labels for specific node, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#NODES_NODEID_REPLACE_LABELS"><code>RMWSConsts.NODES_NODEID_REPLACE_LABELS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newNodeLabelsName</code> - the list of new labels. It is a QueryParam.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>nodeId</code> - the node we want to replace the node labels. It is a
PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an exception happened</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ResourceManagerAdministrationProtocol.replaceLabelsOnNode(org.apache.hadoop.yarn.server.api.protocolrecords.ReplaceLabelsOnNodeRequest)</code></dd>
</dl>
</li>
</ul>
<a name="getClusterNodeLabels-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClusterNodeLabels</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodeLabelsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodeLabelsInfo</a>&nbsp;getClusterNodeLabels(javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">This method retrieves all the node labels in the cluster, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#GET_NODE_LABELS"><code>RMWSConsts.GET_NODE_LABELS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all the node labels in the cluster</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an IOException happened</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.getClusterNodeLabels(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest)</code></dd>
</dl>
</li>
</ul>
<a name="addToClusterNodeLabels-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.NodeLabelsInfo-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToClusterNodeLabels</h4>
<pre>javax.ws.rs.core.Response&nbsp;addToClusterNodeLabels(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodeLabelsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodeLabelsInfo</a>&nbsp;newNodeLabels,
javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">This method adds specific node labels for specific nodes, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#ADD_NODE_LABELS"><code>RMWSConsts.ADD_NODE_LABELS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newNodeLabels</code> - the node labels to add. It is a content param.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - in case of bad request</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ResourceManagerAdministrationProtocol.addToClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.AddToClusterNodeLabelsRequest)</code></dd>
</dl>
</li>
</ul>
<a name="removeFromCluserNodeLabels-java.util.Set-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFromCluserNodeLabels</h4>
<pre>javax.ws.rs.core.Response&nbsp;removeFromCluserNodeLabels(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;oldNodeLabels,
javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">This method removes all the node labels for specific nodes, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#REMOVE_NODE_LABELS"><code>RMWSConsts.REMOVE_NODE_LABELS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>oldNodeLabels</code> - the node labels to remove. It is a QueryParam.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - in case of bad request</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ResourceManagerAdministrationProtocol.removeFromClusterNodeLabels(org.apache.hadoop.yarn.server.api.protocolrecords.RemoveFromClusterNodeLabelsRequest)</code></dd>
</dl>
</li>
</ul>
<a name="getLabelsOnNode-javax.servlet.http.HttpServletRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabelsOnNode</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/NodeLabelsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">NodeLabelsInfo</a>&nbsp;getLabelsOnNode(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nodeId)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">This method retrieves all the node labels for specific node, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#NODES_NODEID_GETLABELS"><code>RMWSConsts.NODES_NODEID_GETLABELS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>nodeId</code> - the node we want to get all the node labels. It is a
PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all the labels for a specific node.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an IOException happened</dd>
</dl>
</li>
</ul>
<a name="getAppPriority-javax.servlet.http.HttpServletRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppPriority</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppPriority.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppPriority</a>&nbsp;getAppPriority(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)
throws org.apache.hadoop.security.authorize.AuthorizationException</pre>
<div class="block">This method retrieves the priority for a specific app, and it is reachable
by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_PRIORITY"><code>RMWSConsts.APPS_APPID_PRIORITY</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>appId</code> - the app we want to get the priority. It is a PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the priority for a specific application</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - in case of the user is not authorized</dd>
</dl>
</li>
</ul>
<a name="updateApplicationPriority-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.AppPriority-javax.servlet.http.HttpServletRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateApplicationPriority</h4>
<pre>javax.ws.rs.core.Response&nbsp;updateApplicationPriority(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppPriority.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppPriority</a>&nbsp;targetPriority,
javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)
throws org.apache.hadoop.security.authorize.AuthorizationException,
org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">This method updates the priority for a specific application, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_PRIORITY"><code>RMWSConsts.APPS_APPID_PRIORITY</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targetPriority</code> - the priority we want to set for the app. It is a
content param.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>appId</code> - the application we want to update its priority. It is a
PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authenticated</dd>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if the target is null</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the update fails.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted.</dd>
</dl>
</li>
</ul>
<a name="getAppQueue-javax.servlet.http.HttpServletRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppQueue</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppQueue</a>&nbsp;getAppQueue(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)
throws org.apache.hadoop.security.authorize.AuthorizationException</pre>
<div class="block">This method retrieves the queue for a specific app, and it is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_QUEUE"><code>RMWSConsts.APPS_APPID_QUEUE</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>appId</code> - the application we want to retrieve its queue. It is a
PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Queue for a specific application.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authenticated</dd>
</dl>
</li>
</ul>
<a name="updateAppQueue-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.AppQueue-javax.servlet.http.HttpServletRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateAppQueue</h4>
<pre>javax.ws.rs.core.Response&nbsp;updateAppQueue(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppQueue</a>&nbsp;targetQueue,
javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)
throws org.apache.hadoop.security.authorize.AuthorizationException,
org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">This method updates the queue for a specific application, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_QUEUE"><code>RMWSConsts.APPS_APPID_QUEUE</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targetQueue</code> - the queue we want to set. It is a content param.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>appId</code> - the application we want to change its queue. It is a
PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authenticated</dd>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if the app is not found</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the update fails.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted.</dd>
</dl>
</li>
</ul>
<a name="createNewApplication-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createNewApplication</h4>
<pre>javax.ws.rs.core.Response&nbsp;createNewApplication(javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws org.apache.hadoop.security.authorize.AuthorizationException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre>
<div class="block">Generates a new ApplicationId which is then sent to the client. This method
is reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_NEW_APPLICATION"><code>RMWSConsts.APPS_NEW_APPLICATION</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the app id and the maximum resource
capabilities</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authorized to invoke this
method</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the creation fails</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.getNewApplication(org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest)</code></dd>
</dl>
</li>
</ul>
<a name="submitApplication-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ApplicationSubmissionContextInfo-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>submitApplication</h4>
<pre>javax.ws.rs.core.Response&nbsp;submitApplication(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ApplicationSubmissionContextInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ApplicationSubmissionContextInfo</a>&nbsp;newApp,
javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws org.apache.hadoop.security.authorize.AuthorizationException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre>
<div class="block">Function to submit an app to the RM. This method is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS"><code>RMWSConsts.APPS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newApp</code> - structure containing information to construct the
ApplicationSubmissionContext. It is a content param.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authorized to invoke this
method</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the submission failed</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)</code></dd>
</dl>
</li>
</ul>
<a name="postDelegationToken-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.DelegationToken-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>postDelegationToken</h4>
<pre>javax.ws.rs.core.Response&nbsp;postDelegationToken(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/DelegationToken.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">DelegationToken</a>&nbsp;tokenData,
javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws org.apache.hadoop.security.authorize.AuthorizationException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">This method posts a delegation token from the client, and it is reachable
by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#DELEGATION_TOKEN"><code>RMWSConsts.DELEGATION_TOKEN</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tokenData</code> - the token to delegate. It is a content param.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if Kerberos auth failed</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the delegation failed</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - in case of bad request</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationBaseProtocol.getDelegationToken(org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest)</code></dd>
</dl>
</li>
</ul>
<a name="postDelegationTokenExpiration-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>postDelegationTokenExpiration</h4>
<pre>javax.ws.rs.core.Response&nbsp;postDelegationTokenExpiration(javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws org.apache.hadoop.security.authorize.AuthorizationException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">This method updates the expiration for a delegation token from the client,
and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#DELEGATION_TOKEN_EXPIRATION"><code>RMWSConsts.DELEGATION_TOKEN_EXPIRATION</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if Kerberos auth failed</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the delegation failed</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - in case of bad request</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationBaseProtocol.renewDelegationToken(org.apache.hadoop.yarn.api.protocolrecords.RenewDelegationTokenRequest)</code></dd>
</dl>
</li>
</ul>
<a name="cancelDelegationToken-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancelDelegationToken</h4>
<pre>javax.ws.rs.core.Response&nbsp;cancelDelegationToken(javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws org.apache.hadoop.security.authorize.AuthorizationException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">This method cancel the delegation token from the client, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#DELEGATION_TOKEN"><code>RMWSConsts.DELEGATION_TOKEN</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if Kerberos auth failed</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the delegation failed</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - in case of bad request</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationBaseProtocol.cancelDelegationToken(org.apache.hadoop.yarn.api.protocolrecords.CancelDelegationTokenRequest)</code></dd>
</dl>
</li>
</ul>
<a name="createNewReservation-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createNewReservation</h4>
<pre>javax.ws.rs.core.Response&nbsp;createNewReservation(javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws org.apache.hadoop.security.authorize.AuthorizationException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre>
<div class="block">Generates a new ReservationId which is then sent to the client. This method
is reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#RESERVATION_NEW"><code>RMWSConsts.RESERVATION_NEW</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the app id and the maximum resource
capabilities</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authorized to invoke this
method.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if creation failed</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.getNewReservation(org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest)</code></dd>
</dl>
</li>
</ul>
<a name="submitReservation-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ReservationSubmissionRequestInfo-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>submitReservation</h4>
<pre>javax.ws.rs.core.Response&nbsp;submitReservation(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ReservationSubmissionRequestInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ReservationSubmissionRequestInfo</a>&nbsp;resContext,
javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws org.apache.hadoop.security.authorize.AuthorizationException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre>
<div class="block">Function to submit a Reservation to the RM.This method is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#RESERVATION_SUBMIT"><code>RMWSConsts.RESERVATION_SUBMIT</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resContext</code> - provides information to construct the
ReservationSubmissionRequest. It is a content param.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authorized to invoke this
method</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if creation failed</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.submitReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest)</code></dd>
</dl>
</li>
</ul>
<a name="updateReservation-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ReservationUpdateRequestInfo-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateReservation</h4>
<pre>javax.ws.rs.core.Response&nbsp;updateReservation(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ReservationUpdateRequestInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ReservationUpdateRequestInfo</a>&nbsp;resContext,
javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws org.apache.hadoop.security.authorize.AuthorizationException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre>
<div class="block">Function to update a Reservation to the RM. This method is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#RESERVATION_UPDATE"><code>RMWSConsts.RESERVATION_UPDATE</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resContext</code> - provides information to construct the
ReservationUpdateRequest. It is a content param.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authorized to invoke this
method</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the operation failed</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.updateReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest)</code></dd>
</dl>
</li>
</ul>
<a name="deleteReservation-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ReservationDeleteRequestInfo-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteReservation</h4>
<pre>javax.ws.rs.core.Response&nbsp;deleteReservation(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ReservationDeleteRequestInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">ReservationDeleteRequestInfo</a>&nbsp;resContext,
javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws org.apache.hadoop.security.authorize.AuthorizationException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre>
<div class="block">Function to delete a Reservation to the RM. This method is reachable by
using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#RESERVATION_DELETE"><code>RMWSConsts.RESERVATION_DELETE</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resContext</code> - provides information to construct the
ReservationDeleteRequest. It is a content param.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - when the user group information cannot be
retrieved.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - when a <code>ReservationDeleteRequest</code> cannot be
created from the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/ReservationDeleteRequestInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao"><code>ReservationDeleteRequestInfo</code></a>. This
exception is also thrown on
<code>ClientRMService.deleteReservation</code> invokation failure.</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if doAs action throws an InterruptedException.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.deleteReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest)</code></dd>
</dl>
</li>
</ul>
<a name="listReservation-java.lang.String-java.lang.String-long-long-boolean-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listReservation</h4>
<pre>javax.ws.rs.core.Response&nbsp;listReservation(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queue,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;reservationId,
long&nbsp;startTime,
long&nbsp;endTime,
boolean&nbsp;includeResourceAllocations,
javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Function to retrieve a list of all the reservations. This method is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#RESERVATION_LIST"><code>RMWSConsts.RESERVATION_LIST</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queue</code> - filter the result by queue. It is a QueryParam.</dd>
<dd><code>reservationId</code> - filter the result by reservationId. It is a
QueryParam.</dd>
<dd><code>startTime</code> - filter the result by start time. It is a QueryParam.</dd>
<dd><code>endTime</code> - filter the result by end time. It is a QueryParam.</dd>
<dd><code>includeResourceAllocations</code> - true if the resource allocation should be
in the result, false otherwise. It is a QueryParam.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - in case of bad request</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.listReservations(org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest)</code></dd>
</dl>
</li>
</ul>
<a name="getAppTimeout-javax.servlet.http.HttpServletRequest-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppTimeout</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppTimeoutInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppTimeoutInfo</a>&nbsp;getAppTimeout(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type)
throws org.apache.hadoop.security.authorize.AuthorizationException</pre>
<div class="block">This method retrieves the timeout information for a specific app with a
specific type, and it is reachable by using
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_TIMEOUTS_TYPE"><code>RMWSConsts.APPS_TIMEOUTS_TYPE</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>appId</code> - the application we want to get the timeout. It is a PathParam.</dd>
<dd><code>type</code> - the type of the timeouts. It is a PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timeout for a specific application with a specific type.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authorized</dd>
</dl>
</li>
</ul>
<a name="getAppTimeouts-javax.servlet.http.HttpServletRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppTimeouts</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppTimeoutsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppTimeoutsInfo</a>&nbsp;getAppTimeouts(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)
throws org.apache.hadoop.security.authorize.AuthorizationException</pre>
<div class="block">This method retrieves the timeout information for a specific app, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_TIMEOUTS"><code>RMWSConsts.APPS_TIMEOUTS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>appId</code> - the application we want to get the timeouts. It is a
PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timeouts for a specific application</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authorized</dd>
</dl>
</li>
</ul>
<a name="updateApplicationTimeout-org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.AppTimeoutInfo-javax.servlet.http.HttpServletRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateApplicationTimeout</h4>
<pre>javax.ws.rs.core.Response&nbsp;updateApplicationTimeout(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppTimeoutInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppTimeoutInfo</a>&nbsp;appTimeout,
javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)
throws org.apache.hadoop.security.authorize.AuthorizationException,
org.apache.hadoop.yarn.exceptions.YarnException,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">This method updates the timeout information for a specific app, and it is
reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_TIMEOUT"><code>RMWSConsts.APPS_TIMEOUT</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>appTimeout</code> - the appTimeoutInfo. It is a content param.</dd>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>appId</code> - the application we want to update. It is a PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authorized to invoke this
method</dd>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - in case of bad request</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the operation failed</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if interrupted</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationClientProtocol.updateApplicationTimeouts(org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest)</code></dd>
</dl>
</li>
</ul>
<a name="getAppAttempts-javax.servlet.http.HttpServletRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppAttempts</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/AppAttemptsInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">AppAttemptsInfo</a>&nbsp;getAppAttempts(javax.servlet.http.HttpServletRequest&nbsp;hsr,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appId)</pre>
<div class="block">This method retrieves all the attempts information for a specific app, and
it is reachable by using <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWSConsts.html#APPS_APPID_APPATTEMPTS"><code>RMWSConsts.APPS_APPID_APPATTEMPTS</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hsr</code> - the servlet request</dd>
<dd><code>appId</code> - the application we want to get the attempts. It is a
PathParam.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all the attempts info for a specific application</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ApplicationBaseProtocol.getApplicationAttempts(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest)</code></dd>
</dl>
</li>
</ul>
<a name="checkUserAccessToQueue-java.lang.String-java.lang.String-java.lang.String-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkUserAccessToQueue</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/dao/RMQueueAclInfo.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp.dao">RMQueueAclInfo</a>&nbsp;checkUserAccessToQueue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queue,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queueAclType,
javax.servlet.http.HttpServletRequest&nbsp;hsr)
throws org.apache.hadoop.security.authorize.AuthorizationException</pre>
<div class="block">This method verifies if an user has access to a specified queue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queue</code> - queue</dd>
<dd><code>username</code> - user</dd>
<dd><code>queueAclType</code> - acl type of queue, it could be
SUBMIT_APPLICATIONS/ADMINISTER_QUEUE</dd>
<dd><code>hsr</code> - request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authorized to invoke this
method.</dd>
</dl>
</li>
</ul>
<a name="signalToContainer-java.lang.String-java.lang.String-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>signalToContainer</h4>
<pre>javax.ws.rs.core.Response&nbsp;signalToContainer(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;containerId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;command,
javax.servlet.http.HttpServletRequest&nbsp;req)
throws org.apache.hadoop.security.authorize.AuthorizationException</pre>
<div class="block">This method sends a signal to container.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - containerId</dd>
<dd><code>command</code> - signal command, it could be OUTPUT_THREAD_DUMP/
GRACEFUL_SHUTDOWN/FORCEFUL_SHUTDOWN</dd>
<dd><code>req</code> - request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response containing the status code</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - if the user is not authorized to invoke this
method.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RMWebServiceProtocol.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/webapp/RMWebAppUtil.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServices.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.webapp"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/webapp/RMWebServiceProtocol.html" target="_top">Frames</a></li>
<li><a href="RMWebServiceProtocol.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>