| <!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:34 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Container (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="Container (Apache Hadoop YARN API 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":10,"i11":9,"i12":9,"i13":10,"i14":10,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Container.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/records/CollectorInfo.html" title="class in org.apache.hadoop.yarn.api.records"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerExitStatus.html" title="class in org.apache.hadoop.yarn.api.records"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/api/records/Container.html" target="_top">Frames</a></li> |
| <li><a href="Container.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.yarn.api.records</div> |
| <h2 title="Class Container" class="title">Class Container</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.yarn.api.records.Container</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html" title="class in org.apache.hadoop.yarn.api.records">Container</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| public abstract class <span class="typeNameLabel">Container</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html" title="class in org.apache.hadoop.yarn.api.records">Container</a>></pre> |
| <div class="block"><code>Container</code> represents an allocated resource in the cluster. |
| <p> |
| The <code>ResourceManager</code> is the sole authority to allocate any |
| <code>Container</code> to applications. The allocated <code>Container</code> |
| is always on a single node and has a unique <a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ContainerId</code></a>. It has |
| a specific amount of <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records"><code>Resource</code></a> allocated. |
| <p> |
| It includes details such as: |
| <ul> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records"><code>ContainerId</code></a> for the container, which is globally unique.</li> |
| <li> |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/NodeId.html" title="class in org.apache.hadoop.yarn.api.records"><code>NodeId</code></a> of the node on which it is allocated. |
| </li> |
| <li>HTTP uri of the node.</li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records"><code>Resource</code></a> allocated to the container.</li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records"><code>Priority</code></a> at which the container was allocated.</li> |
| <li> |
| Container <a href="../../../../../../org/apache/hadoop/yarn/api/records/Token.html" title="class in org.apache.hadoop.yarn.api.records"><code>Token</code></a> of the container, used to securely verify |
| authenticity of the allocation. |
| </li> |
| </ul> |
| |
| Typically, an <code>ApplicationMaster</code> receives the <code>Container</code> |
| from the <code>ResourceManager</code> during resource-negotiation and then |
| talks to the <code>NodeManager</code> to start/stop containers.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/hadoop/yarn/api/ApplicationMasterProtocol.html#allocate-org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest-"><code>ApplicationMasterProtocol.allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)</code></a>, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/ContainerManagementProtocol.html#startContainers-org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest-"><code>ContainerManagementProtocol.startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)</code></a>, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/ContainerManagementProtocol.html#stopContainers-org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest-"><code>ContainerManagementProtocol.stopContainers(org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#Container--">Container</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></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>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#getAllocationRequestId--">getAllocationRequestId</a></span>()</code> |
| <div class="block">Get the optional <em>ID</em> corresponding to the original <code>ResourceRequest{@link #getAllocationRequestId()}</code>s which is satisfied by |
| this allocated <code>Container</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#getAllocationTags--">getAllocationTags</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/hadoop/yarn/api/records/Token.html" title="class in org.apache.hadoop.yarn.api.records">Token</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#getContainerToken--">getContainerToken</a></span>()</code> |
| <div class="block">Get the <code>ContainerToken</code> for the container.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/hadoop/yarn/api/records/ExecutionType.html" title="enum in org.apache.hadoop.yarn.api.records">ExecutionType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#getExecutionType--">getExecutionType</a></span>()</code> |
| <div class="block">Get the <code>ExecutionType</code> for the container.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#getExposedPorts--">getExposedPorts</a></span>()</code> |
| <div class="block">Get the exposed ports of the node on which the container is allocated.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records">ContainerId</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#getId--">getId</a></span>()</code> |
| <div class="block">Get the globally unique identifier for the container.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#getNodeHttpAddress--">getNodeHttpAddress</a></span>()</code> |
| <div class="block">Get the http uri of the node on which the container is allocated.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/hadoop/yarn/api/records/NodeId.html" title="class in org.apache.hadoop.yarn.api.records">NodeId</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#getNodeId--">getNodeId</a></span>()</code> |
| <div class="block">Get the identifier of the node on which the container is allocated.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#getPriority--">getPriority</a></span>()</code> |
| <div class="block">Get the <code>Priority</code> at which the <code>Container</code> was |
| allocated.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#getResource--">getResource</a></span>()</code> |
| <div class="block">Get the <code>Resource</code> allocated to the container.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#getVersion--">getVersion</a></span>()</code> |
| <div class="block">Get the version of this container.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html" title="class in org.apache.hadoop.yarn.api.records">Container</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#newInstance-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Priority-org.apache.hadoop.yarn.api.records.Token-">newInstance</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records">ContainerId</a> containerId, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/NodeId.html" title="class in org.apache.hadoop.yarn.api.records">NodeId</a> nodeId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nodeHttpAddress, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> resource, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a> priority, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Token.html" title="class in org.apache.hadoop.yarn.api.records">Token</a> containerToken)</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html" title="class in org.apache.hadoop.yarn.api.records">Container</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#newInstance-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Priority-org.apache.hadoop.yarn.api.records.Token-org.apache.hadoop.yarn.api.records.ExecutionType-">newInstance</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records">ContainerId</a> containerId, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/NodeId.html" title="class in org.apache.hadoop.yarn.api.records">NodeId</a> nodeId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nodeHttpAddress, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> resource, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a> priority, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Token.html" title="class in org.apache.hadoop.yarn.api.records">Token</a> containerToken, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/ExecutionType.html" title="enum in org.apache.hadoop.yarn.api.records">ExecutionType</a> executionType)</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#setAllocationRequestId-long-">setAllocationRequestId</a></span>(long allocationRequestID)</code> |
| <div class="block">Set the optional <em>ID</em> corresponding to the original <code>ResourceRequest{@link #setAllocationRequestId(long)} |
| etAllocationRequestId()</code>}s which is satisfied by this allocated <code>Container</code>.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#setAllocationTags-java.util.Set-">setAllocationTags</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> allocationTags)</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#setContainerToken-org.apache.hadoop.yarn.api.records.Token-">setContainerToken</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Token.html" title="class in org.apache.hadoop.yarn.api.records">Token</a> containerToken)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#setExecutionType-org.apache.hadoop.yarn.api.records.ExecutionType-">setExecutionType</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/api/records/ExecutionType.html" title="enum in org.apache.hadoop.yarn.api.records">ExecutionType</a> executionType)</code> |
| <div class="block">Set the <code>ExecutionType</code> for the container.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#setExposedPorts-java.util.Map-">setExposedPorts</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>>> ports)</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#setId-org.apache.hadoop.yarn.api.records.ContainerId-">setId</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records">ContainerId</a> id)</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#setNodeHttpAddress-java.lang.String-">setNodeHttpAddress</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nodeHttpAddress)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#setNodeId-org.apache.hadoop.yarn.api.records.NodeId-">setNodeId</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/api/records/NodeId.html" title="class in org.apache.hadoop.yarn.api.records">NodeId</a> nodeId)</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#setPriority-org.apache.hadoop.yarn.api.records.Priority-">setPriority</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a> priority)</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#setResource-org.apache.hadoop.yarn.api.records.Resource-">setResource</a></span>(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> resource)</code> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html#setVersion-int-">setVersion</a></span>(int version)</code> |
| <div class="block">Set the version of this container.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Comparable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true#compareTo-T-" title="class or interface in java.lang">compareTo</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Container--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Container</h4> |
| <pre>public Container()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="newInstance-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Priority-org.apache.hadoop.yarn.api.records.Token-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstance</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public static <a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html" title="class in org.apache.hadoop.yarn.api.records">Container</a> newInstance(<a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records">ContainerId</a> containerId, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/NodeId.html" title="class in org.apache.hadoop.yarn.api.records">NodeId</a> nodeId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nodeHttpAddress, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> resource, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a> priority, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Token.html" title="class in org.apache.hadoop.yarn.api.records">Token</a> containerToken)</pre> |
| </li> |
| </ul> |
| <a name="newInstance-org.apache.hadoop.yarn.api.records.ContainerId-org.apache.hadoop.yarn.api.records.NodeId-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Priority-org.apache.hadoop.yarn.api.records.Token-org.apache.hadoop.yarn.api.records.ExecutionType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstance</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public static <a href="../../../../../../org/apache/hadoop/yarn/api/records/Container.html" title="class in org.apache.hadoop.yarn.api.records">Container</a> newInstance(<a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records">ContainerId</a> containerId, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/NodeId.html" title="class in org.apache.hadoop.yarn.api.records">NodeId</a> nodeId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nodeHttpAddress, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> resource, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a> priority, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/Token.html" title="class in org.apache.hadoop.yarn.api.records">Token</a> containerToken, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/records/ExecutionType.html" title="enum in org.apache.hadoop.yarn.api.records">ExecutionType</a> executionType)</pre> |
| </li> |
| </ul> |
| <a name="getId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| public abstract <a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records">ContainerId</a> getId()</pre> |
| <div class="block">Get the globally unique identifier for the container.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>globally unique identifier for the container</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setId-org.apache.hadoop.yarn.api.records.ContainerId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setId</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public abstract void setId(<a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerId.html" title="class in org.apache.hadoop.yarn.api.records">ContainerId</a> id)</pre> |
| </li> |
| </ul> |
| <a name="getNodeId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNodeId</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| public abstract <a href="../../../../../../org/apache/hadoop/yarn/api/records/NodeId.html" title="class in org.apache.hadoop.yarn.api.records">NodeId</a> getNodeId()</pre> |
| <div class="block">Get the identifier of the node on which the container is allocated.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>identifier of the node on which the container is allocated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNodeId-org.apache.hadoop.yarn.api.records.NodeId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNodeId</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public abstract void setNodeId(<a href="../../../../../../org/apache/hadoop/yarn/api/records/NodeId.html" title="class in org.apache.hadoop.yarn.api.records">NodeId</a> nodeId)</pre> |
| </li> |
| </ul> |
| <a name="getNodeHttpAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNodeHttpAddress</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getNodeHttpAddress()</pre> |
| <div class="block">Get the http uri of the node on which the container is allocated.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>http uri of the node on which the container is allocated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNodeHttpAddress-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNodeHttpAddress</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public abstract void setNodeHttpAddress(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nodeHttpAddress)</pre> |
| </li> |
| </ul> |
| <a name="getExposedPorts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExposedPorts</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>>> getExposedPorts()</pre> |
| <div class="block">Get the exposed ports of the node on which the container is allocated.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>exposed ports of the node on which the container is allocated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExposedPorts-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExposedPorts</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public abstract void setExposedPorts(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>>> ports)</pre> |
| </li> |
| </ul> |
| <a name="getResource--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResource</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| public abstract <a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> getResource()</pre> |
| <div class="block">Get the <code>Resource</code> allocated to the container.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>Resource</code> allocated to the container</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setResource-org.apache.hadoop.yarn.api.records.Resource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResource</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public abstract void setResource(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Resource.html" title="class in org.apache.hadoop.yarn.api.records">Resource</a> resource)</pre> |
| </li> |
| </ul> |
| <a name="getPriority--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPriority</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| public abstract <a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a> getPriority()</pre> |
| <div class="block">Get the <code>Priority</code> at which the <code>Container</code> was |
| allocated.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>Priority</code> at which the <code>Container</code> was |
| allocated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPriority-org.apache.hadoop.yarn.api.records.Priority-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPriority</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public abstract void setPriority(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Priority.html" title="class in org.apache.hadoop.yarn.api.records">Priority</a> priority)</pre> |
| </li> |
| </ul> |
| <a name="getContainerToken--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContainerToken</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| public abstract <a href="../../../../../../org/apache/hadoop/yarn/api/records/Token.html" title="class in org.apache.hadoop.yarn.api.records">Token</a> getContainerToken()</pre> |
| <div class="block">Get the <code>ContainerToken</code> for the container. |
| <p><code>ContainerToken</code> is the security token used by the framework |
| to verify authenticity of any <code>Container</code>.</p> |
| |
| <p>The <code>ResourceManager</code>, on container allocation provides a |
| secure token which is verified by the <code>NodeManager</code> on |
| container launch.</p> |
| |
| <p>Applications do not need to care about <code>ContainerToken</code>, they |
| are transparently handled by the framework - the allocated |
| <code>Container</code> includes the <code>ContainerToken</code>.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>ContainerToken</code> for the container</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/hadoop/yarn/api/ApplicationMasterProtocol.html#allocate-org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest-"><code>ApplicationMasterProtocol.allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)</code></a>, |
| <a href="../../../../../../org/apache/hadoop/yarn/api/ContainerManagementProtocol.html#startContainers-org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest-"><code>ContainerManagementProtocol.startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setContainerToken-org.apache.hadoop.yarn.api.records.Token-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContainerToken</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public abstract void setContainerToken(<a href="../../../../../../org/apache/hadoop/yarn/api/records/Token.html" title="class in org.apache.hadoop.yarn.api.records">Token</a> containerToken)</pre> |
| </li> |
| </ul> |
| <a name="getExecutionType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutionType</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public abstract <a href="../../../../../../org/apache/hadoop/yarn/api/records/ExecutionType.html" title="enum in org.apache.hadoop.yarn.api.records">ExecutionType</a> getExecutionType()</pre> |
| <div class="block">Get the <code>ExecutionType</code> for the container.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>ExecutionType</code> for the container.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExecutionType-org.apache.hadoop.yarn.api.records.ExecutionType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExecutionType</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public abstract void setExecutionType(<a href="../../../../../../org/apache/hadoop/yarn/api/records/ExecutionType.html" title="enum in org.apache.hadoop.yarn.api.records">ExecutionType</a> executionType)</pre> |
| <div class="block">Set the <code>ExecutionType</code> for the container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executionType</code> - ExecutionType</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllocationRequestId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllocationRequestId</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Evolving |
| public long getAllocationRequestId()</pre> |
| <div class="block">Get the optional <em>ID</em> corresponding to the original <code>ResourceRequest{@link #getAllocationRequestId()}</code>s which is satisfied by |
| this allocated <code>Container</code>. |
| <p> |
| The scheduler may return multiple <code>AllocateResponse</code>s corresponding |
| to the same ID as and when scheduler allocates <code>Container</code>s. |
| <b>Applications</b> can continue to completely ignore the returned ID in |
| the response and use the allocation for any of their outstanding requests. |
| <p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <em>ID</em> corresponding to the original allocation request |
| which is satisfied by this allocation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAllocationRequestId-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAllocationRequestId</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public void setAllocationRequestId(long allocationRequestID)</pre> |
| <div class="block">Set the optional <em>ID</em> corresponding to the original <code>ResourceRequest{@link #setAllocationRequestId(long)} |
| etAllocationRequestId()</code>}s which is satisfied by this allocated <code>Container</code>. |
| <p> |
| The scheduler may return multiple <code>AllocateResponse</code>s corresponding |
| to the same ID as and when scheduler allocates <code>Container</code>s. |
| <b>Applications</b> can continue to completely ignore the returned ID in |
| the response and use the allocation for any of their outstanding requests. |
| If the ID is not set, scheduler will continue to work as previously and all |
| allocated <code>Container</code>(s) will have the default ID, -1. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allocationRequestID</code> - the <em>ID</em> corresponding to the original |
| allocation request which is satisfied by this |
| allocation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVersion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVersion</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public int getVersion()</pre> |
| <div class="block">Get the version of this container. The version will be incremented when |
| a container is updated.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>version of this container.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVersion-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVersion</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public void setVersion(int version)</pre> |
| <div class="block">Set the version of this container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>version</code> - of this container.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllocationTags--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllocationTags</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getAllocationTags()</pre> |
| </li> |
| </ul> |
| <a name="setAllocationTags-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setAllocationTags</h4> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public void setAllocationTags(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> allocationTags)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Container.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/records/CollectorInfo.html" title="class in org.apache.hadoop.yarn.api.records"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/yarn/api/records/ContainerExitStatus.html" title="class in org.apache.hadoop.yarn.api.records"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/yarn/api/records/Container.html" target="_top">Frames</a></li> |
| <li><a href="Container.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
