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 / rmapp / RMApp.html
blob: 76a010d74fdfca5ca9eb72314ec90e6d5a3b3b38 [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:10 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RMApp (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="RMApp (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};
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/RMApp.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMAppEvent.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" target="_top">Frames</a></li>
<li><a href="RMApp.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.rmapp</div>
<h2 title="Interface RMApp" class="title">Interface RMApp</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>org.apache.hadoop.yarn.event.EventHandler&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMAppEvent.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.rmapp">RMAppEvent</a>&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMAppImpl.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.rmapp">RMAppImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">RMApp</span>
extends org.apache.hadoop.yarn.event.EventHandler&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMAppEvent.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.rmapp">RMAppEvent</a>&gt;</pre>
<div class="block">The interface to an Application in the ResourceManager. Take a
look at <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMAppImpl.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMAppImpl</code></a> for its implementation. This interface
exposes methods to access various updates in application status/report.</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>org.apache.hadoop.yarn.api.records.ApplicationReport</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#createAndGetApplicationReport-java.lang.String-boolean-">createAndGetApplicationReport</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;clientUserName,
boolean&nbsp;allowAccess)</code>
<div class="block">To get the status of an application in the RM, this method can be used.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.YarnApplicationState</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#createApplicationState--">createApplicationState</a></span>()</code>
<div class="block">Create the external user-facing state of ApplicationMaster from the
current state of the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a>.</div>
</td>
</tr>
<tr id="i2" 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/rmapp/RMApp.html#getAmNodeLabelExpression--">getAmNodeLabelExpression</a></span>()</code>
<div class="block">Return the node label expression of the AM container.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.hadoop.yarn.api.records.ResourceRequest&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getAMResourceRequests--">getAMResourceRequests</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;org.apache.hadoop.yarn.api.records.ApplicationAttemptId,<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt">RMAppAttempt</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getAppAttempts--">getAppAttempts</a></span>()</code>
<div class="block"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a> can have multiple application attempts <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt"><code>RMAppAttempt</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.ApplicationId</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getApplicationId--">getApplicationId</a></span>()</code>
<div class="block">The application id for this <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/placement/ApplicationPlacementContext.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.placement">ApplicationPlacementContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getApplicationPlacementContext--">getApplicationPlacementContext</a></span>()</code>
<div class="block">Get the application -&gt; queue placement context</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Priority</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getApplicationPriority--">getApplicationPriority</a></span>()</code>
<div class="block">Get priority of the application.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getApplicationSchedulingEnvs--">getApplicationSchedulingEnvs</a></span>()</code>
<div class="block">Get the application scheduling environment variables.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getApplicationSubmissionContext--">getApplicationSubmissionContext</a></span>()</code>
<div class="block">The application submission context for this <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a></div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><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;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getApplicationTags--">getApplicationTags</a></span>()</code>
<div class="block">Get tags for the application</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;org.apache.hadoop.yarn.api.records.ApplicationTimeoutType,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getApplicationTimeouts--">getApplicationTimeouts</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" 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/rmapp/RMApp.html#getApplicationType--">getApplicationType</a></span>()</code>
<div class="block">Returns the application type</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<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/rmapp/RMApp.html#getAppNodeLabelExpression--">getAppNodeLabelExpression</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.ipc.CallerContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getCallerContext--">getCallerContext</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.server.api.records.AppCollectorData</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getCollectorData--">getCollectorData</a></span>()</code>
<div class="block">The timeline collector information for the application.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.CollectorInfo</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getCollectorInfo--">getCollectorInfo</a></span>()</code>
<div class="block">The timeline collector information to be sent to AM.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt">RMAppAttempt</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getCurrentAppAttempt--">getCurrentAppAttempt</a></span>()</code>
<div class="block"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a> can have multiple application attempts <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt"><code>RMAppAttempt</code></a>.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getDiagnostics--">getDiagnostics</a></span>()</code>
<div class="block">the diagnostics information for the application master.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.FinalApplicationStatus</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getFinalApplicationStatus--">getFinalApplicationStatus</a></span>()</code>
<div class="block">The final finish state of the AM when unregistering as in
<code>FinishApplicationMasterRequest.setFinalApplicationStatus(FinalApplicationStatus)</code>.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getFinishTime--">getFinishTime</a></span>()</code>
<div class="block">The finish time of the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a></div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getLaunchTime--">getLaunchTime</a></span>()</code>
<div class="block">The launch time of the application.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;org.apache.hadoop.yarn.api.records.NodeId,org.apache.hadoop.yarn.server.api.protocolrecords.LogAggregationReport&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getLogAggregationReportsForApp--">getLogAggregationReportsForApp</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.LogAggregationStatus</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getLogAggregationStatusForAppReport--">getLogAggregationStatusForAppReport</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getMaxAppAttempts--">getMaxAppAttempts</a></span>()</code>
<div class="block">The number of max attempts of the application.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<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/rmapp/RMApp.html#getName--">getName</a></span>()</code>
<div class="block">The name of the application as set in <code>ApplicationSubmissionContext.setApplicationName(String)</code>.</div>
</td>
</tr>
<tr id="i26" 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/rmapp/RMApp.html#getOriginalTrackingUrl--">getOriginalTrackingUrl</a></span>()</code>
<div class="block">The original tracking url for the application master.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getProgress--">getProgress</a></span>()</code>
<div class="block">Progress of application.</div>
</td>
</tr>
<tr id="i28" 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/rmapp/RMApp.html#getQueue--">getQueue</a></span>()</code>
<div class="block">Each Application is submitted to a queue decided by <code>ApplicationSubmissionContext.setQueue(String)</code>.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><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;org.apache.hadoop.yarn.api.records.NodeId&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getRanNodes--">getRanNodes</a></span>()</code>
<div class="block">Nodes on which the containers for this <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a> ran.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.api.records.ReservationId</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getReservationId--">getReservationId</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt">RMAppAttempt</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getRMAppAttempt-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-">getRMAppAttempt</a></span>(org.apache.hadoop.yarn.api.records.ApplicationAttemptId&nbsp;appAttemptId)</code>
<div class="block"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a> can have multiple application attempts <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt"><code>RMAppAttempt</code></a>.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMAppMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.rmapp">RMAppMetrics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getRMAppMetrics--">getRMAppMetrics</a></span>()</code>
<div class="block">Get RMAppMetrics of the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a>.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getStartTime--">getStartTime</a></span>()</code>
<div class="block">the start time of the application.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMAppState.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.rmapp">RMAppState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getState--">getState</a></span>()</code>
<div class="block">The current state of the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a>.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#getSubmitTime--">getSubmitTime</a></span>()</code>
<div class="block">the submit time of the application.</div>
</td>
</tr>
<tr id="i36" 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/rmapp/RMApp.html#getTrackingUrl--">getTrackingUrl</a></span>()</code>
<div class="block">The tracking url for the application master.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<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/rmapp/RMApp.html#getUser--">getUser</a></span>()</code>
<div class="block">The user who submitted this application.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#isAppFinalStateStored--">isAppFinalStateStored</a></span>()</code>
<div class="block">Check whether this application's state has been saved to the state store.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#isAppInCompletedStates--">isAppInCompletedStates</a></span>()</code>
<div class="block">To verify whether app has reached in its completing/completed states.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#pullRMNodeUpdates-java.util.Map-">pullRMNodeUpdates</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmnode/RMNode.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmnode">RMNode</a>,org.apache.hadoop.yarn.api.records.NodeUpdateType&gt;&nbsp;updatedNodes)</code>
<div class="block">To receive the collection of all <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmnode/RMNode.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmnode"><code>RMNode</code></a>s whose updates have been
received by the RMApp.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html#setQueue-java.lang.String-">setQueue</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;name)</code>
<div class="block">Reflects a change in the application's queue from the one specified in the
<code>ApplicationSubmissionContext</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.event.EventHandler">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.hadoop.yarn.event.EventHandler</h3>
<code>handle</code></li>
</ul>
</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="getApplicationId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationId</h4>
<pre>org.apache.hadoop.yarn.api.records.ApplicationId&nbsp;getApplicationId()</pre>
<div class="block">The application id for this <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>ApplicationId</code> for this <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getApplicationSubmissionContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationSubmissionContext</h4>
<pre>org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext&nbsp;getApplicationSubmissionContext()</pre>
<div class="block">The application submission context for this <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>ApplicationSubmissionContext</code> for this <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a></dd>
</dl>
</li>
</ul>
<a name="getState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getState</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMAppState.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.rmapp">RMAppState</a>&nbsp;getState()</pre>
<div class="block">The current state of the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current state <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMAppState.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMAppState</code></a> for this application.</dd>
</dl>
</li>
</ul>
<a name="getUser--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUser</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;getUser()</pre>
<div class="block">The user who submitted this application.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user who submitted the application.</dd>
</dl>
</li>
</ul>
<a name="getProgress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProgress</h4>
<pre>float&nbsp;getProgress()</pre>
<div class="block">Progress of application.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the progress of the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getRMAppAttempt-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRMAppAttempt</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt">RMAppAttempt</a>&nbsp;getRMAppAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId&nbsp;appAttemptId)</pre>
<div class="block"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a> can have multiple application attempts <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt"><code>RMAppAttempt</code></a>.
This method returns the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt"><code>RMAppAttempt</code></a> corresponding to
<code>ApplicationAttemptId</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>appAttemptId</code> - the application attempt id</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt"><code>RMAppAttempt</code></a> corresponding to the <code>ApplicationAttemptId</code>.</dd>
</dl>
</li>
</ul>
<a name="getQueue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueue</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;getQueue()</pre>
<div class="block">Each Application is submitted to a queue decided by <code>ApplicationSubmissionContext.setQueue(String)</code>.
This method returns the queue to which an application was submitted.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the queue to which the application was submitted to.</dd>
</dl>
</li>
</ul>
<a name="setQueue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueue</h4>
<pre>void&nbsp;setQueue(<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)</pre>
<div class="block">Reflects a change in the application's queue from the one specified in the
<code>ApplicationSubmissionContext</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the new queue name</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</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;getName()</pre>
<div class="block">The name of the application as set in <code>ApplicationSubmissionContext.setApplicationName(String)</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the application.</dd>
</dl>
</li>
</ul>
<a name="getCurrentAppAttempt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentAppAttempt</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt">RMAppAttempt</a>&nbsp;getCurrentAppAttempt()</pre>
<div class="block"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a> can have multiple application attempts <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt"><code>RMAppAttempt</code></a>.
This method returns the current <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt"><code>RMAppAttempt</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt"><code>RMAppAttempt</code></a></dd>
</dl>
</li>
</ul>
<a name="getAppAttempts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppAttempts</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;org.apache.hadoop.yarn.api.records.ApplicationAttemptId,<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt">RMAppAttempt</a>&gt;&nbsp;getAppAttempts()</pre>
<div class="block"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a> can have multiple application attempts <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt"><code>RMAppAttempt</code></a>.
This method returns the all <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt"><code>RMAppAttempt</code></a>s for the RMApp.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/attempt/RMAppAttempt.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt"><code>RMAppAttempt</code></a>s for the RMApp.</dd>
</dl>
</li>
</ul>
<a name="createAndGetApplicationReport-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAndGetApplicationReport</h4>
<pre>org.apache.hadoop.yarn.api.records.ApplicationReport&nbsp;createAndGetApplicationReport(<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;clientUserName,
boolean&nbsp;allowAccess)</pre>
<div class="block">To get the status of an application in the RM, this method can be used.
If full access is not allowed then the following fields in the report
will be stubbed:
<ul>
<li>host - set to "N/A"</li>
<li>RPC port - set to -1</li>
<li>client token - set to "N/A"</li>
<li>diagnostics - set to "N/A"</li>
<li>tracking URL - set to "N/A"</li>
<li>original tracking URL - set to "N/A"</li>
<li>resource usage report - all values are -1</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clientUserName</code> - the user name of the client requesting the report</dd>
<dd><code>allowAccess</code> - whether to allow full access to the report</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>ApplicationReport</code> detailing the status of the application.</dd>
</dl>
</li>
</ul>
<a name="pullRMNodeUpdates-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pullRMNodeUpdates</h4>
<pre>int&nbsp;pullRMNodeUpdates(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmnode/RMNode.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmnode">RMNode</a>,org.apache.hadoop.yarn.api.records.NodeUpdateType&gt;&nbsp;updatedNodes)</pre>
<div class="block">To receive the collection of all <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmnode/RMNode.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmnode"><code>RMNode</code></a>s whose updates have been
received by the RMApp. Updates can be node becoming lost or becoming
healthy etc. The method clears the information from the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a>. So
each call to this method gives the delta from the previous call.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>updatedNodes</code> - Map into which the updates are transferred, with each
node updates as the key, and the <code>NodeUpdateType</code> for that update
as the corresponding value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of nodes added to the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a></dd>
</dl>
</li>
</ul>
<a name="getFinishTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFinishTime</h4>
<pre>long&nbsp;getFinishTime()</pre>
<div class="block">The finish time of the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the finish time of the application.,</dd>
</dl>
</li>
</ul>
<a name="getStartTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartTime</h4>
<pre>long&nbsp;getStartTime()</pre>
<div class="block">the start time of the application.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the start time of the application.</dd>
</dl>
</li>
</ul>
<a name="getSubmitTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubmitTime</h4>
<pre>long&nbsp;getSubmitTime()</pre>
<div class="block">the submit time of the application.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the submit time of the application.</dd>
</dl>
</li>
</ul>
<a name="getLaunchTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLaunchTime</h4>
<pre>long&nbsp;getLaunchTime()</pre>
<div class="block">The launch time of the application.
Since getStartTime() returns what is essentially submit time,
this new field is to prevent potential backwards compatibility issues.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the launch time of the application.</dd>
</dl>
</li>
</ul>
<a name="getTrackingUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTrackingUrl</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;getTrackingUrl()</pre>
<div class="block">The tracking url for the application master.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the tracking url for the application master.</dd>
</dl>
</li>
</ul>
<a name="getCollectorData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCollectorData</h4>
<pre>@InterfaceAudience.Private
@InterfaceStability.Unstable
org.apache.hadoop.yarn.server.api.records.AppCollectorData&nbsp;getCollectorData()</pre>
<div class="block">The timeline collector information for the application. It should be used
only if the timeline service v.2 is enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the data for the application's collector, including collector
address, RM ID, version and collector token. Return null if the timeline
service v.2 is not enabled.</dd>
</dl>
</li>
</ul>
<a name="getCollectorInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCollectorInfo</h4>
<pre>@InterfaceAudience.Private
@InterfaceStability.Unstable
org.apache.hadoop.yarn.api.records.CollectorInfo&nbsp;getCollectorInfo()</pre>
<div class="block">The timeline collector information to be sent to AM. It should be used
only if the timeline service v.2 is enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>collector info, including collector address and collector token.
Return null if the timeline service v.2 is not enabled.</dd>
</dl>
</li>
</ul>
<a name="getOriginalTrackingUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOriginalTrackingUrl</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;getOriginalTrackingUrl()</pre>
<div class="block">The original tracking url for the application master.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the original tracking url for the application master.</dd>
</dl>
</li>
</ul>
<a name="getDiagnostics--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiagnostics</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;getDiagnostics()</pre>
<div class="block">the diagnostics information for the application master.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the diagnostics information for the application master.</dd>
</dl>
</li>
</ul>
<a name="getFinalApplicationStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFinalApplicationStatus</h4>
<pre>org.apache.hadoop.yarn.api.records.FinalApplicationStatus&nbsp;getFinalApplicationStatus()</pre>
<div class="block">The final finish state of the AM when unregistering as in
<code>FinishApplicationMasterRequest.setFinalApplicationStatus(FinalApplicationStatus)</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the final finish state of the AM as set in
<code>FinishApplicationMasterRequest.setFinalApplicationStatus(FinalApplicationStatus)</code>.</dd>
</dl>
</li>
</ul>
<a name="getMaxAppAttempts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxAppAttempts</h4>
<pre>int&nbsp;getMaxAppAttempts()</pre>
<div class="block">The number of max attempts of the application.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of max attempts of the application.</dd>
</dl>
</li>
</ul>
<a name="getApplicationType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationType</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;getApplicationType()</pre>
<div class="block">Returns the application type</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the application type.</dd>
</dl>
</li>
</ul>
<a name="getApplicationTags--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationTags</h4>
<pre><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;getApplicationTags()</pre>
<div class="block">Get tags for the application</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>tags corresponding to the application</dd>
</dl>
</li>
</ul>
<a name="isAppFinalStateStored--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAppFinalStateStored</h4>
<pre>boolean&nbsp;isAppFinalStateStored()</pre>
<div class="block">Check whether this application's state has been saved to the state store.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the flag indicating whether the applications's state is stored.</dd>
</dl>
</li>
</ul>
<a name="getRanNodes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRanNodes</h4>
<pre><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;org.apache.hadoop.yarn.api.records.NodeId&gt;&nbsp;getRanNodes()</pre>
<div class="block">Nodes on which the containers for this <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a> ran.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the set of nodes that ran any containers from this <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a>
Add more node on which containers for this <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a> ran</dd>
</dl>
</li>
</ul>
<a name="createApplicationState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createApplicationState</h4>
<pre>org.apache.hadoop.yarn.api.records.YarnApplicationState&nbsp;createApplicationState()</pre>
<div class="block">Create the external user-facing state of ApplicationMaster from the
current state of the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the external user-facing state of ApplicationMaster.</dd>
</dl>
</li>
</ul>
<a name="getRMAppMetrics--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRMAppMetrics</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMAppMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.rmapp">RMAppMetrics</a>&nbsp;getRMAppMetrics()</pre>
<div class="block">Get RMAppMetrics of the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><code>RMApp</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>metrics</dd>
</dl>
</li>
</ul>
<a name="getReservationId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReservationId</h4>
<pre>org.apache.hadoop.yarn.api.records.ReservationId&nbsp;getReservationId()</pre>
</li>
</ul>
<a name="getAMResourceRequests--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAMResourceRequests</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.hadoop.yarn.api.records.ResourceRequest&gt;&nbsp;getAMResourceRequests()</pre>
</li>
</ul>
<a name="getLogAggregationReportsForApp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogAggregationReportsForApp</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;org.apache.hadoop.yarn.api.records.NodeId,org.apache.hadoop.yarn.server.api.protocolrecords.LogAggregationReport&gt;&nbsp;getLogAggregationReportsForApp()</pre>
</li>
</ul>
<a name="getLogAggregationStatusForAppReport--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogAggregationStatusForAppReport</h4>
<pre>org.apache.hadoop.yarn.api.records.LogAggregationStatus&nbsp;getLogAggregationStatusForAppReport()</pre>
</li>
</ul>
<a name="getAmNodeLabelExpression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAmNodeLabelExpression</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;getAmNodeLabelExpression()</pre>
<div class="block">Return the node label expression of the AM container.</div>
</li>
</ul>
<a name="getAppNodeLabelExpression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppNodeLabelExpression</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;getAppNodeLabelExpression()</pre>
</li>
</ul>
<a name="getCallerContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCallerContext</h4>
<pre>org.apache.hadoop.ipc.CallerContext&nbsp;getCallerContext()</pre>
</li>
</ul>
<a name="getApplicationTimeouts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationTimeouts</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;org.apache.hadoop.yarn.api.records.ApplicationTimeoutType,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;getApplicationTimeouts()</pre>
</li>
</ul>
<a name="getApplicationPriority--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationPriority</h4>
<pre>org.apache.hadoop.yarn.api.records.Priority&nbsp;getApplicationPriority()</pre>
<div class="block">Get priority of the application.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>priority</dd>
</dl>
</li>
</ul>
<a name="isAppInCompletedStates--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAppInCompletedStates</h4>
<pre>boolean&nbsp;isAppInCompletedStates()</pre>
<div class="block">To verify whether app has reached in its completing/completed states.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True/False to confirm whether app is in final states</dd>
</dl>
</li>
</ul>
<a name="getApplicationPlacementContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplicationPlacementContext</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/placement/ApplicationPlacementContext.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.placement">ApplicationPlacementContext</a>&nbsp;getApplicationPlacementContext()</pre>
<div class="block">Get the application -&gt; queue placement context</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ApplicationPlacementContext</dd>
</dl>
</li>
</ul>
<a name="getApplicationSchedulingEnvs--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getApplicationSchedulingEnvs</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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;getApplicationSchedulingEnvs()</pre>
<div class="block">Get the application scheduling environment variables.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map of envs related to application scheduling preferences.</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/RMApp.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMAppEvent.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.rmapp"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/rmapp/RMApp.html" target="_top">Frames</a></li>
<li><a href="RMApp.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>