| <!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:10:59 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>LocalityRouterPolicy (Apache Hadoop YARN Server Common 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="LocalityRouterPolicy (Apache Hadoop YARN Server Common 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":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/LocalityRouterPolicy.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/federation/policies/router/LoadBasedRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/PriorityRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/federation/policies/router/LocalityRouterPolicy.html" target="_top">Frames</a></li> |
| <li><a href="LocalityRouterPolicy.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.federation.policies.router</div> |
| <h2 title="Class LocalityRouterPolicy" class="title">Class LocalityRouterPolicy</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><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies">org.apache.hadoop.yarn.server.federation.policies.AbstractConfigurableFederationPolicy</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/AbstractRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">org.apache.hadoop.yarn.server.federation.policies.router.AbstractRouterPolicy</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/WeightedRandomRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">org.apache.hadoop.yarn.server.federation.policies.router.WeightedRandomRouterPolicy</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.yarn.server.federation.policies.router.LocalityRouterPolicy</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html" title="interface in org.apache.hadoop.yarn.server.federation.policies">ConfigurableFederationPolicy</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/FederationRouterPolicy.html" title="interface in org.apache.hadoop.yarn.server.federation.policies.router">FederationRouterPolicy</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">LocalityRouterPolicy</span> |
| extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/WeightedRandomRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">WeightedRandomRouterPolicy</a></pre> |
| <div class="block">This policy selects the subcluster depending on the node where the Client |
| wants to run its application. |
| |
| It succeeds if: |
| |
| - There are three AMContainerResourceRequests in the order |
| NODE, RACK, ANY |
| |
| It falls back to WeightedRandomRouterPolicy in case of: |
| |
| - Null or empty AMContainerResourceRequests; |
| |
| - One AMContainerResourceRequests and it has ANY as ResourceName; |
| |
| - The node is in blacklisted SubClusters. |
| |
| It fails if: |
| |
| - The node does not exist and RelaxLocality is False; |
| |
| - We have an invalid number (not 0, 1 or 3) resource requests</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/LocalityRouterPolicy.html#LOG">LOG</a></span></code> </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/federation/policies/router/LocalityRouterPolicy.html#LocalityRouterPolicy--">LocalityRouterPolicy</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterId.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterId</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/LocalityRouterPolicy.html#getHomeSubcluster-org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext-java.util.List-">getHomeSubcluster</a></span>(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext appSubmissionContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterId.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterId</a>> blackListSubClusters)</code> |
| <div class="block">Determines the sub-cluster that the user application submission should be |
| routed to.</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/federation/policies/router/LocalityRouterPolicy.html#reinitialize-org.apache.hadoop.yarn.server.federation.policies.FederationPolicyInitializationContext-">reinitialize</a></span>(<a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies">FederationPolicyInitializationContext</a> policyContext)</code> |
| <div class="block">This method is invoked to initialize of update the configuration of |
| policies.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.server.federation.policies.router.AbstractRouterPolicy"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.yarn.server.federation.policies.router.<a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/AbstractRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">AbstractRouterPolicy</a></h3> |
| <code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/AbstractRouterPolicy.html#validate-org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext-">validate</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/AbstractRouterPolicy.html#validate-org.apache.hadoop.yarn.server.federation.policies.dao.WeightedPolicyInfo-">validate</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.server.federation.policies.AbstractConfigurableFederationPolicy"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.yarn.server.federation.policies.<a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies">AbstractConfigurableFederationPolicy</a></h3> |
| <code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#getActiveSubclusters--">getActiveSubclusters</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#getIsDirty--">getIsDirty</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#getPolicyContext--">getPolicyContext</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#getPolicyInfo--">getPolicyInfo</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#setPolicyContext-org.apache.hadoop.yarn.server.federation.policies.FederationPolicyInitializationContext-">setPolicyContext</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#setPolicyInfo-org.apache.hadoop.yarn.server.federation.policies.dao.WeightedPolicyInfo-">setPolicyInfo</a></code></li> |
| </ul> |
| <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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="LOG"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LOG</h4> |
| <pre>public static final org.slf4j.Logger LOG</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="LocalityRouterPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LocalityRouterPolicy</h4> |
| <pre>public LocalityRouterPolicy()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="reinitialize-org.apache.hadoop.yarn.server.federation.policies.FederationPolicyInitializationContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reinitialize</h4> |
| <pre>public void reinitialize(<a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies">FederationPolicyInitializationContext</a> policyContext) |
| throws <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/exceptions/FederationPolicyInitializationException.html" title="class in org.apache.hadoop.yarn.server.federation.policies.exceptions">FederationPolicyInitializationException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html#reinitialize-org.apache.hadoop.yarn.server.federation.policies.FederationPolicyInitializationContext-">ConfigurableFederationPolicy</a></code></span></div> |
| <div class="block">This method is invoked to initialize of update the configuration of |
| policies. The implementor should provide try-n-swap semantics, and retain |
| state if possible.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html#reinitialize-org.apache.hadoop.yarn.server.federation.policies.FederationPolicyInitializationContext-">reinitialize</a></code> in interface <code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html" title="interface in org.apache.hadoop.yarn.server.federation.policies">ConfigurableFederationPolicy</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#reinitialize-org.apache.hadoop.yarn.server.federation.policies.FederationPolicyInitializationContext-">reinitialize</a></code> in class <code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies">AbstractConfigurableFederationPolicy</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>policyContext</code> - the new context to provide to implementor.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/exceptions/FederationPolicyInitializationException.html" title="class in org.apache.hadoop.yarn.server.federation.policies.exceptions">FederationPolicyInitializationException</a></code> - in case the initialization |
| fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHomeSubcluster-org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getHomeSubcluster</h4> |
| <pre>public <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterId.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterId</a> getHomeSubcluster(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext appSubmissionContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterId.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterId</a>> blackListSubClusters) |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/FederationRouterPolicy.html#getHomeSubcluster-org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext-java.util.List-">FederationRouterPolicy</a></code></span></div> |
| <div class="block">Determines the sub-cluster that the user application submission should be |
| routed to.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/FederationRouterPolicy.html#getHomeSubcluster-org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext-java.util.List-">getHomeSubcluster</a></code> in interface <code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/FederationRouterPolicy.html" title="interface in org.apache.hadoop.yarn.server.federation.policies.router">FederationRouterPolicy</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/WeightedRandomRouterPolicy.html#getHomeSubcluster-org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext-java.util.List-">getHomeSubcluster</a></code> in class <code><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/WeightedRandomRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">WeightedRandomRouterPolicy</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appSubmissionContext</code> - the <code>ApplicationSubmissionContext</code> that |
| has to be routed to an appropriate subCluster for execution.</dd> |
| <dd><code>blackListSubClusters</code> - the list of subClusters as identified by |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterId.html" title="class in org.apache.hadoop.yarn.server.federation.store.records"><code>SubClusterId</code></a> to blackList from the selection of the home |
| subCluster.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterId.html" title="class in org.apache.hadoop.yarn.server.federation.store.records"><code>SubClusterId</code></a> that will be the "home" for this |
| application.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if the policy cannot determine a viable subcluster.</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/LocalityRouterPolicy.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/federation/policies/router/LoadBasedRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/PriorityRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/federation/policies/router/LocalityRouterPolicy.html" target="_top">Frames</a></li> |
| <li><a href="LocalityRouterPolicy.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> |