Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-server / hadoop-yarn-server-common / apidocs / org / apache / hadoop / yarn / server / federation / store / FederationPolicyStore.html
blob: 9116fee01edd81d858ebabf2b13c2a5af1f3c809 [file] [log] [blame]
<!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>FederationPolicyStore (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="FederationPolicyStore (Apache Hadoop YARN Server Common 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/FederationPolicyStore.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/store/FederationMembershipStateStore.html" title="interface in org.apache.hadoop.yarn.server.federation.store"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/FederationStateStore.html" title="interface in org.apache.hadoop.yarn.server.federation.store"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/federation/store/FederationPolicyStore.html" target="_top">Frames</a></li>
<li><a href="FederationPolicyStore.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.store</div>
<h2 title="Interface FederationPolicyStore" class="title">Interface FederationPolicyStore</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/FederationStateStore.html" title="interface in org.apache.hadoop.yarn.server.federation.store">FederationStateStore</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/impl/MemoryFederationStateStore.html" title="class in org.apache.hadoop.yarn.server.federation.store.impl">MemoryFederationStateStore</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/impl/SQLFederationStateStore.html" title="class in org.apache.hadoop.yarn.server.federation.store.impl">SQLFederationStateStore</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/impl/ZookeeperFederationStateStore.html" title="class in org.apache.hadoop.yarn.server.federation.store.impl">ZookeeperFederationStateStore</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Private
@InterfaceStability.Unstable
public interface <span class="typeNameLabel">FederationPolicyStore</span></pre>
<div class="block">The FederationPolicyStore provides a key-value interface to access the
policies configured for the system. The key is a "queue" name, i.e., the
system allows to configure a different policy for each queue in the system
(though each policy can make dynamic run-time decisions on a per-job/per-task
basis). The value is a <code>SubClusterPolicyConfiguration</code>, a serialized
representation of the policy type and its parameters.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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/GetSubClusterPoliciesConfigurationsResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClusterPoliciesConfigurationsResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/FederationPolicyStore.html#getPoliciesConfigurations-org.apache.hadoop.yarn.server.federation.store.records.GetSubClusterPoliciesConfigurationsRequest-">getPoliciesConfigurations</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterPoliciesConfigurationsRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClusterPoliciesConfigurationsRequest</a>&nbsp;request)</code>
<div class="block">Get a map of all queue-to-policy configurations.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterPolicyConfigurationResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClusterPolicyConfigurationResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/FederationPolicyStore.html#getPolicyConfiguration-org.apache.hadoop.yarn.server.federation.store.records.GetSubClusterPolicyConfigurationRequest-">getPolicyConfiguration</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterPolicyConfigurationRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClusterPolicyConfigurationRequest</a>&nbsp;request)</code>
<div class="block">Get the policy configuration for a given queue.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SetSubClusterPolicyConfigurationResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SetSubClusterPolicyConfigurationResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/FederationPolicyStore.html#setPolicyConfiguration-org.apache.hadoop.yarn.server.federation.store.records.SetSubClusterPolicyConfigurationRequest-">setPolicyConfiguration</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SetSubClusterPolicyConfigurationRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SetSubClusterPolicyConfigurationRequest</a>&nbsp;request)</code>
<div class="block">Set the policy configuration for a given queue.</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="getPolicyConfiguration-org.apache.hadoop.yarn.server.federation.store.records.GetSubClusterPolicyConfigurationRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPolicyConfiguration</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterPolicyConfigurationResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClusterPolicyConfigurationResponse</a>&nbsp;getPolicyConfiguration(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterPolicyConfigurationRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClusterPolicyConfigurationRequest</a>&nbsp;request)
throws org.apache.hadoop.yarn.exceptions.YarnException</pre>
<div class="block">Get the policy configuration for a given queue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the queue whose <code>SubClusterPolicyConfiguration</code> is
required</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>SubClusterPolicyConfiguration</code> for the specified queue,
or <code>null</code> if there is no mapping for the queue</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if the request is invalid/fails</dd>
</dl>
</li>
</ul>
<a name="setPolicyConfiguration-org.apache.hadoop.yarn.server.federation.store.records.SetSubClusterPolicyConfigurationRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPolicyConfiguration</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SetSubClusterPolicyConfigurationResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SetSubClusterPolicyConfigurationResponse</a>&nbsp;setPolicyConfiguration(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SetSubClusterPolicyConfigurationRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SetSubClusterPolicyConfigurationRequest</a>&nbsp;request)
throws org.apache.hadoop.yarn.exceptions.YarnException</pre>
<div class="block">Set the policy configuration for a given queue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the <code>SubClusterPolicyConfiguration</code> with the
corresponding queue</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>response empty on successfully updating the
<code>SubClusterPolicyConfiguration</code> for the specified queue</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if the request is invalid/fails</dd>
</dl>
</li>
</ul>
<a name="getPoliciesConfigurations-org.apache.hadoop.yarn.server.federation.store.records.GetSubClusterPoliciesConfigurationsRequest-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPoliciesConfigurations</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterPoliciesConfigurationsResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClusterPoliciesConfigurationsResponse</a>&nbsp;getPoliciesConfigurations(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterPoliciesConfigurationsRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClusterPoliciesConfigurationsRequest</a>&nbsp;request)
throws org.apache.hadoop.yarn.exceptions.YarnException</pre>
<div class="block">Get a map of all queue-to-policy configurations.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - empty to represent all configured queues in the system</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the policies for all currently active queues in the system</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if the request is invalid/fails</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/FederationPolicyStore.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/store/FederationMembershipStateStore.html" title="interface in org.apache.hadoop.yarn.server.federation.store"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/FederationStateStore.html" title="interface in org.apache.hadoop.yarn.server.federation.store"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/federation/store/FederationPolicyStore.html" target="_top">Frames</a></li>
<li><a href="FederationPolicyStore.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>