| <!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>PlacementConstraintManager (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="PlacementConstraintManager (Apache Hadoop YARN ResourceManager 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/PlacementConstraintManager.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/MemoryPlacementConstraintManager.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/PlacementConstraintManagerService.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/PlacementConstraintManager.html" target="_top">Frames</a></li> |
| <li><a href="PlacementConstraintManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint</div> |
| <h2 title="Interface PlacementConstraintManager" class="title">Interface PlacementConstraintManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/MemoryPlacementConstraintManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">MemoryPlacementConstraintManager</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManagerService.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">PlacementConstraintManagerService</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public interface <span class="typeNameLabel">PlacementConstraintManager</span></pre> |
| <div class="block">Interface for storing and retrieving placement constraints (see |
| <code>PlacementConstraint</code>).</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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/PlacementConstraintManager.html#addConstraint-org.apache.hadoop.yarn.api.records.ApplicationId-java.util.Set-org.apache.hadoop.yarn.api.resource.PlacementConstraint-boolean-">addConstraint</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <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>> sourceTags, |
| org.apache.hadoop.yarn.api.resource.PlacementConstraint placementConstraint, |
| boolean replace)</code> |
| <div class="block">Add a placement constraint for a given application and a given set of |
| (source) allocation tags.</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/PlacementConstraintManager.html#addGlobalConstraint-java.util.Set-org.apache.hadoop.yarn.api.resource.PlacementConstraint-boolean-">addGlobalConstraint</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>> sourceTags, |
| org.apache.hadoop.yarn.api.resource.PlacementConstraint placementConstraint, |
| boolean replace)</code> |
| <div class="block">Add a placement constraint that will be used globally.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.resource.PlacementConstraint</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html#getConstraint-org.apache.hadoop.yarn.api.records.ApplicationId-java.util.Set-">getConstraint</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <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>> sourceTags)</code> |
| <div class="block">Retrieve the placement constraint that is associated with a set of |
| allocation tags for a given application.</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/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>>,org.apache.hadoop.yarn.api.resource.PlacementConstraint></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html#getConstraints-org.apache.hadoop.yarn.api.records.ApplicationId-">getConstraints</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId appId)</code> |
| <div class="block">Retrieve all constraints for a given application, along with the allocation |
| tags that enable each constraint.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.resource.PlacementConstraint</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html#getGlobalConstraint-java.util.Set-">getGlobalConstraint</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>> sourceTags)</code> |
| <div class="block">Retrieve a global constraint that is associated with a given set of |
| allocation tags.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.resource.PlacementConstraint</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html#getMultilevelConstraint-org.apache.hadoop.yarn.api.records.ApplicationId-java.util.Set-org.apache.hadoop.yarn.api.resource.PlacementConstraint-">getMultilevelConstraint</a></span>(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>> sourceTags, |
| org.apache.hadoop.yarn.api.resource.PlacementConstraint schedulingRequestConstraint)</code> |
| <div class="block">Consider all levels of constraints (scheduling request, app, cluster) and |
| return a merged constraint.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html#getNumGlobalConstraints--">getNumGlobalConstraints</a></span>()</code> |
| <div class="block">Returns the number of global constraints registered in the Placement |
| Constraint Manager.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html#getNumRegisteredApplications--">getNumRegisteredApplications</a></span>()</code> |
| <div class="block">Returns the number of currently registered applications in the Placement |
| Constraint Manager.</div> |
| </td> |
| </tr> |
| <tr id="i8" 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/PlacementConstraintManager.html#registerApplication-org.apache.hadoop.yarn.api.records.ApplicationId-java.util.Map-">registerApplication</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>,org.apache.hadoop.yarn.api.resource.PlacementConstraint> constraintMap)</code> |
| <div class="block">Register all placement constraints of an application.</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/PlacementConstraintManager.html#removeGlobalConstraint-java.util.Set-">removeGlobalConstraint</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>> sourceTags)</code> |
| <div class="block">Remove a global constraint that is associated with the given allocation |
| tags.</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/PlacementConstraintManager.html#unregisterApplication-org.apache.hadoop.yarn.api.records.ApplicationId-">unregisterApplication</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId appId)</code> |
| <div class="block">Remove the constraints that correspond to a given application.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html#validateConstraint-java.util.Set-org.apache.hadoop.yarn.api.resource.PlacementConstraint-">validateConstraint</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>> sourceTags, |
| org.apache.hadoop.yarn.api.resource.PlacementConstraint placementConstraint)</code> |
| <div class="block">Validate a placement constraint and the set of allocation tags that will |
| enable it.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="registerApplication-org.apache.hadoop.yarn.api.records.ApplicationId-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerApplication</h4> |
| <pre>void registerApplication(org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>,org.apache.hadoop.yarn.api.resource.PlacementConstraint> constraintMap)</pre> |
| <div class="block">Register all placement constraints of an application.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appId</code> - the application ID</dd> |
| <dd><code>constraintMap</code> - the map of allocation tags to constraints for this |
| application</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addConstraint-org.apache.hadoop.yarn.api.records.ApplicationId-java.util.Set-org.apache.hadoop.yarn.api.resource.PlacementConstraint-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addConstraint</h4> |
| <pre>void addConstraint(org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <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>> sourceTags, |
| org.apache.hadoop.yarn.api.resource.PlacementConstraint placementConstraint, |
| boolean replace)</pre> |
| <div class="block">Add a placement constraint for a given application and a given set of |
| (source) allocation tags. The constraint will be used on Scheduling |
| Requests that carry this set of allocation tags. |
| TODO: Support merge and not only replace when adding a constraint.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appId</code> - the application ID</dd> |
| <dd><code>sourceTags</code> - the set of allocation tags that will enable this |
| constraint</dd> |
| <dd><code>placementConstraint</code> - the constraint</dd> |
| <dd><code>replace</code> - if true, an existing constraint for these tags will be |
| replaced by the given one</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addGlobalConstraint-java.util.Set-org.apache.hadoop.yarn.api.resource.PlacementConstraint-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addGlobalConstraint</h4> |
| <pre>void addGlobalConstraint(<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>> sourceTags, |
| org.apache.hadoop.yarn.api.resource.PlacementConstraint placementConstraint, |
| boolean replace)</pre> |
| <div class="block">Add a placement constraint that will be used globally. These constraints |
| are added by the cluster administrator. |
| TODO: Support merge and not only replace when adding a constraint.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sourceTags</code> - the allocation tags that will enable this constraint</dd> |
| <dd><code>placementConstraint</code> - the constraint</dd> |
| <dd><code>replace</code> - if true, an existing constraint for these tags will be |
| replaced by the given one</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConstraints-org.apache.hadoop.yarn.api.records.ApplicationId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConstraints</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>,org.apache.hadoop.yarn.api.resource.PlacementConstraint> getConstraints(org.apache.hadoop.yarn.api.records.ApplicationId appId)</pre> |
| <div class="block">Retrieve all constraints for a given application, along with the allocation |
| tags that enable each constraint.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appId</code> - the application ID</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the constraints for this application with the associated tags</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConstraint-org.apache.hadoop.yarn.api.records.ApplicationId-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConstraint</h4> |
| <pre>org.apache.hadoop.yarn.api.resource.PlacementConstraint getConstraint(org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <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>> sourceTags)</pre> |
| <div class="block">Retrieve the placement constraint that is associated with a set of |
| allocation tags for a given application.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appId</code> - the application ID</dd> |
| <dd><code>sourceTags</code> - the allocation tags that enable this constraint</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the constraint</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGlobalConstraint-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGlobalConstraint</h4> |
| <pre>org.apache.hadoop.yarn.api.resource.PlacementConstraint getGlobalConstraint(<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>> sourceTags)</pre> |
| <div class="block">Retrieve a global constraint that is associated with a given set of |
| allocation tags.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sourceTags</code> - the allocation tags that enable this constraint</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the constraint</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMultilevelConstraint-org.apache.hadoop.yarn.api.records.ApplicationId-java.util.Set-org.apache.hadoop.yarn.api.resource.PlacementConstraint-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMultilevelConstraint</h4> |
| <pre>org.apache.hadoop.yarn.api.resource.PlacementConstraint getMultilevelConstraint(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>> sourceTags, |
| org.apache.hadoop.yarn.api.resource.PlacementConstraint schedulingRequestConstraint)</pre> |
| <div class="block">Consider all levels of constraints (scheduling request, app, cluster) and |
| return a merged constraint.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>applicationId</code> - application ID</dd> |
| <dd><code>sourceTags</code> - a set of source allocation tags</dd> |
| <dd><code>schedulingRequestConstraint</code> - placement constraint at scheduling |
| request level</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a merged placement constraint</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unregisterApplication-org.apache.hadoop.yarn.api.records.ApplicationId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unregisterApplication</h4> |
| <pre>void unregisterApplication(org.apache.hadoop.yarn.api.records.ApplicationId appId)</pre> |
| <div class="block">Remove the constraints that correspond to a given application.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appId</code> - the application that will be removed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeGlobalConstraint-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeGlobalConstraint</h4> |
| <pre>void removeGlobalConstraint(<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>> sourceTags)</pre> |
| <div class="block">Remove a global constraint that is associated with the given allocation |
| tags.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sourceTags</code> - the allocation tags</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNumRegisteredApplications--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumRegisteredApplications</h4> |
| <pre>int getNumRegisteredApplications()</pre> |
| <div class="block">Returns the number of currently registered applications in the Placement |
| Constraint Manager.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of registered applications.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNumGlobalConstraints--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumGlobalConstraints</h4> |
| <pre>int getNumGlobalConstraints()</pre> |
| <div class="block">Returns the number of global constraints registered in the Placement |
| Constraint Manager.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of global constraints.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateConstraint-java.util.Set-org.apache.hadoop.yarn.api.resource.PlacementConstraint-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>validateConstraint</h4> |
| <pre>default boolean validateConstraint(<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>> sourceTags, |
| org.apache.hadoop.yarn.api.resource.PlacementConstraint placementConstraint)</pre> |
| <div class="block">Validate a placement constraint and the set of allocation tags that will |
| enable it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sourceTags</code> - the associated allocation tags</dd> |
| <dd><code>placementConstraint</code> - the constraint</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if constraint and tags are valid</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/PlacementConstraintManager.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/MemoryPlacementConstraintManager.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/PlacementConstraintManagerService.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/PlacementConstraintManager.html" target="_top">Frames</a></li> |
| <li><a href="PlacementConstraintManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
