| <!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:12:13 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AllocationTagsManager (Apache Hadoop YARN ResourceManager 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="AllocationTagsManager (Apache Hadoop YARN ResourceManager 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AllocationTagsManager.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.TypeToCountedTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html" target="_top">Frames</a></li> |
| <li><a href="AllocationTagsManager.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><a href="#nested.class.summary">Nested</a> | </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.server.resourcemanager.scheduler.constraint</div> |
| <h2 title="Class AllocationTagsManager" class="title">Class AllocationTagsManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.AllocationTagsManager</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public class <span class="typeNameLabel">AllocationTagsManager</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">In-memory mapping between applications/container-tags and nodes/racks. |
| Required by constrained affinity/anti-affinity and cardinality placement.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.TypeToCountedTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTagsManager.TypeToCountedTags</a><<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.TypeToCountedTags.html" title="type parameter in AllocationTagsManager.TypeToCountedTags">T</a>></span></code> |
| <div class="block">Generic store mapping type T to counted tags.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html#AllocationTagsManager-org.apache.hadoop.yarn.server.resourcemanager.RMContext-">AllocationTagsManager</a></span>(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMContext</a> context)</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html#addContainer-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.api.records.ContainerId-java.util.Set-">addContainer</a></span>(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| org.apache.hadoop.yarn.api.records.ContainerId containerId, |
| <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> |
| <div class="block">Notify container allocated on a node.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html#addTags-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.api.records.ApplicationId-java.util.Set-">addTags</a></span>(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| <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="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html#allocationTagExistsOnNode-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-">allocationTagExistsOnNode</a></span>(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| <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> tag)</code> |
| <div class="block">Check if given tag exists on node.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><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/Long.html?is-external=true" title="class or interface in java.lang">Long</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html#getAllocationTagsWithCount-org.apache.hadoop.yarn.api.records.NodeId-">getAllocationTagsWithCount</a></span>(org.apache.hadoop.yarn.api.records.NodeId nodeId)</code> |
| <div class="block">Returns a map whose key is the allocation tag and value is the |
| count of allocations with this tag.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html#getNodeCardinality-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-">getNodeCardinality</a></span>(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| <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> tag)</code> |
| <div class="block">Get Node cardinality for a specific tag.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html#getNodeCardinalityByOp-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.AllocationTags-java.util.function.LongBinaryOperator-">getNodeCardinalityByOp</a></span>(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTags</a> tags, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/LongBinaryOperator.html?is-external=true" title="class or interface in java.util.function">LongBinaryOperator</a> op)</code> |
| <div class="block">Get cardinality for following conditions.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><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><org.apache.hadoop.yarn.api.records.ApplicationId,<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.TypeToCountedTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTagsManager.TypeToCountedTags</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html#getPerAppNodeMappings--">getPerAppNodeMappings</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html#getRackCardinality-java.lang.String-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-">getRackCardinality</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> rack, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| <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> tag)</code> |
| <div class="block">Get Rack cardinality for a specific tag.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html#getRackCardinalityByOp-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.AllocationTags-java.util.function.LongBinaryOperator-">getRackCardinalityByOp</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> rack, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTags</a> tags, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/LongBinaryOperator.html?is-external=true" title="class or interface in java.util.function">LongBinaryOperator</a> op)</code> |
| <div class="block">Get cardinality for following conditions.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html#removeContainer-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.api.records.ContainerId-java.util.Set-">removeContainer</a></span>(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| org.apache.hadoop.yarn.api.records.ContainerId containerId, |
| <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> |
| <div class="block">Notify container removed.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html#removeTags-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.api.records.ApplicationId-java.util.Set-">removeTags</a></span>(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| <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> |
| <div class="block">Helper method to just remove the tags associated with a 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> |
| </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="AllocationTagsManager-org.apache.hadoop.yarn.server.resourcemanager.RMContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AllocationTagsManager</h4> |
| <pre>public AllocationTagsManager(<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMContext</a> context)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getPerAppNodeMappings--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPerAppNodeMappings</h4> |
| <pre>public <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><org.apache.hadoop.yarn.api.records.ApplicationId,<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.TypeToCountedTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTagsManager.TypeToCountedTags</a>> getPerAppNodeMappings()</pre> |
| </li> |
| </ul> |
| <a name="addContainer-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.api.records.ContainerId-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addContainer</h4> |
| <pre>public void addContainer(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| org.apache.hadoop.yarn.api.records.ContainerId containerId, |
| <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> |
| <div class="block">Notify container allocated on a node.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeId</code> - allocated node.</dd> |
| <dd><code>containerId</code> - container id.</dd> |
| <dd><code>allocationTags</code> - allocation tags, see |
| <code>SchedulingRequest.getAllocationTags()</code> |
| application_id will be added to allocationTags.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addTags-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.api.records.ApplicationId-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addTags</h4> |
| <pre>public void addTags(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| <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> |
| <a name="removeContainer-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.api.records.ContainerId-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeContainer</h4> |
| <pre>public void removeContainer(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| org.apache.hadoop.yarn.api.records.ContainerId containerId, |
| <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> |
| <div class="block">Notify container removed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeId</code> - nodeId</dd> |
| <dd><code>containerId</code> - containerId.</dd> |
| <dd><code>allocationTags</code> - allocation tags for given container</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeTags-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.api.records.ApplicationId-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeTags</h4> |
| <pre>public void removeTags(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| <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> |
| <div class="block">Helper method to just remove the tags associated with a container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeId</code> - </dd> |
| <dd><code>applicationId</code> - </dd> |
| <dd><code>allocationTags</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNodeCardinality-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNodeCardinality</h4> |
| <pre>public long getNodeCardinality(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| <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> tag) |
| throws <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/InvalidAllocationTagsQueryException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">InvalidAllocationTagsQueryException</a></pre> |
| <div class="block">Get Node cardinality for a specific tag. |
| When applicationId is null, method returns aggregated cardinality</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeId</code> - nodeId, required.</dd> |
| <dd><code>applicationId</code> - applicationId. When null is specified, return |
| aggregated cardinality among all nodes.</dd> |
| <dd><code>tag</code> - allocation tag, see |
| <code>SchedulingRequest.getAllocationTags()</code>, |
| If a specified tag doesn't exist, |
| method returns 0.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>cardinality of specified query on the node.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/InvalidAllocationTagsQueryException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">InvalidAllocationTagsQueryException</a></code> - when illegal query |
| parameter specified</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRackCardinality-java.lang.String-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRackCardinality</h4> |
| <pre>public long getRackCardinality(<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> rack, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| <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> tag) |
| throws <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/InvalidAllocationTagsQueryException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">InvalidAllocationTagsQueryException</a></pre> |
| <div class="block">Get Rack cardinality for a specific tag.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rack</code> - rack, required.</dd> |
| <dd><code>applicationId</code> - applicationId. When null is specified, return |
| aggregated cardinality among all nodes.</dd> |
| <dd><code>tag</code> - allocation tag, see |
| <code>SchedulingRequest.getAllocationTags()</code>, |
| If a specified tag doesn't exist, |
| method returns 0.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>cardinality of specified query on the rack.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/InvalidAllocationTagsQueryException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">InvalidAllocationTagsQueryException</a></code> - when illegal query |
| parameter specified</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allocationTagExistsOnNode-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocationTagExistsOnNode</h4> |
| <pre>public boolean allocationTagExistsOnNode(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| <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> tag) |
| throws <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/InvalidAllocationTagsQueryException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">InvalidAllocationTagsQueryException</a></pre> |
| <div class="block">Check if given tag exists on node.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeId</code> - nodeId, required.</dd> |
| <dd><code>applicationId</code> - applicationId. When null is specified, return |
| aggregation among all applications.</dd> |
| <dd><code>tag</code> - allocation tag, see |
| <code>SchedulingRequest.getAllocationTags()</code>, |
| When multiple tags specified. Returns cardinality |
| depends on op. If a specified tag doesn't exist, |
| 0 will be its cardinality. |
| When null/empty tags specified, all tags |
| (of the node/app) will be considered.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>cardinality of specified query on the node.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/InvalidAllocationTagsQueryException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">InvalidAllocationTagsQueryException</a></code> - when illegal query |
| parameter specified</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNodeCardinalityByOp-org.apache.hadoop.yarn.api.records.NodeId-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.AllocationTags-java.util.function.LongBinaryOperator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNodeCardinalityByOp</h4> |
| <pre>public long getNodeCardinalityByOp(org.apache.hadoop.yarn.api.records.NodeId nodeId, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTags</a> tags, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/LongBinaryOperator.html?is-external=true" title="class or interface in java.util.function">LongBinaryOperator</a> op) |
| throws <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/InvalidAllocationTagsQueryException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">InvalidAllocationTagsQueryException</a></pre> |
| <div class="block">Get cardinality for following conditions. External can pass-in a binary op |
| to implement customized logic.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeId</code> - nodeId, required.</dd> |
| <dd><code>tags</code> - <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint"><code>AllocationTags</code></a>, allocation tags under a |
| specific namespace. See |
| <code>SchedulingRequest.getAllocationTags()</code>, |
| When multiple tags specified. Returns cardinality |
| depends on op. If a specified tag doesn't exist, 0 |
| will be its cardinality. When null/empty tags |
| specified, all tags (of the node/app) will be |
| considered.</dd> |
| <dd><code>op</code> - operator. Such as Long::max, Long::sum, etc. Required. |
| This parameter only take effect when #values greater |
| than 2.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>cardinality of specified query on the node.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/InvalidAllocationTagsQueryException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">InvalidAllocationTagsQueryException</a></code> - when illegal query |
| parameter specified</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRackCardinalityByOp-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.AllocationTags-java.util.function.LongBinaryOperator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRackCardinalityByOp</h4> |
| <pre>public long getRackCardinalityByOp(<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> rack, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTags</a> tags, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/LongBinaryOperator.html?is-external=true" title="class or interface in java.util.function">LongBinaryOperator</a> op) |
| throws <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/InvalidAllocationTagsQueryException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">InvalidAllocationTagsQueryException</a></pre> |
| <div class="block">Get cardinality for following conditions. External can pass-in a binary op |
| to implement customized logic.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rack</code> - rack, required.</dd> |
| <dd><code>tags</code> - <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint"><code>AllocationTags</code></a>, allocation tags under a |
| specific namespace. See |
| <code>SchedulingRequest.getAllocationTags()</code>, |
| When multiple tags specified. Returns cardinality |
| depends on op. If a specified tag doesn't exist, 0 |
| will be its cardinality. When null/empty tags |
| specified, all tags (of the rack/app) will be |
| considered.</dd> |
| <dd><code>op</code> - operator. Such as Long::max, Long::sum, etc. Required. |
| This parameter only take effect when #values |
| greater than 2.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>cardinality of specified query on the rack.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/InvalidAllocationTagsQueryException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">InvalidAllocationTagsQueryException</a></code> - when illegal query |
| parameter specified</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllocationTagsWithCount-org.apache.hadoop.yarn.api.records.NodeId-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getAllocationTagsWithCount</h4> |
| <pre>public <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/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> getAllocationTagsWithCount(org.apache.hadoop.yarn.api.records.NodeId nodeId)</pre> |
| <div class="block">Returns a map whose key is the allocation tag and value is the |
| count of allocations with this tag.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeId</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>allocation tag to count mapping</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/AllocationTagsManager.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.TypeToCountedTags.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html" target="_top">Frames</a></li> |
| <li><a href="AllocationTagsManager.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><a href="#nested.class.summary">Nested</a> | </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> |
