Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / api / org / apache / hadoop / yarn / client / api / async / AMRMClientAsync.html
blob: 6bcbf026b05d589f3528441f2d0b5417b623f07b [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:00:53 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AMRMClientAsync (Apache Hadoop Main 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="AMRMClientAsync (Apache Hadoop Main 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":9,"i3":41,"i4":9,"i5":41,"i6":6,"i7":6,"i8":10,"i9":10,"i10":6,"i11":10,"i12":6,"i13":10,"i14":10,"i15":6,"i16":6,"i17":42,"i18":6,"i19":10,"i20":6,"i21":6,"i22":10,"i23":10,"i24":10,"i25":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/AMRMClientAsync.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/client/api/async/NMClientAsync.html" title="class in org.apache.hadoop.yarn.client.api.async"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" target="_top">Frames</a></li>
<li><a href="AMRMClientAsync.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.client.api.async</div>
<h2 title="Class AMRMClientAsync" class="title">Class AMRMClientAsync&lt;T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/hadoop/service/AbstractService.html" title="class in org.apache.hadoop.service">org.apache.hadoop.service.AbstractService</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.yarn.client.api.async.AMRMClientAsync&lt;T&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../../../../org/apache/hadoop/service/Service.html" title="interface in org.apache.hadoop.service">Service</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract class <span class="typeNameLabel">AMRMClientAsync&lt;T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest&gt;</span>
extends <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html" title="class in org.apache.hadoop.service">AbstractService</a></pre>
<div class="block"><code>AMRMClientAsync</code> handles communication with the ResourceManager
and provides asynchronous updates on events such as container allocations and
completions. It contains a thread that sends periodic heartbeats to the
ResourceManager.
It should be used by implementing a CallbackHandler:
<pre>
<code>
class MyCallbackHandler extends AMRMClientAsync.AbstractCallbackHandler {
public void onContainersAllocated(List&lt;Container&gt; containers) {
[run tasks on the containers]
}
public void onContainersUpdated(List&lt;Container&gt; containers) {
[determine if resource allocation of containers have been increased in
the ResourceManager, and if so, inform the NodeManagers to increase the
resource monitor/enforcement on the containers]
}
public void onContainersCompleted(List&lt;ContainerStatus&gt; statuses) {
[update progress, check whether app is done]
}
public void onNodesUpdated(List&lt;NodeReport&gt; updated) {}
public void onReboot() {}
}
</code>
</pre>
The client's lifecycle should be managed similarly to the following:
<pre>
<code>
AMRMClientAsync asyncClient =
createAMRMClientAsync(appAttId, 1000, new MyCallbackhandler());
asyncClient.init(conf);
asyncClient.start();
RegisterApplicationMasterResponse response = asyncClient
.registerApplicationMaster(appMasterHostname, appMasterRpcPort,
appMasterTrackingUrl);
asyncClient.addContainerRequest(containerRequest);
[... wait for application to complete]
asyncClient.unregisterApplicationMaster(status, appMsg, trackingUrl);
asyncClient.stop();
</code>
</pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api">AMRMClient</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#client">client</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#handler">handler</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicInteger.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicInteger</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#heartbeatIntervalMs">heartbeatIntervalMs</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#AMRMClientAsync-org.apache.hadoop.yarn.client.api.AMRMClient-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler-">AMRMClientAsync</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api">AMRMClient</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&gt;&nbsp;client,
int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler&nbsp;callbackHandler)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#AMRMClientAsync-org.apache.hadoop.yarn.client.api.AMRMClient-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler-">AMRMClientAsync</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api">AMRMClient</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&gt;&nbsp;client,
int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler&nbsp;callbackHandler)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#AMRMClientAsync-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler-">AMRMClientAsync</a></span>(int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler&nbsp;callbackHandler)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#AMRMClientAsync-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler-">AMRMClientAsync</a></span>(int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler&nbsp;callbackHandler)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#addContainerRequest-T-">addContainerRequest</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&nbsp;req)</code>
<div class="block">Request containers for resources before calling <code>allocate</code></div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#addSchedulingRequests-java.util.Collection-">addSchedulingRequests</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/api/records/SchedulingRequest.html" title="class in org.apache.hadoop.yarn.api.records">SchedulingRequest</a>&gt;&nbsp;schedulingRequests)</code>
<div class="block">Add a Collection of SchedulingRequests.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static &lt;T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest&gt;<br><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="class in org.apache.hadoop.yarn.client.api.async">AMRMClientAsync</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#createAMRMClientAsync-org.apache.hadoop.yarn.client.api.AMRMClient-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler-">createAMRMClientAsync</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api">AMRMClient</a>&lt;T&gt;&nbsp;client,
int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler&nbsp;callbackHandler)</code>
<div class="block">Create a new instance of AMRMClientAsync.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static &lt;T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest&gt;<br><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="class in org.apache.hadoop.yarn.client.api.async">AMRMClientAsync</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#createAMRMClientAsync-org.apache.hadoop.yarn.client.api.AMRMClient-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler-">createAMRMClientAsync</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api">AMRMClient</a>&lt;T&gt;&nbsp;client,
int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler&nbsp;callbackHandler)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#createAMRMClientAsync-org.apache.hadoop.yarn.client.api.AMRMClient-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler-"><code>createAMRMClientAsync(AMRMClient,
int, AMRMClientAsync.AbstractCallbackHandler)</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static &lt;T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest&gt;<br><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="class in org.apache.hadoop.yarn.client.api.async">AMRMClientAsync</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#createAMRMClientAsync-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler-">createAMRMClientAsync</a></span>(int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler&nbsp;callbackHandler)</code>
<div class="block">Create a new instance of AMRMClientAsync.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static &lt;T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest&gt;<br><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="class in org.apache.hadoop.yarn.client.api.async">AMRMClientAsync</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#createAMRMClientAsync-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler-">createAMRMClientAsync</a></span>(int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler&nbsp;callbackHandler)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#createAMRMClientAsync-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler-"><code>createAMRMClientAsync(int,
AMRMClientAsync.AbstractCallbackHandler)</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#getAvailableResources--">getAvailableResources</a></span>()</code>
<div class="block">Get the currently available resources in the cluster.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#getClusterNodeCount--">getClusterNodeCount</a></span>()</code>
<div class="block">Get the current number of nodes in the cluster.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#getMatchingRequests-long-">getMatchingRequests</a></span>(long&nbsp;allocationRequestId)</code>
<div class="block">Returns all matching ContainerRequests that match the given
AllocationRequestId.</div>
</td>
</tr>
<tr id="i9" 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;? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#getMatchingRequests-org.apache.hadoop.yarn.api.records.Priority-java.lang.String-org.apache.hadoop.yarn.api.records.ExecutionType-org.apache.hadoop.yarn.api.records.Resource-">getMatchingRequests</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a>&nbsp;priority,
<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;resourceName,
<a href="../../../../../../../org/apache/hadoop/yarn/api/records/ExecutionType.html" title="enum in org.apache.hadoop.yarn.api.records">ExecutionType</a>&nbsp;executionType,
<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;capability)</code>
<div class="block">Returns all matching ContainerRequests that match the given Priority,
ResourceName, ExecutionType and Capability.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>abstract <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;? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#getMatchingRequests-org.apache.hadoop.yarn.api.records.Priority-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">getMatchingRequests</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a>&nbsp;priority,
<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;resourceName,
<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;capability)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.yarn.client.api.TimelineV2Client</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#getRegisteredTimelineV2Client--">getRegisteredTimelineV2Client</a></span>()</code>
<div class="block">Get registered timeline client.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../../../org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">RegisterApplicationMasterResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#registerApplicationMaster-java.lang.String-int-java.lang.String-">registerApplicationMaster</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;appHostName,
int&nbsp;appHostPort,
<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;appTrackingUrl)</code>
<div class="block">Registers this application master with the resource manager.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">RegisterApplicationMasterResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#registerApplicationMaster-java.lang.String-int-java.lang.String-java.util.Map-">registerApplicationMaster</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;appHostName,
int&nbsp;appHostPort,
<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;appTrackingUrl,
<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/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;,<a href="../../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint</a>&gt;&nbsp;placementConstraints)</code>
<div class="block">Register the application master.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#registerTimelineV2Client-org.apache.hadoop.yarn.client.api.TimelineV2Client-">registerTimelineV2Client</a></span>(org.apache.hadoop.yarn.client.api.TimelineV2Client&nbsp;timelineClient)</code>
<div class="block">Register TimelineClient to AMRMClient.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#releaseAssignedContainer-org.apache.hadoop.yarn.api.records.ContainerId-">releaseAssignedContainer</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records">ContainerId</a>&nbsp;containerId)</code>
<div class="block">Release containers assigned by the Resource Manager.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#removeContainerRequest-T-">removeContainerRequest</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&nbsp;req)</code>
<div class="block">Remove previous container request.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#requestContainerResourceChange-org.apache.hadoop.yarn.api.records.Container-org.apache.hadoop.yarn.api.records.Resource-">requestContainerResourceChange</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Container.html" title="class in org.apache.hadoop.yarn.api.records">Container</a>&nbsp;container,
<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;capability)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use
<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#requestContainerUpdate-org.apache.hadoop.yarn.api.records.Container-org.apache.hadoop.yarn.api.records.UpdateContainerRequest-"><code>requestContainerUpdate(Container, UpdateContainerRequest)</code></a></span></div>
</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#requestContainerUpdate-org.apache.hadoop.yarn.api.records.Container-org.apache.hadoop.yarn.api.records.UpdateContainerRequest-">requestContainerUpdate</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Container.html" title="class in org.apache.hadoop.yarn.api.records">Container</a>&nbsp;container,
<a href="../../../../../../../org/apache/hadoop/yarn/api/records/UpdateContainerRequest.html" title="class in org.apache.hadoop.yarn.api.records">UpdateContainerRequest</a>&nbsp;updateContainerRequest)</code>
<div class="block">Request a container update before calling <code>allocate</code>.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#setHeartbeatInterval-int-">setHeartbeatInterval</a></span>(int&nbsp;interval)</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#unregisterApplicationMaster-org.apache.hadoop.yarn.api.records.FinalApplicationStatus-java.lang.String-java.lang.String-">unregisterApplicationMaster</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/api/records/FinalApplicationStatus.html" title="enum in org.apache.hadoop.yarn.api.records">FinalApplicationStatus</a>&nbsp;appStatus,
<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;appMessage,
<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;appTrackingUrl)</code>
<div class="block">Unregister the application master.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#updateBlacklist-java.util.List-java.util.List-">updateBlacklist</a></span>(<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;<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;blacklistAdditions,
<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;<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;blacklistRemovals)</code>
<div class="block">Update application's blacklist with addition or removal resources.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#updateTrackingUrl-java.lang.String-">updateTrackingUrl</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;trackingUrl)</code>
<div class="block">Update application's tracking url on next heartbeat.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#waitFor-java.util.function.Supplier-">waitFor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;&nbsp;check)</code>
<div class="block">Wait for <code>check</code> to return true for each 1000 ms.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#waitFor-java.util.function.Supplier-int-">waitFor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;&nbsp;check,
int&nbsp;checkEveryMillis)</code>
<div class="block">Wait for <code>check</code> to return true for each
<code>checkEveryMillis</code> ms.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#waitFor-java.util.function.Supplier-int-int-">waitFor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;&nbsp;check,
int&nbsp;checkEveryMillis,
int&nbsp;logInterval)</code>
<div class="block">Wait for <code>check</code> to return true for each
<code>checkEveryMillis</code> ms.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.service.AbstractService">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.service.<a href="../../../../../../../org/apache/hadoop/service/AbstractService.html" title="class in org.apache.hadoop.service">AbstractService</a></h3>
<code><a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#close--">close</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#getBlockers--">getBlockers</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#getConfig--">getConfig</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#getFailureCause--">getFailureCause</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#getFailureState--">getFailureState</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#getLifecycleHistory--">getLifecycleHistory</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#getName--">getName</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#getServiceState--">getServiceState</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#getStartTime--">getStartTime</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#init-org.apache.hadoop.conf.Configuration-">init</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#isInState-org.apache.hadoop.service.Service.STATE-">isInState</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#noteFailure-java.lang.Exception-">noteFailure</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#putBlocker-java.lang.String-java.lang.String-">putBlocker</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#registerGlobalListener-org.apache.hadoop.service.ServiceStateChangeListener-">registerGlobalListener</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#registerServiceListener-org.apache.hadoop.service.ServiceStateChangeListener-">registerServiceListener</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#removeBlocker-java.lang.String-">removeBlocker</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#serviceInit-org.apache.hadoop.conf.Configuration-">serviceInit</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#serviceStart--">serviceStart</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#serviceStop--">serviceStop</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#setConfig-org.apache.hadoop.conf.Configuration-">setConfig</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#start--">start</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#stop--">stop</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#toString--">toString</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#unregisterGlobalListener-org.apache.hadoop.service.ServiceStateChangeListener-">unregisterGlobalListener</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#unregisterServiceListener-org.apache.hadoop.service.ServiceStateChangeListener-">unregisterServiceListener</a>, <a href="../../../../../../../org/apache/hadoop/service/AbstractService.html#waitForServiceToStop-long-">waitForServiceToStop</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="client">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>client</h4>
<pre>protected final&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api">AMRMClient</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a> extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest&gt; client</pre>
</li>
</ul>
<a name="handler">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handler</h4>
<pre>protected final&nbsp;org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler handler</pre>
</li>
</ul>
<a name="heartbeatIntervalMs">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>heartbeatIntervalMs</h4>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicInteger.html?is-external=true" title="class or interface in java.util.concurrent.atomic">AtomicInteger</a> heartbeatIntervalMs</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AMRMClientAsync-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AMRMClientAsync</h4>
<pre>protected&nbsp;AMRMClientAsync(int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler&nbsp;callbackHandler)</pre>
</li>
</ul>
<a name="AMRMClientAsync-org.apache.hadoop.yarn.client.api.AMRMClient-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AMRMClientAsync</h4>
<pre>@InterfaceAudience.Private
protected&nbsp;AMRMClientAsync(<a href="../../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api">AMRMClient</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&gt;&nbsp;client,
int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler&nbsp;callbackHandler)</pre>
</li>
</ul>
<a name="AMRMClientAsync-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AMRMClientAsync</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
protected&nbsp;AMRMClientAsync(int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler&nbsp;callbackHandler)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="AMRMClientAsync-org.apache.hadoop.yarn.client.api.AMRMClient-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AMRMClientAsync</h4>
<pre>@InterfaceAudience.Private
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
protected&nbsp;AMRMClientAsync(<a href="../../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api">AMRMClient</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&gt;&nbsp;client,
int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler&nbsp;callbackHandler)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createAMRMClientAsync-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAMRMClientAsync</h4>
<pre>public static&nbsp;&lt;T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest&gt;&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="class in org.apache.hadoop.yarn.client.api.async">AMRMClientAsync</a>&lt;T&gt;&nbsp;createAMRMClientAsync(int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler&nbsp;callbackHandler)</pre>
<div class="block"><p>Create a new instance of AMRMClientAsync.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>intervalMs</code> - heartbeat interval in milliseconds between AM and RM</dd>
<dd><code>callbackHandler</code> - callback handler that processes responses from
the <code>ResourceManager</code></dd>
</dl>
</li>
</ul>
<a name="createAMRMClientAsync-org.apache.hadoop.yarn.client.api.AMRMClient-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAMRMClientAsync</h4>
<pre>public static&nbsp;&lt;T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest&gt;&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="class in org.apache.hadoop.yarn.client.api.async">AMRMClientAsync</a>&lt;T&gt;&nbsp;createAMRMClientAsync(<a href="../../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api">AMRMClient</a>&lt;T&gt;&nbsp;client,
int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler&nbsp;callbackHandler)</pre>
<div class="block"><p>Create a new instance of AMRMClientAsync.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>client</code> - the AMRMClient instance</dd>
<dd><code>intervalMs</code> - heartbeat interval in milliseconds between AM and RM</dd>
<dd><code>callbackHandler</code> - callback handler that processes responses from
the <code>ResourceManager</code></dd>
</dl>
</li>
</ul>
<a name="createAMRMClientAsync-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAMRMClientAsync</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static&nbsp;&lt;T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest&gt;&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="class in org.apache.hadoop.yarn.client.api.async">AMRMClientAsync</a>&lt;T&gt;&nbsp;createAMRMClientAsync(int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler&nbsp;callbackHandler)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#createAMRMClientAsync-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler-"><code>createAMRMClientAsync(int,
AMRMClientAsync.AbstractCallbackHandler)</code></a> instead.</span></div>
</li>
</ul>
<a name="createAMRMClientAsync-org.apache.hadoop.yarn.client.api.AMRMClient-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAMRMClientAsync</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static&nbsp;&lt;T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest&gt;&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="class in org.apache.hadoop.yarn.client.api.async">AMRMClientAsync</a>&lt;T&gt;&nbsp;createAMRMClientAsync(<a href="../../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api">AMRMClient</a>&lt;T&gt;&nbsp;client,
int&nbsp;intervalMs,
org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.CallbackHandler&nbsp;callbackHandler)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#createAMRMClientAsync-org.apache.hadoop.yarn.client.api.AMRMClient-int-org.apache.hadoop.yarn.client.api.async.AMRMClientAsync.AbstractCallbackHandler-"><code>createAMRMClientAsync(AMRMClient,
int, AMRMClientAsync.AbstractCallbackHandler)</code></a> instead.</span></div>
</li>
</ul>
<a name="setHeartbeatInterval-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeartbeatInterval</h4>
<pre>public&nbsp;void&nbsp;setHeartbeatInterval(int&nbsp;interval)</pre>
</li>
</ul>
<a name="getMatchingRequests-org.apache.hadoop.yarn.api.records.Priority-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMatchingRequests</h4>
<pre>public abstract&nbsp;<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;? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&gt;&gt;&nbsp;getMatchingRequests(<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a>&nbsp;priority,
<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;resourceName,
<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;capability)</pre>
</li>
</ul>
<a name="addSchedulingRequests-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSchedulingRequests</h4>
<pre>@InterfaceAudience.Public
@InterfaceStability.Unstable
public&nbsp;void&nbsp;addSchedulingRequests(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/api/records/SchedulingRequest.html" title="class in org.apache.hadoop.yarn.api.records">SchedulingRequest</a>&gt;&nbsp;schedulingRequests)</pre>
<div class="block">Add a Collection of SchedulingRequests. The AMRMClient will ensure that
all requests in the same batch are sent in the same allocate call.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schedulingRequests</code> - Collection of Scheduling Requests.</dd>
</dl>
</li>
</ul>
<a name="getMatchingRequests-org.apache.hadoop.yarn.api.records.Priority-java.lang.String-org.apache.hadoop.yarn.api.records.ExecutionType-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMatchingRequests</h4>
<pre>public&nbsp;<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;? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&gt;&gt;&nbsp;getMatchingRequests(<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a>&nbsp;priority,
<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;resourceName,
<a href="../../../../../../../org/apache/hadoop/yarn/api/records/ExecutionType.html" title="enum in org.apache.hadoop.yarn.api.records">ExecutionType</a>&nbsp;executionType,
<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;capability)</pre>
<div class="block">Returns all matching ContainerRequests that match the given Priority,
ResourceName, ExecutionType and Capability.
NOTE: This matches only requests that were made by the client WITHOUT the
allocationRequestId specified.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>priority</code> - Priority.</dd>
<dd><code>resourceName</code> - Location.</dd>
<dd><code>executionType</code> - ExecutionType.</dd>
<dd><code>capability</code> - Capability.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>All matching ContainerRequests</dd>
</dl>
</li>
</ul>
<a name="getMatchingRequests-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMatchingRequests</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&gt;&nbsp;getMatchingRequests(long&nbsp;allocationRequestId)</pre>
<div class="block">Returns all matching ContainerRequests that match the given
AllocationRequestId.
NOTE: This matches only requests that were made by the client WITH the
allocationRequestId specified.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allocationRequestId</code> - AllocationRequestId.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>All matching ContainerRequests</dd>
</dl>
</li>
</ul>
<a name="registerApplicationMaster-java.lang.String-int-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerApplicationMaster</h4>
<pre>public abstract&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">RegisterApplicationMasterResponse</a>&nbsp;registerApplicationMaster(<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;appHostName,
int&nbsp;appHostPort,
<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;appTrackingUrl)
throws <a href="../../../../../../../org/apache/hadoop/yarn/exceptions/YarnException.html" title="class in org.apache.hadoop.yarn.exceptions">YarnException</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">Registers this application master with the resource manager. On successful
registration, starts the heartbeating thread.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/exceptions/YarnException.html" title="class in org.apache.hadoop.yarn.exceptions">YarnException</a></code></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></dd>
</dl>
</li>
</ul>
<a name="registerApplicationMaster-java.lang.String-int-java.lang.String-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerApplicationMaster</h4>
<pre>@InterfaceAudience.Public
@InterfaceStability.Unstable
public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">RegisterApplicationMasterResponse</a>&nbsp;registerApplicationMaster(<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;appHostName,
int&nbsp;appHostPort,
<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;appTrackingUrl,
<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/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;,<a href="../../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint</a>&gt;&nbsp;placementConstraints)
throws <a href="../../../../../../../org/apache/hadoop/yarn/exceptions/YarnException.html" title="class in org.apache.hadoop.yarn.exceptions">YarnException</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">Register the application master. This must be called before any
other interaction</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>appHostName</code> - Name of the host on which master is running</dd>
<dd><code>appHostPort</code> - Port master is listening on</dd>
<dd><code>appTrackingUrl</code> - URL at which the master info can be seen</dd>
<dd><code>placementConstraints</code> - Placement Constraints mappings.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>RegisterApplicationMasterResponse</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/exceptions/YarnException.html" title="class in org.apache.hadoop.yarn.exceptions">YarnException</a></code></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></dd>
</dl>
</li>
</ul>
<a name="unregisterApplicationMaster-org.apache.hadoop.yarn.api.records.FinalApplicationStatus-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unregisterApplicationMaster</h4>
<pre>public abstract&nbsp;void&nbsp;unregisterApplicationMaster(<a href="../../../../../../../org/apache/hadoop/yarn/api/records/FinalApplicationStatus.html" title="enum in org.apache.hadoop.yarn.api.records">FinalApplicationStatus</a>&nbsp;appStatus,
<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;appMessage,
<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;appTrackingUrl)
throws <a href="../../../../../../../org/apache/hadoop/yarn/exceptions/YarnException.html" title="class in org.apache.hadoop.yarn.exceptions">YarnException</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">Unregister the application master. This must be called in the end.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>appStatus</code> - Success/Failure status of the master</dd>
<dd><code>appMessage</code> - Diagnostics message on failure</dd>
<dd><code>appTrackingUrl</code> - New URL to get master info</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/exceptions/YarnException.html" title="class in org.apache.hadoop.yarn.exceptions">YarnException</a></code></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></dd>
</dl>
</li>
</ul>
<a name="addContainerRequest-org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest-">
<!-- -->
</a><a name="addContainerRequest-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addContainerRequest</h4>
<pre>public abstract&nbsp;void&nbsp;addContainerRequest(<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&nbsp;req)</pre>
<div class="block">Request containers for resources before calling <code>allocate</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>req</code> - Resource request</dd>
</dl>
</li>
</ul>
<a name="removeContainerRequest-org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest-">
<!-- -->
</a><a name="removeContainerRequest-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeContainerRequest</h4>
<pre>public abstract&nbsp;void&nbsp;removeContainerRequest(<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" title="type parameter in AMRMClientAsync">T</a>&nbsp;req)</pre>
<div class="block">Remove previous container request. The previous container request may have
already been sent to the ResourceManager. So even after the remove request
the app must be prepared to receive an allocation for the previous request
even after the remove request</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>req</code> - Resource request</dd>
</dl>
</li>
</ul>
<a name="requestContainerResourceChange-org.apache.hadoop.yarn.api.records.Container-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestContainerResourceChange</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;void&nbsp;requestContainerResourceChange(<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Container.html" title="class in org.apache.hadoop.yarn.api.records">Container</a>&nbsp;container,
<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;capability)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use
<a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#requestContainerUpdate-org.apache.hadoop.yarn.api.records.Container-org.apache.hadoop.yarn.api.records.UpdateContainerRequest-"><code>requestContainerUpdate(Container, UpdateContainerRequest)</code></a></span></div>
<div class="block">Request container resource change before calling <code>allocate</code>.
Any previous pending resource change request of the same container will be
removed.
Application that calls this method is expected to maintain the
<code>Container</code>s that are returned from previous successful
allocations or resource changes. By passing in the existing container and a
target resource capability to this method, the application requests the
ResourceManager to change the existing resource allocation to the target
resource allocation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>container</code> - The container returned from the last successful resource
allocation or resource change</dd>
<dd><code>capability</code> - The target resource capability of the container</dd>
</dl>
</li>
</ul>
<a name="requestContainerUpdate-org.apache.hadoop.yarn.api.records.Container-org.apache.hadoop.yarn.api.records.UpdateContainerRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestContainerUpdate</h4>
<pre>public abstract&nbsp;void&nbsp;requestContainerUpdate(<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Container.html" title="class in org.apache.hadoop.yarn.api.records">Container</a>&nbsp;container,
<a href="../../../../../../../org/apache/hadoop/yarn/api/records/UpdateContainerRequest.html" title="class in org.apache.hadoop.yarn.api.records">UpdateContainerRequest</a>&nbsp;updateContainerRequest)</pre>
<div class="block">Request a container update before calling <code>allocate</code>.
Any previous pending update request of the same container will be
removed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>container</code> - The container returned from the last successful resource
allocation or update</dd>
<dd><code>updateContainerRequest</code> - The <code>UpdateContainerRequest</code>.</dd>
</dl>
</li>
</ul>
<a name="releaseAssignedContainer-org.apache.hadoop.yarn.api.records.ContainerId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>releaseAssignedContainer</h4>
<pre>public abstract&nbsp;void&nbsp;releaseAssignedContainer(<a href="../../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records">ContainerId</a>&nbsp;containerId)</pre>
<div class="block">Release containers assigned by the Resource Manager. If the app cannot use
the container or wants to give up the container then it can release them.
The app needs to make new requests for the released resource capability if
it still needs it. eg. it released non-local resources</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - </dd>
</dl>
</li>
</ul>
<a name="getAvailableResources--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAvailableResources</h4>
<pre>public abstract&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a>&nbsp;getAvailableResources()</pre>
<div class="block">Get the currently available resources in the cluster.
A valid value is available after a call to allocate has been made</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Currently available resources</dd>
</dl>
</li>
</ul>
<a name="getClusterNodeCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClusterNodeCount</h4>
<pre>public abstract&nbsp;int&nbsp;getClusterNodeCount()</pre>
<div class="block">Get the current number of nodes in the cluster.
A valid values is available after a call to allocate has been made</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Current number of nodes in the cluster</dd>
</dl>
</li>
</ul>
<a name="registerTimelineV2Client-org.apache.hadoop.yarn.client.api.TimelineV2Client-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerTimelineV2Client</h4>
<pre>public&nbsp;void&nbsp;registerTimelineV2Client(org.apache.hadoop.yarn.client.api.TimelineV2Client&nbsp;timelineClient)
throws <a href="../../../../../../../org/apache/hadoop/yarn/exceptions/YarnException.html" title="class in org.apache.hadoop.yarn.exceptions">YarnException</a></pre>
<div class="block">Register TimelineClient to AMRMClient.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timelineClient</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/exceptions/YarnException.html" title="class in org.apache.hadoop.yarn.exceptions">YarnException</a></code> - when this method is invoked even when ATS V2 is not
configured.</dd>
</dl>
</li>
</ul>
<a name="getRegisteredTimelineV2Client--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRegisteredTimelineV2Client</h4>
<pre>public&nbsp;org.apache.hadoop.yarn.client.api.TimelineV2Client&nbsp;getRegisteredTimelineV2Client()</pre>
<div class="block">Get registered timeline client.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the registered timeline client</dd>
</dl>
</li>
</ul>
<a name="updateBlacklist-java.util.List-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateBlacklist</h4>
<pre>public abstract&nbsp;void&nbsp;updateBlacklist(<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;<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;blacklistAdditions,
<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;<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;blacklistRemovals)</pre>
<div class="block">Update application's blacklist with addition or removal resources.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>blacklistAdditions</code> - list of resources which should be added to the
application blacklist</dd>
<dd><code>blacklistRemovals</code> - list of resources which should be removed from the
application blacklist</dd>
</dl>
</li>
</ul>
<a name="updateTrackingUrl-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateTrackingUrl</h4>
<pre>@InterfaceAudience.Public
@InterfaceStability.Unstable
public&nbsp;void&nbsp;updateTrackingUrl(<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;trackingUrl)</pre>
<div class="block">Update application's tracking url on next heartbeat.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>trackingUrl</code> - new tracking url for this application</dd>
</dl>
</li>
</ul>
<a name="waitFor-java.util.function.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>waitFor</h4>
<pre>public&nbsp;void&nbsp;waitFor(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;&nbsp;check)
throws <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">Wait for <code>check</code> to return true for each 1000 ms.
See also <a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#waitFor-java.util.function.Supplier-int-"><code>waitFor(java.util.function.Supplier, int)</code></a>
and <a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#waitFor-java.util.function.Supplier-int-int-"><code>waitFor(java.util.function.Supplier, int, int)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>check</code> - the condition for which it should wait</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<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></dd>
</dl>
</li>
</ul>
<a name="waitFor-java.util.function.Supplier-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>waitFor</h4>
<pre>public&nbsp;void&nbsp;waitFor(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;&nbsp;check,
int&nbsp;checkEveryMillis)
throws <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">Wait for <code>check</code> to return true for each
<code>checkEveryMillis</code> ms.
See also <a href="../../../../../../../org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html#waitFor-java.util.function.Supplier-int-int-"><code>waitFor(java.util.function.Supplier, int, int)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>check</code> - user defined checker</dd>
<dd><code>checkEveryMillis</code> - interval to call <code>check</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<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></dd>
</dl>
</li>
</ul>
<a name="waitFor-java.util.function.Supplier-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>waitFor</h4>
<pre>public&nbsp;void&nbsp;waitFor(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;&nbsp;check,
int&nbsp;checkEveryMillis,
int&nbsp;logInterval)
throws <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">Wait for <code>check</code> to return true for each
<code>checkEveryMillis</code> ms. In the main loop, this method will log
the message "waiting in main loop" for each <code>logInterval</code> times
iteration to confirm the thread is alive.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>check</code> - user defined checker</dd>
<dd><code>checkEveryMillis</code> - interval to call <code>check</code></dd>
<dd><code>logInterval</code> - interval to log for each</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<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></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/AMRMClientAsync.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/client/api/async/NMClientAsync.html" title="class in org.apache.hadoop.yarn.client.api.async"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/client/api/async/AMRMClientAsync.html" target="_top">Frames</a></li>
<li><a href="AMRMClientAsync.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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; 2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>