| <!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:09:33 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ApplicationClientProtocol (Apache Hadoop YARN API 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="ApplicationClientProtocol (Apache Hadoop YARN API 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ApplicationClientProtocol.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/api/ApplicationBaseProtocol.html" title="interface in org.apache.hadoop.yarn.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationConstants.html" title="interface in org.apache.hadoop.yarn.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/yarn/api/ApplicationClientProtocol.html" target="_top">Frames</a></li> |
| <li><a href="ApplicationClientProtocol.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.api</div> |
| <h2 title="Interface ApplicationClientProtocol" class="title">Interface ApplicationClientProtocol</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html" title="interface in org.apache.hadoop.yarn.api">ApplicationBaseProtocol</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| public interface <span class="typeNameLabel">ApplicationClientProtocol</span> |
| extends <a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html" title="interface in org.apache.hadoop.yarn.api">ApplicationBaseProtocol</a></pre> |
| <div class="block"><p>The protocol between clients and the <code>ResourceManager</code> |
| to submit/abort jobs and to get information on applications, cluster metrics, |
| nodes, queues and ACLs.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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></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><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationDeleteResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationDeleteResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#deleteReservation-org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest-">deleteReservation</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationDeleteRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationDeleteRequest</a> request)</code> |
| <div class="block"> |
| The interface used by clients to remove an existing Reservation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/FailApplicationAttemptResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">FailApplicationAttemptResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#failApplicationAttempt-org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest-">failApplicationAttempt</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/FailApplicationAttemptRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">FailApplicationAttemptRequest</a> request)</code> |
| <div class="block">The interface used by clients to request the |
| <code>ResourceManager</code> to fail an application attempt.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">KillApplicationResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#forceKillApplication-org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest-">forceKillApplication</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/KillApplicationRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">KillApplicationRequest</a> request)</code> |
| <div class="block">The interface used by clients to request the |
| <code>ResourceManager</code> to abort submitted application.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetAttributesToNodesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetAttributesToNodesResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getAttributesToNodes-org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest-">getAttributesToNodes</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetAttributesToNodesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetAttributesToNodesRequest</a> request)</code> |
| <div class="block"> |
| The interface used by client to get attributes to nodes mappings |
| available in ResourceManager.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterMetricsResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getClusterMetrics-org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest-">getClusterMetrics</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterMetricsRequest</a> request)</code> |
| <div class="block">The interface used by clients to get metrics about the cluster from |
| the <code>ResourceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodeAttributesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterNodeAttributesResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getClusterNodeAttributes-org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesRequest-">getClusterNodeAttributes</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodeAttributesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterNodeAttributesRequest</a> request)</code> |
| <div class="block"> |
| The interface used by client to get node attributes available in |
| ResourceManager.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodeLabelsResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterNodeLabelsResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getClusterNodeLabels-org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest-">getClusterNodeLabels</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodeLabelsRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterNodeLabelsRequest</a> request)</code> |
| <div class="block"> |
| The interface used by client to get node labels in the cluster</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterNodesResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getClusterNodes-org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest-">getClusterNodes</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterNodesRequest</a> request)</code> |
| <div class="block">The interface used by clients to get a report of all nodes |
| in the cluster from the <code>ResourceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetLabelsToNodesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetLabelsToNodesResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getLabelsToNodes-org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest-">getLabelsToNodes</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetLabelsToNodesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetLabelsToNodesRequest</a> request)</code> |
| <div class="block"> |
| The interface used by client to get labels to nodes mappings |
| in existing cluster</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNewApplicationResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNewApplicationResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getNewApplication-org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest-">getNewApplication</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNewApplicationRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNewApplicationRequest</a> request)</code> |
| <div class="block">The interface used by clients to obtain a new <a href="../../../../../org/apache/hadoop/yarn/api/records/ApplicationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ApplicationId</code></a> for |
| submitting new applications.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNewReservationResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNewReservationResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getNewReservation-org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest-">getNewReservation</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNewReservationRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNewReservationRequest</a> request)</code> |
| <div class="block">The interface used by clients to obtain a new <a href="../../../../../org/apache/hadoop/yarn/api/records/ReservationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ReservationId</code></a> for |
| submitting new reservations.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNodesToAttributesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNodesToAttributesResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getNodesToAttributes-org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest-">getNodesToAttributes</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNodesToAttributesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNodesToAttributesRequest</a> request)</code> |
| <div class="block"> |
| The interface used by client to get node to attributes mappings.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNodesToLabelsResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNodesToLabelsResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getNodeToLabels-org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest-">getNodeToLabels</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNodesToLabelsRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNodesToLabelsRequest</a> request)</code> |
| <div class="block"> |
| The interface used by client to get node to labels mappings in existing cluster</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetQueueInfoResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getQueueInfo-org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest-">getQueueInfo</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetQueueInfoRequest</a> request)</code> |
| <div class="block">The interface used by clients to get information about <em>queues</em> |
| from the <code>ResourceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetQueueUserAclsInfoResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetQueueUserAclsInfoResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getQueueUserAcls-org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest-">getQueueUserAcls</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetQueueUserAclsInfoRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetQueueUserAclsInfoRequest</a> request)</code> |
| <div class="block">The interface used by clients to get information about <em>queue |
| acls</em> for <em>current user</em> from the <code>ResourceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetResourceProfileResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetResourceProfileResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getResourceProfile-org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileRequest-">getResourceProfile</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetResourceProfileRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetResourceProfileRequest</a> request)</code> |
| <div class="block"> |
| The interface to get the details for a specific resource profile.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetAllResourceProfilesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetAllResourceProfilesResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getResourceProfiles-org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesRequest-">getResourceProfiles</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetAllResourceProfilesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetAllResourceProfilesRequest</a> request)</code> |
| <div class="block"> |
| The interface used by clients to get all the resource profiles that are |
| available on the ResourceManager.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetAllResourceTypeInfoResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetAllResourceTypeInfoResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getResourceTypeInfo-org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest-">getResourceTypeInfo</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetAllResourceTypeInfoRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetAllResourceTypeInfoRequest</a> request)</code> |
| <div class="block"> |
| The interface to get the details for a specific resource profile.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationListResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationListResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#listReservations-org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest-">listReservations</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationListRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationListRequest</a> request)</code> |
| <div class="block"> |
| The interface used by clients to get the list of reservations in a plan.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/MoveApplicationAcrossQueuesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">MoveApplicationAcrossQueuesResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#moveApplicationAcrossQueues-org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest-">moveApplicationAcrossQueues</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/MoveApplicationAcrossQueuesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">MoveApplicationAcrossQueuesRequest</a> request)</code> |
| <div class="block">Move an application to a new queue.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/SignalContainerResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">SignalContainerResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#signalToContainer-org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest-">signalToContainer</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/SignalContainerRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">SignalContainerRequest</a> request)</code> |
| <div class="block">The interface used by clients to request the |
| <code>ResourceManager</code> to signal a container.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/SubmitApplicationResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">SubmitApplicationResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#submitApplication-org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest-">submitApplication</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/SubmitApplicationRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">SubmitApplicationRequest</a> request)</code> |
| <div class="block">The interface used by clients to submit a new application to the |
| <code>ResourceManager.</code></div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationSubmissionResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationSubmissionResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#submitReservation-org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest-">submitReservation</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationSubmissionRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationSubmissionRequest</a> request)</code> |
| <div class="block"> |
| The interface used by clients to submit a new reservation to the |
| <code>ResourceManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/UpdateApplicationPriorityResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">UpdateApplicationPriorityResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#updateApplicationPriority-org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest-">updateApplicationPriority</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/UpdateApplicationPriorityRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">UpdateApplicationPriorityRequest</a> request)</code> |
| <div class="block"> |
| The interface used by client to set priority of an application.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/UpdateApplicationTimeoutsResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">UpdateApplicationTimeoutsResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#updateApplicationTimeouts-org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest-">updateApplicationTimeouts</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/UpdateApplicationTimeoutsRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">UpdateApplicationTimeoutsRequest</a> request)</code> |
| <div class="block"> |
| The interface used by client to set ApplicationTimeouts of an application.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationUpdateResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationUpdateResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#updateReservation-org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest-">updateReservation</a></span>(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationUpdateRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationUpdateRequest</a> request)</code> |
| <div class="block"> |
| The interface used by clients to update an existing Reservation.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.api.ApplicationBaseProtocol"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.hadoop.yarn.api.<a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html" title="interface in org.apache.hadoop.yarn.api">ApplicationBaseProtocol</a></h3> |
| <code><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html#cancelDelegationToken-org.apache.hadoop.yarn.api.protocolrecords.CancelDelegationTokenRequest-">cancelDelegationToken</a>, <a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html#getApplicationAttemptReport-org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest-">getApplicationAttemptReport</a>, <a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html#getApplicationAttempts-org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest-">getApplicationAttempts</a>, <a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html#getApplicationReport-org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest-">getApplicationReport</a>, <a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html#getApplications-org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest-">getApplications</a>, <a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html#getContainerReport-org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest-">getContainerReport</a>, <a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html#getContainers-org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest-">getContainers</a>, <a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html#getDelegationToken-org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest-">getDelegationToken</a>, <a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html#renewDelegationToken-org.apache.hadoop.yarn.api.protocolrecords.RenewDelegationTokenRequest-">renewDelegationToken</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getNewApplication-org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNewApplication</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNewApplicationResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNewApplicationResponse</a> getNewApplication(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNewApplicationRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNewApplicationRequest</a> request) |
| 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"><p>The interface used by clients to obtain a new <a href="../../../../../org/apache/hadoop/yarn/api/records/ApplicationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ApplicationId</code></a> for |
| submitting new applications.</p> |
| |
| <p>The <code>ResourceManager</code> responds with a new, monotonically |
| increasing, <a href="../../../../../org/apache/hadoop/yarn/api/records/ApplicationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ApplicationId</code></a> which is used by the client to submit |
| a new application.</p> |
| |
| <p>The <code>ResourceManager</code> also responds with details such |
| as maximum resource capabilities in the cluster as specified in |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNewApplicationResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>GetNewApplicationResponse</code></a>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to get a new <code>ApplicationId</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>response containing the new <code>ApplicationId</code> to be used |
| to submit an application</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> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#submitApplication-org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest-"><code>submitApplication(SubmitApplicationRequest)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="submitApplication-org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>submitApplication</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/SubmitApplicationResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">SubmitApplicationResponse</a> submitApplication(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/SubmitApplicationRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">SubmitApplicationRequest</a> request) |
| 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"><p>The interface used by clients to submit a new application to the |
| <code>ResourceManager.</code></p> |
| |
| <p>The client is required to provide details such as queue, |
| <a href="../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records"><code>Resource</code></a> required to run the <code>ApplicationMaster</code>, |
| the equivalent of <a href="../../../../../org/apache/hadoop/yarn/api/records/ContainerLaunchContext.html" title="class in org.apache.hadoop.yarn.api.records"><code>ContainerLaunchContext</code></a> for launching |
| the <code>ApplicationMaster</code> etc. via the |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/SubmitApplicationRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>SubmitApplicationRequest</code></a>.</p> |
| |
| <p>Currently the <code>ResourceManager</code> sends an immediate (empty) |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/SubmitApplicationResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>SubmitApplicationResponse</code></a> on accepting the submission and throws |
| an exception if it rejects the submission. However, this call needs to be |
| followed by <a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html#getApplicationReport-org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest-"><code>ApplicationBaseProtocol.getApplicationReport(GetApplicationReportRequest)</code></a> |
| to make sure that the application gets properly submitted - obtaining a |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/SubmitApplicationResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>SubmitApplicationResponse</code></a> from ResourceManager doesn't guarantee |
| that RM 'remembers' this application beyond failover or restart. If RM |
| failover or RM restart happens before ResourceManager saves the |
| application's state successfully, the subsequent |
| <a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html#getApplicationReport-org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest-"><code>ApplicationBaseProtocol.getApplicationReport(GetApplicationReportRequest)</code></a> will throw |
| a <a href="../../../../../org/apache/hadoop/yarn/exceptions/ApplicationNotFoundException.html" title="class in org.apache.hadoop.yarn.exceptions"><code>ApplicationNotFoundException</code></a>. The Clients need to re-submit |
| the application with the same <a href="../../../../../org/apache/hadoop/yarn/api/records/ApplicationSubmissionContext.html" title="class in org.apache.hadoop.yarn.api.records"><code>ApplicationSubmissionContext</code></a> when |
| it encounters the <a href="../../../../../org/apache/hadoop/yarn/exceptions/ApplicationNotFoundException.html" title="class in org.apache.hadoop.yarn.exceptions"><code>ApplicationNotFoundException</code></a> on the |
| <a href="../../../../../org/apache/hadoop/yarn/api/ApplicationBaseProtocol.html#getApplicationReport-org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest-"><code>ApplicationBaseProtocol.getApplicationReport(GetApplicationReportRequest)</code></a> call.</p> |
| |
| <p>During the submission process, it checks whether the application |
| already exists. If the application exists, it will simply return |
| SubmitApplicationResponse</p> |
| |
| <p> In secure mode,the <code>ResourceManager</code> verifies access to |
| queues etc. before accepting the application submission.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to submit a new application</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(empty) response on accepting the submission</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> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getNewApplication-org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest-"><code>getNewApplication(GetNewApplicationRequest)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="failApplicationAttempt-org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>failApplicationAttempt</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/FailApplicationAttemptResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">FailApplicationAttemptResponse</a> failApplicationAttempt(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/FailApplicationAttemptRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">FailApplicationAttemptRequest</a> request) |
| 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"><p>The interface used by clients to request the |
| <code>ResourceManager</code> to fail an application attempt.</p> |
| |
| <p>The client, via <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/FailApplicationAttemptRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>FailApplicationAttemptRequest</code></a> provides the |
| <a href="../../../../../org/apache/hadoop/yarn/api/records/ApplicationAttemptId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ApplicationAttemptId</code></a> of the attempt to be failed.</p> |
| |
| <p> In secure mode,the <code>ResourceManager</code> verifies access to the |
| application, queue etc. before failing the attempt.</p> |
| |
| <p>Currently, the <code>ResourceManager</code> returns an empty response |
| on success and throws an exception on rejecting the request.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to fail an attempt</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>ResourceManager</code> returns an empty response |
| on success and throws an exception on rejecting the 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> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getQueueUserAcls-org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest-"><code>getQueueUserAcls(GetQueueUserAclsInfoRequest)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="forceKillApplication-org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forceKillApplication</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/KillApplicationResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">KillApplicationResponse</a> forceKillApplication(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/KillApplicationRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">KillApplicationRequest</a> request) |
| 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"><p>The interface used by clients to request the |
| <code>ResourceManager</code> to abort submitted application.</p> |
| |
| <p>The client, via <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/KillApplicationRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>KillApplicationRequest</code></a> provides the |
| <a href="../../../../../org/apache/hadoop/yarn/api/records/ApplicationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ApplicationId</code></a> of the application to be aborted.</p> |
| |
| <p> In secure mode,the <code>ResourceManager</code> verifies access to the |
| application, queue etc. before terminating the application.</p> |
| |
| <p>Currently, the <code>ResourceManager</code> returns an empty response |
| on success and throws an exception on rejecting the request.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to abort a submitted application</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>ResourceManager</code> returns an empty response |
| on success and throws an exception on rejecting the 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> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#getQueueUserAcls-org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest-"><code>getQueueUserAcls(GetQueueUserAclsInfoRequest)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClusterMetrics-org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClusterMetrics</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterMetricsResponse</a> getClusterMetrics(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterMetricsRequest</a> request) |
| 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"><p>The interface used by clients to get metrics about the cluster from |
| the <code>ResourceManager</code>.</p> |
| |
| <p>The <code>ResourceManager</code> responds with a |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterMetricsResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>GetClusterMetricsResponse</code></a> which includes the |
| <a href="../../../../../org/apache/hadoop/yarn/api/records/YarnClusterMetrics.html" title="class in org.apache.hadoop.yarn.api.records"><code>YarnClusterMetrics</code></a> with details such as number of current |
| nodes in the cluster.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request for cluster metrics</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>cluster metrics</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="getClusterNodes-org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClusterNodes</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterNodesResponse</a> getClusterNodes(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterNodesRequest</a> request) |
| 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"><p>The interface used by clients to get a report of all nodes |
| in the cluster from the <code>ResourceManager</code>.</p> |
| |
| <p>The <code>ResourceManager</code> responds with a |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>GetClusterNodesResponse</code></a> which includes the |
| <a href="../../../../../org/apache/hadoop/yarn/api/records/NodeReport.html" title="class in org.apache.hadoop.yarn.api.records"><code>NodeReport</code></a> for all the nodes in the cluster.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request for report on all nodes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>report on all nodes</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="getQueueInfo-org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueueInfo</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetQueueInfoResponse</a> getQueueInfo(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetQueueInfoRequest</a> request) |
| 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"><p>The interface used by clients to get information about <em>queues</em> |
| from the <code>ResourceManager</code>.</p> |
| |
| <p>The client, via <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetQueueInfoRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>GetQueueInfoRequest</code></a>, can ask for details such |
| as used/total resources, child queues, running applications etc.</p> |
| |
| <p> In secure mode,the <code>ResourceManager</code> verifies access before |
| providing the information.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to get queue information</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>queue information</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="getQueueUserAcls-org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueueUserAcls</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetQueueUserAclsInfoResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetQueueUserAclsInfoResponse</a> getQueueUserAcls(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetQueueUserAclsInfoRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetQueueUserAclsInfoRequest</a> request) |
| 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"><p>The interface used by clients to get information about <em>queue |
| acls</em> for <em>current user</em> from the <code>ResourceManager</code>. |
| </p> |
| |
| <p>The <code>ResourceManager</code> responds with queue acls for all |
| existing queues.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to get queue acls for <em>current user</em></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>queue acls for <em>current user</em></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="moveApplicationAcrossQueues-org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>moveApplicationAcrossQueues</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/MoveApplicationAcrossQueuesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">MoveApplicationAcrossQueuesResponse</a> moveApplicationAcrossQueues(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/MoveApplicationAcrossQueuesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">MoveApplicationAcrossQueuesRequest</a> request) |
| 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">Move an application to a new queue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the application ID and the target queue</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an empty response</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="getNewReservation-org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNewReservation</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNewReservationResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNewReservationResponse</a> getNewReservation(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNewReservationRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNewReservationRequest</a> request) |
| 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"><p>The interface used by clients to obtain a new <a href="../../../../../org/apache/hadoop/yarn/api/records/ReservationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ReservationId</code></a> for |
| submitting new reservations.</p> |
| |
| <p>The <code>ResourceManager</code> responds with a new, unique, |
| <a href="../../../../../org/apache/hadoop/yarn/api/records/ReservationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ReservationId</code></a> which is used by the client to submit |
| a new reservation.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - to get a new <code>ReservationId</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>response containing the new <code>ReservationId</code> to be used |
| to submit a new reservation</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> - if the reservation system is not enabled.</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> - on IO failures.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationClientProtocol.html#submitReservation-org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest-"><code>submitReservation(ReservationSubmissionRequest)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="submitReservation-org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>submitReservation</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationSubmissionResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationSubmissionResponse</a> submitReservation(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationSubmissionRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationSubmissionRequest</a> request) |
| 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"><p> |
| The interface used by clients to submit a new reservation to the |
| <code>ResourceManager</code>. |
| </p> |
| |
| <p> |
| The client packages all details of its request in a |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationSubmissionRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>ReservationSubmissionRequest</code></a> object. This contains information |
| about the amount of capacity, temporal constraints, and concurrency needs. |
| Furthermore, the reservation might be composed of multiple stages, with |
| ordering dependencies among them. |
| </p> |
| |
| <p> |
| In order to respond, a new admission control component in the |
| <code>ResourceManager</code> performs an analysis of the resources that have |
| been committed over the period of time the user is requesting, verify that |
| the user requests can be fulfilled, and that it respect a sharing policy |
| (e.g., <code>CapacityOverTimePolicy</code>). Once it has positively determined |
| that the ReservationSubmissionRequest is satisfiable the |
| <code>ResourceManager</code> answers with a |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationSubmissionResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>ReservationSubmissionResponse</code></a> that include a non-null |
| <a href="../../../../../org/apache/hadoop/yarn/api/records/ReservationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ReservationId</code></a>. Upon failure to find a valid allocation the response |
| is an exception with the reason. |
| |
| On application submission the client can use this <a href="../../../../../org/apache/hadoop/yarn/api/records/ReservationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ReservationId</code></a> to |
| obtain access to the reserved resources. |
| </p> |
| |
| <p> |
| The system guarantees that during the time-range specified by the user, the |
| reservationID will be corresponding to a valid reservation. The amount of |
| capacity dedicated to such queue can vary overtime, depending of the |
| allocation that has been determined. But it is guaranteed to satisfy all |
| the constraint expressed by the user in the |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationSubmissionRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>ReservationSubmissionRequest</code></a>. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the request to submit a new Reservation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>response the <a href="../../../../../org/apache/hadoop/yarn/api/records/ReservationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ReservationId</code></a> on accepting the submission</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> - if the request is invalid or reservation cannot be |
| created successfully</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="updateReservation-org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateReservation</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationUpdateResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationUpdateResponse</a> updateReservation(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationUpdateRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationUpdateRequest</a> request) |
| 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"><p> |
| The interface used by clients to update an existing Reservation. This is |
| referred to as a re-negotiation process, in which a user that has |
| previously submitted a Reservation. |
| </p> |
| |
| <p> |
| The allocation is attempted by virtually substituting all previous |
| allocations related to this Reservation with new ones, that satisfy the new |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationUpdateRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>ReservationUpdateRequest</code></a>. Upon success the previous allocation is |
| substituted by the new one, and on failure (i.e., if the system cannot find |
| a valid allocation for the updated request), the previous allocation |
| remains valid. |
| |
| The <a href="../../../../../org/apache/hadoop/yarn/api/records/ReservationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ReservationId</code></a> is not changed, and applications currently |
| running within this reservation will automatically receive the resources |
| based on the new allocation. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - to update an existing Reservation (the ReservationRequest |
| should refer to an existing valid <a href="../../../../../org/apache/hadoop/yarn/api/records/ReservationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ReservationId</code></a>)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>response empty on successfully updating the existing reservation</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> - if the request is invalid or reservation cannot be |
| updated successfully</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="deleteReservation-org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteReservation</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationDeleteResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationDeleteResponse</a> deleteReservation(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationDeleteRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationDeleteRequest</a> request) |
| 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"><p> |
| The interface used by clients to remove an existing Reservation. |
| |
| Upon deletion of a reservation applications running with this reservation, |
| are automatically downgraded to normal jobs running without any dedicated |
| reservation. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - to remove an existing Reservation (the ReservationRequest |
| should refer to an existing valid <a href="../../../../../org/apache/hadoop/yarn/api/records/ReservationId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ReservationId</code></a>)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>response empty on successfully deleting the existing reservation</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> - if the request is invalid or reservation cannot be |
| deleted successfully</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="listReservations-org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listReservations</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationListResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationListResponse</a> listReservations(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationListRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">ReservationListRequest</a> request) |
| 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"><p> |
| The interface used by clients to get the list of reservations in a plan. |
| The reservationId will be used to search for reservations to list if it is |
| provided. Otherwise, it will select active reservations within the |
| startTime and endTime (inclusive). |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - to list reservations in a plan. Contains fields to select |
| String queue, ReservationId reservationId, long startTime, |
| long endTime, and a bool includeReservationAllocations. |
| |
| queue: Required. Cannot be null or empty. Refers to the |
| reservable queue in the scheduler that was selected when |
| creating a reservation submission |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/ReservationSubmissionRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>ReservationSubmissionRequest</code></a>. |
| |
| reservationId: Optional. If provided, other fields will |
| be ignored. |
| |
| startTime: Optional. If provided, only reservations that |
| end after the startTime will be selected. This defaults |
| to 0 if an invalid number is used. |
| |
| endTime: Optional. If provided, only reservations that |
| start on or before endTime will be selected. This defaults |
| to Long.MAX_VALUE if an invalid number is used. |
| |
| includeReservationAllocations: Optional. Flag that |
| determines whether the entire reservation allocations are |
| to be returned. Reservation allocations are subject to |
| change in the event of re-planning as described by |
| <code>ReservationDefinition</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>response that contains information about reservations that are |
| being searched for.</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> - if the request is invalid</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> - on IO failures</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNodeToLabels-org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNodeToLabels</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNodesToLabelsResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNodesToLabelsResponse</a> getNodeToLabels(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNodesToLabelsRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNodesToLabelsRequest</a> request) |
| 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"><p> |
| The interface used by client to get node to labels mappings in existing cluster |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>node to labels mappings</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="getLabelsToNodes-org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLabelsToNodes</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetLabelsToNodesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetLabelsToNodesResponse</a> getLabelsToNodes(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetLabelsToNodesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetLabelsToNodesRequest</a> request) |
| 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"><p> |
| The interface used by client to get labels to nodes mappings |
| in existing cluster |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>labels to nodes mappings</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="getClusterNodeLabels-org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClusterNodeLabels</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodeLabelsResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterNodeLabelsResponse</a> getClusterNodeLabels(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodeLabelsRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterNodeLabelsRequest</a> request) |
| 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"><p> |
| The interface used by client to get node labels in the cluster |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - to get node labels collection of this cluster</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>node labels collection of this cluster</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="updateApplicationPriority-org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateApplicationPriority</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/UpdateApplicationPriorityResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">UpdateApplicationPriorityResponse</a> updateApplicationPriority(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/UpdateApplicationPriorityRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">UpdateApplicationPriorityRequest</a> request) |
| 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"><p> |
| The interface used by client to set priority of an application. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - to set priority of an application</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an empty response</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="signalToContainer-org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>signalToContainer</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/SignalContainerResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">SignalContainerResponse</a> signalToContainer(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/SignalContainerRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">SignalContainerRequest</a> request) |
| 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"><p>The interface used by clients to request the |
| <code>ResourceManager</code> to signal a container. For example, |
| the client can send command OUTPUT_THREAD_DUMP to dump threads of the |
| container.</p> |
| |
| <p>The client, via <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/SignalContainerRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords"><code>SignalContainerRequest</code></a> provides the |
| id of the container and the signal command. </p> |
| |
| <p> In secure mode,the <code>ResourceManager</code> verifies access to the |
| application before signaling the container. |
| The user needs to have <code>MODIFY_APP</code> permission.</p> |
| |
| <p>Currently, the <code>ResourceManager</code> returns an empty response |
| on success and throws an exception on rejecting the request.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to signal a container</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>ResourceManager</code> returns an empty response |
| on success and throws an exception on rejecting the 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="updateApplicationTimeouts-org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateApplicationTimeouts</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/UpdateApplicationTimeoutsResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">UpdateApplicationTimeoutsResponse</a> updateApplicationTimeouts(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/UpdateApplicationTimeoutsRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">UpdateApplicationTimeoutsRequest</a> request) |
| 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"><p> |
| The interface used by client to set ApplicationTimeouts of an application. |
| The UpdateApplicationTimeoutsRequest should have timeout value with |
| absolute time with ISO8601 format <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>. |
| </p> |
| <b>Note:</b> If application timeout value is less than or equal to current |
| time then update application throws YarnException.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - to set ApplicationTimeouts of an application</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a response with updated timeouts.</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> - if update request has empty values or application is |
| in completing states.</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> - on IO failures</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResourceProfiles-org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResourceProfiles</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetAllResourceProfilesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetAllResourceProfilesResponse</a> getResourceProfiles(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetAllResourceProfilesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetAllResourceProfilesRequest</a> request) |
| 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"><p> |
| The interface used by clients to get all the resource profiles that are |
| available on the ResourceManager. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to get all the resource profiles</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Response containing a map of the profile name to Resource |
| capabilities</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/yarn/exceptions/YARNFeatureNotEnabledException.html" title="class in org.apache.hadoop.yarn.exceptions">YARNFeatureNotEnabledException</a></code> - if resource-profile is disabled</dd> |
| <dd><code><a href="../../../../../org/apache/hadoop/yarn/exceptions/YarnException.html" title="class in org.apache.hadoop.yarn.exceptions">YarnException</a></code> - if any error happens inside YARN</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> - in case of other errors</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResourceProfile-org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResourceProfile</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetResourceProfileResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetResourceProfileResponse</a> getResourceProfile(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetResourceProfileRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetResourceProfileRequest</a> request) |
| 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"><p> |
| The interface to get the details for a specific resource profile. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to get the details of a resource profile</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Response containing the details for a particular resource profile</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/hadoop/yarn/exceptions/YARNFeatureNotEnabledException.html" title="class in org.apache.hadoop.yarn.exceptions">YARNFeatureNotEnabledException</a></code> - if resource-profile is disabled</dd> |
| <dd><code><a href="../../../../../org/apache/hadoop/yarn/exceptions/YarnException.html" title="class in org.apache.hadoop.yarn.exceptions">YarnException</a></code> - if any error happens inside YARN</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> - in case of other errors</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResourceTypeInfo-org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResourceTypeInfo</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetAllResourceTypeInfoResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetAllResourceTypeInfoResponse</a> getResourceTypeInfo(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetAllResourceTypeInfoRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetAllResourceTypeInfoRequest</a> request) |
| 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"><p> |
| The interface to get the details for a specific resource profile. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to get the details of a resource profile</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Response containing the details for a particular resource profile</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> - if any error happens inside YARN</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> - in case of other errors</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttributesToNodes-org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributesToNodes</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetAttributesToNodesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetAttributesToNodesResponse</a> getAttributesToNodes(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetAttributesToNodesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetAttributesToNodesRequest</a> request) |
| 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"><p> |
| The interface used by client to get attributes to nodes mappings |
| available in ResourceManager. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to get details of attributes to nodes mapping.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Response containing the details of attributes to nodes mappings.</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> - if any error happens inside YARN</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> - incase of other errors</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClusterNodeAttributes-org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClusterNodeAttributes</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodeAttributesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterNodeAttributesResponse</a> getClusterNodeAttributes(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetClusterNodeAttributesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetClusterNodeAttributesRequest</a> request) |
| 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"><p> |
| The interface used by client to get node attributes available in |
| ResourceManager. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to get node attributes collection of this cluster.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Response containing node attributes collection.</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> - if any error happens inside YARN.</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> - incase of other errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNodesToAttributes-org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getNodesToAttributes</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| <a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNodesToAttributesResponse.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNodesToAttributesResponse</a> getNodesToAttributes(<a href="../../../../../org/apache/hadoop/yarn/api/protocolrecords/GetNodesToAttributesRequest.html" title="class in org.apache.hadoop.yarn.api.protocolrecords">GetNodesToAttributesRequest</a> request) |
| 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"><p> |
| The interface used by client to get node to attributes mappings. |
| in existing cluster. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - request to get nodes to attributes mapping.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>nodes to attributes mappings.</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> - if any error happens inside YARN.</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> |
| </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/ApplicationClientProtocol.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/api/ApplicationBaseProtocol.html" title="interface in org.apache.hadoop.yarn.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/yarn/api/ApplicationConstants.html" title="interface in org.apache.hadoop.yarn.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/yarn/api/ApplicationClientProtocol.html" target="_top">Frames</a></li> |
| <li><a href="ApplicationClientProtocol.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |