| <!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:10:58 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>UnmanagedApplicationManager (Apache Hadoop YARN Server Common 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="UnmanagedApplicationManager (Apache Hadoop YARN Server Common 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/UnmanagedApplicationManager.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedAMPoolManager.html" title="class in org.apache.hadoop.yarn.server.uam"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html" target="_top">Frames</a></li> |
| <li><a href="UnmanagedApplicationManager.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.server.uam</div> |
| <h2 title="Class UnmanagedApplicationManager" class="title">Class UnmanagedApplicationManager</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>org.apache.hadoop.yarn.server.uam.UnmanagedApplicationManager</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| public class <span class="typeNameLabel">UnmanagedApplicationManager</span> |
| extends <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></pre> |
| <div class="block">UnmanagedApplicationManager is used to register unmanaged application and |
| negotiate for resources from resource managers. An unmanagedAM is an AM that |
| is not launched and managed by the RM. Allocate calls are handled |
| asynchronously using <code>AsyncCallback</code>.</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"> </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>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#APP_NAME">APP_NAME</a></span></code> </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"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#UnmanagedApplicationManager-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.String-">UnmanagedApplicationManager</a></span>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName, |
| <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> submitter, |
| <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> appNameSuffix, |
| boolean keepContainersAcrossApplicationAttempts, |
| <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> rmName)</code> |
| <div class="block">Constructor.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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></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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#allocateAsync-org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest-org.apache.hadoop.yarn.util.AsyncCallback-">allocateAsync</a></span>(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest request, |
| org.apache.hadoop.yarn.util.AsyncCallback<org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse> callback)</code> |
| <div class="block">Sends the specified heart beat request to the resource manager and invokes |
| the callback asynchronously with the response.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/hadoop/yarn/server/AMHeartbeatRequestHandler.html" title="class in org.apache.hadoop.yarn.server">AMHeartbeatRequestHandler</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#createAMHeartbeatRequestHandler-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.api.records.ApplicationId-org.apache.hadoop.yarn.server.AMRMClientRelayer-">createAMHeartbeatRequestHandler</a></span>(org.apache.hadoop.conf.Configuration config, |
| org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <a href="../../../../../../org/apache/hadoop/yarn/server/AMRMClientRelayer.html" title="class in org.apache.hadoop.yarn.server">AMRMClientRelayer</a> relayer)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#createRMProxy-java.lang.Class-org.apache.hadoop.conf.Configuration-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.security.token.Token-">createRMProxy</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> protocol, |
| org.apache.hadoop.conf.Configuration config, |
| org.apache.hadoop.security.UserGroupInformation user, |
| org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier> token)</code> |
| <div class="block">Returns RM proxy for the specified protocol type.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#createUAMProxy-org.apache.hadoop.security.token.Token-">createUAMProxy</a></span>(org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier> amrmToken)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#drainHeartbeatThread--">drainHeartbeatThread</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#finishApplicationMaster-org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest-">finishApplicationMaster</a></span>(org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest request)</code> |
| <div class="block">Unregisters from the resource manager and stops the request handler thread.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#forceKillApplication--">forceKillApplication</a></span>()</code> |
| <div class="block">Force kill the UAM.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/yarn/server/AMRMClientRelayer.html" title="class in org.apache.hadoop.yarn.server">AMRMClientRelayer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#getAMRMClientRelayer--">getAMRMClientRelayer</a></span>()</code> |
| <div class="block">Returns the rmProxy relayer of this UAM.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.ApplicationId</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#getAppId--">getAppId</a></span>()</code> |
| <div class="block">Returns the application id of the UAM.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#getRequestQueueSize--">getRequestQueueSize</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#getUAMToken--">getUAMToken</a></span>()</code> |
| <div class="block">Gets the amrmToken of the unmanaged AM.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#initializeUnmanagedAM-org.apache.hadoop.yarn.api.records.ApplicationId-">initializeUnmanagedAM</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId appId)</code> |
| <div class="block">Launch and initialize an unmanaged AM.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#isHeartbeatThreadAlive--">isHeartbeatThreadAlive</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#launchUAM--">launchUAM</a></span>()</code> |
| <div class="block">Launch a new UAM in the resource manager.</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/server/uam/UnmanagedApplicationManager.html#reAttachUAM-org.apache.hadoop.security.token.Token-">reAttachUAM</a></span>(org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier> amrmToken)</code> |
| <div class="block">Re-attach to an existing UAM in the resource manager.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#registerApplicationMaster-org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest-">registerApplicationMaster</a></span>(org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest request)</code> |
| <div class="block">Registers this <a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html" title="class in org.apache.hadoop.yarn.server.uam"><code>UnmanagedApplicationManager</code></a> with the resource |
| manager.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html#shutDownConnections--">shutDownConnections</a></span>()</code> |
| <div class="block">Shutdown this UAM client, without killing the UAM in the YarnRM side.</div> |
| </td> |
| </tr> |
| </table> |
| <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#toString--" title="class or interface in java.lang">toString</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="APP_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>APP_NAME</h4> |
| <pre>public static final <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> APP_NAME</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.hadoop.yarn.server.uam.UnmanagedApplicationManager.APP_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="UnmanagedApplicationManager-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>UnmanagedApplicationManager</h4> |
| <pre>public UnmanagedApplicationManager(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName, |
| <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> submitter, |
| <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> appNameSuffix, |
| boolean keepContainersAcrossApplicationAttempts, |
| <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> rmName)</pre> |
| <div class="block">Constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - configuration</dd> |
| <dd><code>appId</code> - application Id to use for this UAM</dd> |
| <dd><code>queueName</code> - the queue of the UAM</dd> |
| <dd><code>submitter</code> - user name of the app</dd> |
| <dd><code>appNameSuffix</code> - the app name suffix to use</dd> |
| <dd><code>rmName</code> - name of the YarnRM</dd> |
| <dd><code>keepContainersAcrossApplicationAttempts</code> - keep container flag for UAM |
| recovery. See <code>#setKeepContainersAcrossApplicationAttempts(boolean)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createAMHeartbeatRequestHandler-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.api.records.ApplicationId-org.apache.hadoop.yarn.server.AMRMClientRelayer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAMHeartbeatRequestHandler</h4> |
| <pre>protected <a href="../../../../../../org/apache/hadoop/yarn/server/AMHeartbeatRequestHandler.html" title="class in org.apache.hadoop.yarn.server">AMHeartbeatRequestHandler</a> createAMHeartbeatRequestHandler(org.apache.hadoop.conf.Configuration config, |
| org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <a href="../../../../../../org/apache/hadoop/yarn/server/AMRMClientRelayer.html" title="class in org.apache.hadoop.yarn.server">AMRMClientRelayer</a> relayer)</pre> |
| </li> |
| </ul> |
| <a name="launchUAM--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>launchUAM</h4> |
| <pre>public org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier> launchUAM() |
| throws org.apache.hadoop.yarn.exceptions.YarnException, |
| <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">Launch a new UAM in the resource manager.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>identifier uam identifier</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if fails</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reAttachUAM-org.apache.hadoop.security.token.Token-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reAttachUAM</h4> |
| <pre>public void reAttachUAM(org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier> amrmToken) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Re-attach to an existing UAM in the resource manager.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>amrmToken</code> - the UAM token</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if re-attach fails</dd> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if re-attach fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createUAMProxy-org.apache.hadoop.security.token.Token-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createUAMProxy</h4> |
| <pre>protected void createUAMProxy(org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier> amrmToken) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerApplicationMaster-org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerApplicationMaster</h4> |
| <pre>public org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse registerApplicationMaster(org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest request) |
| throws org.apache.hadoop.yarn.exceptions.YarnException, |
| <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 <a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html" title="class in org.apache.hadoop.yarn.server.uam"><code>UnmanagedApplicationManager</code></a> with the resource |
| manager.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - RegisterApplicationMasterRequest</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>register response</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if register fails</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if register fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="finishApplicationMaster-org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finishApplicationMaster</h4> |
| <pre>public org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse finishApplicationMaster(org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest request) |
| throws org.apache.hadoop.yarn.exceptions.YarnException, |
| <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">Unregisters from the resource manager and stops the request handler thread.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the finishApplicationMaster request</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the response</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if finishAM call fails</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if finishAM call fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="forceKillApplication--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forceKillApplication</h4> |
| <pre>public org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse forceKillApplication() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Force kill the UAM.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>kill response</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if fails to create rmProxy</dd> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if force kill fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allocateAsync-org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest-org.apache.hadoop.yarn.util.AsyncCallback-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocateAsync</h4> |
| <pre>public void allocateAsync(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest request, |
| org.apache.hadoop.yarn.util.AsyncCallback<org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse> callback) |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Sends the specified heart beat request to the resource manager and invokes |
| the callback asynchronously with the response.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the allocate request</dd> |
| <dd><code>callback</code> - the callback method for the request</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if registerAM is not called yet</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shutDownConnections--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutDownConnections</h4> |
| <pre>public void shutDownConnections()</pre> |
| <div class="block">Shutdown this UAM client, without killing the UAM in the YarnRM side.</div> |
| </li> |
| </ul> |
| <a name="getAppId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAppId</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.ApplicationId getAppId()</pre> |
| <div class="block">Returns the application id of the UAM.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>application id of the UAM</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAMRMClientRelayer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAMRMClientRelayer</h4> |
| <pre>public <a href="../../../../../../org/apache/hadoop/yarn/server/AMRMClientRelayer.html" title="class in org.apache.hadoop.yarn.server">AMRMClientRelayer</a> getAMRMClientRelayer()</pre> |
| <div class="block">Returns the rmProxy relayer of this UAM.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>rmProxy relayer of the UAM</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createRMProxy-java.lang.Class-org.apache.hadoop.conf.Configuration-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.security.token.Token-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createRMProxy</h4> |
| <pre>protected <T> T createRMProxy(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> protocol, |
| org.apache.hadoop.conf.Configuration config, |
| org.apache.hadoop.security.UserGroupInformation user, |
| org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier> token) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Returns RM proxy for the specified protocol type. Unit test cases can |
| override this method and return mock proxy instances.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - type of the proxy</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>protocol</code> - protocal of the proxy</dd> |
| <dd><code>config</code> - configuration</dd> |
| <dd><code>user</code> - ugi for the proxy connection</dd> |
| <dd><code>token</code> - token for the connection</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the proxy instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if fails to create the proxy</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initializeUnmanagedAM-org.apache.hadoop.yarn.api.records.ApplicationId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initializeUnmanagedAM</h4> |
| <pre>protected org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier> initializeUnmanagedAM(org.apache.hadoop.yarn.api.records.ApplicationId appId) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Launch and initialize an unmanaged AM. First, it creates a new application |
| on the RM and negotiates a new attempt id. Then it waits for the RM |
| application attempt state to reach YarnApplicationAttemptState.LAUNCHED |
| after which it returns the AM-RM token.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appId</code> - application id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the UAM token</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if initialize fails</dd> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if initialize fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUAMToken--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUAMToken</h4> |
| <pre>protected org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier> getUAMToken() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Gets the amrmToken of the unmanaged AM.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the amrmToken of the unmanaged AM.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if getApplicationReport fails</dd> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if getApplicationReport fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRequestQueueSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequestQueueSize</h4> |
| <pre>public int getRequestQueueSize()</pre> |
| </li> |
| </ul> |
| <a name="drainHeartbeatThread--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>drainHeartbeatThread</h4> |
| <pre>protected void drainHeartbeatThread()</pre> |
| </li> |
| </ul> |
| <a name="isHeartbeatThreadAlive--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isHeartbeatThreadAlive</h4> |
| <pre>protected boolean isHeartbeatThreadAlive()</pre> |
| </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/UnmanagedApplicationManager.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/server/uam/UnmanagedAMPoolManager.html" title="class in org.apache.hadoop.yarn.server.uam"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/server/uam/UnmanagedApplicationManager.html" target="_top">Frames</a></li> |
| <li><a href="UnmanagedApplicationManager.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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 © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
