| <!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:52 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AMRMClient (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="AMRMClient (Apache Hadoop Main 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":10,"i2":6,"i3":9,"i4":6,"i5":6,"i6":6,"i7":10,"i8":10,"i9":6,"i10":10,"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/AMRMClient.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/client/api/AHSClient.html" title="class in org.apache.hadoop.yarn.client.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/client/api/AppAdminClient.html" title="class in org.apache.hadoop.yarn.client.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/client/api/AMRMClient.html" target="_top">Frames</a></li> |
| <li><a href="AMRMClient.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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</div> |
| <h2 title="Class AMRMClient" class="title">Class AMRMClient<T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest></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.AMRMClient<T></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">AMRMClient<T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest></span> |
| extends <a href="../../../../../../org/apache/hadoop/service/AbstractService.html" title="class in org.apache.hadoop.service">AbstractService</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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"> </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/AMRMClient.html#AMRMClient-java.lang.String-">AMRMClient</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> name)</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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/AMRMClient.html#addContainerRequest-T-">addContainerRequest</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="type parameter in AMRMClient">T</a> 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/AMRMClient.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><<a href="../../../../../../org/apache/hadoop/yarn/api/records/SchedulingRequest.html" title="class in org.apache.hadoop.yarn.api.records">SchedulingRequest</a>> schedulingRequests)</code> |
| <div class="block">Add a Collection of SchedulingRequests.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">AllocateResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html#allocate-float-">allocate</a></span>(float progressIndicator)</code> |
| <div class="block">Request additional containers and receive new container allocations.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest><br><a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api">AMRMClient</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html#createAMRMClient--">createAMRMClient</a></span>()</code> |
| <div class="block">Create a new instance of AMRMClient.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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/AMRMClient.html#getAvailableResources--">getAvailableResources</a></span>()</code> |
| <div class="block">Get the currently available resources in the cluster.</div> |
| </td> |
| </tr> |
| <tr id="i5" 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/AMRMClient.html#getClusterNodeCount--">getClusterNodeCount</a></span>()</code> |
| <div class="block">Get the current number of nodes in the cluster.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract <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><<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="type parameter in AMRMClient">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html#getMatchingRequests-long-">getMatchingRequests</a></span>(long allocationRequestId)</code> |
| <div class="block">Get outstanding <code>ContainerRequest</code>s matching the given |
| allocationRequestId.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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><? 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><<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="type parameter in AMRMClient">T</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.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> 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> resourceName, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/ExecutionType.html" title="enum in org.apache.hadoop.yarn.api.records">ExecutionType</a> executionType, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> capability)</code> |
| <div class="block">Get outstanding <code>ContainerRequest</code>s matching the given |
| parameters.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <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><? 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><<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="type parameter in AMRMClient">T</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.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-java.lang.String-">getMatchingRequests</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a> 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> resourceName, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/ExecutionType.html" title="enum in org.apache.hadoop.yarn.api.records">ExecutionType</a> executionType, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> capability, |
| <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> profile)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <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><? 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><<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="type parameter in AMRMClient">T</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.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> 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> resourceName, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> capability)</code> |
| <div class="block">Get outstanding <code>ContainerRequest</code>s matching the given |
| parameters.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html" title="class in org.apache.hadoop.yarn.client.api">NMTokenCache</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html#getNMTokenCache--">getNMTokenCache</a></span>()</code> |
| <div class="block">Get the NM token cache of the <code>AMRMClient</code>.</div> |
| </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/AMRMClient.html#getRegisteredTimelineV2Client--">getRegisteredTimelineV2Client</a></span>()</code> |
| <div class="block">Get registered timeline v2 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/AMRMClient.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> appHostName, |
| int 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> appTrackingUrl)</code> |
| <div class="block">Register the application master.</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/AMRMClient.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> appHostName, |
| int 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> 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><<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><<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="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint</a>> 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/AMRMClient.html#registerTimelineV2Client-org.apache.hadoop.yarn.client.api.TimelineV2Client-">registerTimelineV2Client</a></span>(org.apache.hadoop.yarn.client.api.TimelineV2Client client)</code> |
| <div class="block">Register TimelineV2Client 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/AMRMClient.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> 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/AMRMClient.html#removeContainerRequest-T-">removeContainerRequest</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="type parameter in AMRMClient">T</a> 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/AMRMClient.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> container, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> capability)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use |
| <a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.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/AMRMClient.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> container, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/UpdateContainerRequest.html" title="class in org.apache.hadoop.yarn.api.records">UpdateContainerRequest</a> 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/AMRMClient.html#setNMTokenCache-org.apache.hadoop.yarn.client.api.NMTokenCache-">setNMTokenCache</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html" title="class in org.apache.hadoop.yarn.client.api">NMTokenCache</a> nmTokenCache)</code> |
| <div class="block">Set the NM token cache for the <code>AMRMClient</code>.</div> |
| </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/AMRMClient.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> 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> 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> 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/AMRMClient.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><<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>> 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><<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>> 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/AMRMClient.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> 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/AMRMClient.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><<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>> 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/AMRMClient.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><<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>> check, |
| int 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/AMRMClient.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><<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>> check, |
| int checkEveryMillis, |
| int 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 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 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AMRMClient-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AMRMClient</h4> |
| <pre>@InterfaceAudience.Private |
| protected AMRMClient(<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> name)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createAMRMClient--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAMRMClient</h4> |
| <pre>@InterfaceAudience.Public |
| public static <T extends org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest> <a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="class in org.apache.hadoop.yarn.client.api">AMRMClient</a><T> createAMRMClient()</pre> |
| <div class="block">Create a new instance of AMRMClient. |
| For usage: |
| <pre> |
| <code> |
| AMRMClient.<T>createAMRMClientContainerRequest() |
| </code></pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly create AMRMClient instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addSchedulingRequests-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSchedulingRequests</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| public void 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><<a href="../../../../../../org/apache/hadoop/yarn/api/records/SchedulingRequest.html" title="class in org.apache.hadoop.yarn.api.records">SchedulingRequest</a>> 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="registerApplicationMaster-java.lang.String-int-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerApplicationMaster</h4> |
| <pre>public abstract <a href="../../../../../../org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">RegisterApplicationMasterResponse</a> 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> appHostName, |
| int 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> 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">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> |
| <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="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 <a href="../../../../../../org/apache/hadoop/yarn/api/protocolrecords/RegisterApplicationMasterResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">RegisterApplicationMasterResponse</a> 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> appHostName, |
| int 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> 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><<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><<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="../../../../../../org/apache/hadoop/yarn/api/resource/PlacementConstraint.html" title="class in org.apache.hadoop.yarn.api.resource">PlacementConstraint</a>> 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="allocate-float-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocate</h4> |
| <pre>public abstract <a href="../../../../../../org/apache/hadoop/yarn/api/protocolrecords/AllocateResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">AllocateResponse</a> allocate(float progressIndicator) |
| 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">Request additional containers and receive new container allocations. |
| Requests made via <code>addContainerRequest</code> are sent to the |
| <code>ResourceManager</code>. New containers assigned to the master are |
| retrieved. Status of completed containers and node health updates are also |
| retrieved. This also doubles up as a heartbeat to the ResourceManager and |
| must be made periodically. The call may not always return any new |
| allocations of containers. App should not make concurrent allocate |
| requests. May cause request loss. |
| |
| <p> |
| Note : If the user has not removed container requests that have already |
| been satisfied, then the re-register may end up sending the entire |
| container requests to the RM (including matched requests). Which would mean |
| the RM could end up giving it a lot of new allocated containers. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>progressIndicator</code> - Indicates progress made by the master</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the response of the allocate request</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 void unregisterApplicationMaster(<a href="../../../../../../org/apache/hadoop/yarn/api/records/FinalApplicationStatus.html" title="enum in org.apache.hadoop.yarn.api.records">FinalApplicationStatus</a> 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> 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> 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 void addContainerRequest(<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="type parameter in AMRMClient">T</a> 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 void removeContainerRequest(<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="type parameter in AMRMClient">T</a> 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 void requestContainerResourceChange(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html" title="class in org.apache.hadoop.yarn.api.records">Container</a> container, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> capability)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use |
| <a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.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 void requestContainerUpdate(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html" title="class in org.apache.hadoop.yarn.api.records">Container</a> container, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/UpdateContainerRequest.html" title="class in org.apache.hadoop.yarn.api.records">UpdateContainerRequest</a> 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 void releaseAssignedContainer(<a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records">ContainerId</a> 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 <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> 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 int 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="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>@InterfaceStability.Evolving |
| public 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><? 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><<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="type parameter in AMRMClient">T</a>>> getMatchingRequests(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a> 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> resourceName, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> capability)</pre> |
| <div class="block">Get outstanding <code>ContainerRequest</code>s matching the given |
| parameters. These ContainerRequests should have been added via |
| <code>addContainerRequest</code> earlier in the lifecycle. For performance, |
| the AMRMClient may return its internal collection directly without creating |
| a copy. Users should not perform mutable operations on the return value. |
| Each collection in the list contains requests with identical |
| <code>Resource</code> size that fit in the given capability. In a |
| collection, requests will be returned in the same order as they were added. |
| |
| NOTE: This API only matches Container requests that were created by the |
| client WITHOUT the allocationRequestId being set.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Collection of request matching the parameters</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>@InterfaceStability.Evolving |
| public <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><? 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><<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="type parameter in AMRMClient">T</a>>> getMatchingRequests(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a> 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> resourceName, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/ExecutionType.html" title="enum in org.apache.hadoop.yarn.api.records">ExecutionType</a> executionType, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> capability)</pre> |
| <div class="block">Get outstanding <code>ContainerRequest</code>s matching the given |
| parameters. These ContainerRequests should have been added via |
| <code>addContainerRequest</code> earlier in the lifecycle. For performance, |
| the AMRMClient may return its internal collection directly without creating |
| a copy. Users should not perform mutable operations on the return value. |
| Each collection in the list contains requests with identical |
| <code>Resource</code> size that fit in the given capability. In a |
| collection, requests will be returned in the same order as they were added. |
| specify an <code>ExecutionType</code>. |
| |
| NOTE: This API only matches Container requests that were created by the |
| client WITHOUT the allocationRequestId being set.</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>Collection of request matching the parameters</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-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMatchingRequests</h4> |
| <pre>@InterfaceStability.Evolving |
| public <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><? 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><<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="type parameter in AMRMClient">T</a>>> getMatchingRequests(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a> 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> resourceName, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/ExecutionType.html" title="enum in org.apache.hadoop.yarn.api.records">ExecutionType</a> executionType, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> capability, |
| <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> profile)</pre> |
| </li> |
| </ul> |
| <a name="getMatchingRequests-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMatchingRequests</h4> |
| <pre>@InterfaceStability.Evolving |
| public abstract <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><<a href="../../../../../../org/apache/hadoop/yarn/client/api/AMRMClient.html" title="type parameter in AMRMClient">T</a>> getMatchingRequests(long allocationRequestId)</pre> |
| <div class="block">Get outstanding <code>ContainerRequest</code>s matching the given |
| allocationRequestId. These ContainerRequests should have been added via |
| <code>addContainerRequest</code> earlier in the lifecycle. For performance, |
| the AMRMClient may return its internal collection directly without creating |
| a copy. Users should not perform mutable operations on the return value. |
| |
| NOTE: This API only matches Container requests that were created by the |
| client WITH the allocationRequestId being set to a non-default value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allocationRequestId</code> - Allocation Request Id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Collection of request matching the parameters</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 void 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><<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>> 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><<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>> 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="setNMTokenCache-org.apache.hadoop.yarn.client.api.NMTokenCache-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNMTokenCache</h4> |
| <pre>public void setNMTokenCache(<a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html" title="class in org.apache.hadoop.yarn.client.api">NMTokenCache</a> nmTokenCache)</pre> |
| <div class="block">Set the NM token cache for the <code>AMRMClient</code>. This cache must |
| be shared with the <a href="../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api"><code>NMClient</code></a> used to manage containers for the |
| <code>AMRMClient</code> |
| <p> |
| If a NM token cache is not set, the <a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#getSingleton--"><code>NMTokenCache.getSingleton()</code></a> |
| singleton instance will be used.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nmTokenCache</code> - the NM token cache to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNMTokenCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNMTokenCache</h4> |
| <pre>public <a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html" title="class in org.apache.hadoop.yarn.client.api">NMTokenCache</a> getNMTokenCache()</pre> |
| <div class="block">Get the NM token cache of the <code>AMRMClient</code>. This cache must be |
| shared with the <a href="../../../../../../org/apache/hadoop/yarn/client/api/NMClient.html" title="class in org.apache.hadoop.yarn.client.api"><code>NMClient</code></a> used to manage containers for the |
| <code>AMRMClient</code>. |
| <p> |
| If a NM token cache is not set, the <a href="../../../../../../org/apache/hadoop/yarn/client/api/NMTokenCache.html#getSingleton--"><code>NMTokenCache.getSingleton()</code></a> |
| singleton instance will be used.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the NM token cache.</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 void registerTimelineV2Client(org.apache.hadoop.yarn.client.api.TimelineV2Client client)</pre> |
| <div class="block">Register TimelineV2Client to AMRMClient. Writer's address for the timeline |
| V2 client will be updated dynamically if registered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>client</code> - the timeline v2 client to register</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRegisteredTimelineV2Client--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegisteredTimelineV2Client</h4> |
| <pre>public org.apache.hadoop.yarn.client.api.TimelineV2Client getRegisteredTimelineV2Client()</pre> |
| <div class="block">Get registered timeline v2 client.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the registered timeline v2 client</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 void 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> 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 void 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><<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>> 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/AMRMClient.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/AMRMClient.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 void 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><<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>> check, |
| int 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/AMRMClient.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 void 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><<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>> check, |
| int checkEveryMillis, |
| int 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/AMRMClient.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/client/api/AHSClient.html" title="class in org.apache.hadoop.yarn.client.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/client/api/AppAdminClient.html" title="class in org.apache.hadoop.yarn.client.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/client/api/AMRMClient.html" target="_top">Frames</a></li> |
| <li><a href="AMRMClient.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
