| <!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>PlacementConstraintsUtil (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="PlacementConstraintsUtil (Apache Hadoop YARN ResourceManager 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/PlacementConstraintsUtil.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/PlacementConstraintManagerService.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/TargetApplications.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/PlacementConstraintsUtil.html" target="_top">Frames</a></li> |
| <li><a href="PlacementConstraintsUtil.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="Class PlacementConstraintsUtil" class="title">Class PlacementConstraintsUtil</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.PlacementConstraintsUtil</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| public final class <span class="typeNameLabel">PlacementConstraintsUtil</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">This class contains various static methods used by the Placement Algorithms |
| to simplify constrained placement. |
| (see also <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/algorithm/DefaultPlacementAlgorithm.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.algorithm"><code>DefaultPlacementAlgorithm</code></a>).</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintsUtil.html#canSatisfyConstraints-org.apache.hadoop.yarn.api.records.ApplicationId-org.apache.hadoop.yarn.api.records.SchedulingRequest-org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedulerNode-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.PlacementConstraintManager-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.AllocationTagsManager-">canSatisfyConstraints</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| org.apache.hadoop.yarn.api.records.SchedulingRequest request, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerNode</a> schedulerNode, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">PlacementConstraintManager</a> pcm, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTagsManager</a> atm)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintsUtil.html#canSatisfyConstraints-org.apache.hadoop.yarn.api.records.ApplicationId-org.apache.hadoop.yarn.api.records.SchedulingRequest-org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedulerNode-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.PlacementConstraintManager-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.AllocationTagsManager-java.util.Optional-">canSatisfyConstraints</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| org.apache.hadoop.yarn.api.records.SchedulingRequest request, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerNode</a> schedulerNode, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">PlacementConstraintManager</a> pcm, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTagsManager</a> atm, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/activities/DiagnosticsCollector.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.activities">DiagnosticsCollector</a>> dcOpt)</code> |
| <div class="block">Returns true if the placement constraint for a given scheduling request |
| is <b>currently</b> satisfied by the specific scheduler node.</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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="canSatisfyConstraints-org.apache.hadoop.yarn.api.records.ApplicationId-org.apache.hadoop.yarn.api.records.SchedulingRequest-org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedulerNode-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.PlacementConstraintManager-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.AllocationTagsManager-java.util.Optional-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canSatisfyConstraints</h4> |
| <pre>public static boolean canSatisfyConstraints(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| org.apache.hadoop.yarn.api.records.SchedulingRequest request, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerNode</a> schedulerNode, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">PlacementConstraintManager</a> pcm, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTagsManager</a> atm, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/activities/DiagnosticsCollector.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.activities">DiagnosticsCollector</a>> dcOpt) |
| 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">Returns true if the placement constraint for a given scheduling request |
| is <b>currently</b> satisfied by the specific scheduler node. This method |
| first validates the constraint specified in the request; if not specified, |
| then it validates application level constraint if exists; otherwise, it |
| validates the global constraint if exists. |
| |
| This method only checks whether a scheduling request can be placed |
| on a node with respect to the certain placement constraint. It gives no |
| guarantee that asked allocations can be eventually allocated because |
| it doesn't check resource, that needs to be further decided by a scheduler.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>applicationId</code> - application id</dd> |
| <dd><code>request</code> - scheduling request</dd> |
| <dd><code>schedulerNode</code> - node</dd> |
| <dd><code>pcm</code> - placement constraint manager</dd> |
| <dd><code>atm</code> - allocation tags manager</dd> |
| <dd><code>dcOpt</code> - optional diagnostics collector</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the given node satisfies the constraint of the request</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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canSatisfyConstraints-org.apache.hadoop.yarn.api.records.ApplicationId-org.apache.hadoop.yarn.api.records.SchedulingRequest-org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedulerNode-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.PlacementConstraintManager-org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.AllocationTagsManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>canSatisfyConstraints</h4> |
| <pre>public static boolean canSatisfyConstraints(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| org.apache.hadoop.yarn.api.records.SchedulingRequest request, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerNode</a> schedulerNode, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/PlacementConstraintManager.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">PlacementConstraintManager</a> pcm, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/constraint/AllocationTagsManager.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint">AllocationTagsManager</a> atm) |
| 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> |
| <dl> |
| <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></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/PlacementConstraintsUtil.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/PlacementConstraintManagerService.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/TargetApplications.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/PlacementConstraintsUtil.html" target="_top">Frames</a></li> |
| <li><a href="PlacementConstraintsUtil.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> |
