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 / FederationMembershipStateStore.html
blob: 8d713216c952e8a104d6af1f2ea3bc0e891a37b5 [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>FederationMembershipStateStore (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="FederationMembershipStateStore (Apache Hadoop YARN Server Common 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/FederationMembershipStateStore.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/FederationApplicationHomeSubClusterStore.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/FederationPolicyStore.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/FederationMembershipStateStore.html" target="_top">Frames</a></li>
<li><a href="FederationMembershipStateStore.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 FederationMembershipStateStore" class="title">Interface FederationMembershipStateStore</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">FederationMembershipStateStore</span></pre>
<div class="block">FederationMembershipStateStore maintains the state of all
<em>subcluster(s)</em> as encapsulated by <code>SubClusterInfo</code> for all the
subcluster(s) that are participating in federation.</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/SubClusterDeregisterResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterDeregisterResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/FederationMembershipStateStore.html#deregisterSubCluster-org.apache.hadoop.yarn.server.federation.store.records.SubClusterDeregisterRequest-">deregisterSubCluster</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterDeregisterRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterDeregisterRequest</a>&nbsp;subClusterDeregisterRequest)</code>
<div class="block">Deregister a <em>subcluster</em> identified by <code>SubClusterId</code> to
change state in federation.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterInfoResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClusterInfoResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/FederationMembershipStateStore.html#getSubCluster-org.apache.hadoop.yarn.server.federation.store.records.GetSubClusterInfoRequest-">getSubCluster</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterInfoRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClusterInfoRequest</a>&nbsp;subClusterRequest)</code>
<div class="block">Get the membership information of <em>subcluster</em> as identified by
<code>SubClusterId</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClustersInfoResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClustersInfoResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/FederationMembershipStateStore.html#getSubClusters-org.apache.hadoop.yarn.server.federation.store.records.GetSubClustersInfoRequest-">getSubClusters</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClustersInfoRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClustersInfoRequest</a>&nbsp;subClustersRequest)</code>
<div class="block">Get the membership information of all the <em>subclusters</em> that are
currently participating in federation.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterRegisterResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterRegisterResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/FederationMembershipStateStore.html#registerSubCluster-org.apache.hadoop.yarn.server.federation.store.records.SubClusterRegisterRequest-">registerSubCluster</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterRegisterRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterRegisterRequest</a>&nbsp;registerSubClusterRequest)</code>
<div class="block">Register a <em>subcluster</em> by publishing capabilities as represented by
<code>SubClusterInfo</code> to indicate participation in federation.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterHeartbeatResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterHeartbeatResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/FederationMembershipStateStore.html#subClusterHeartbeat-org.apache.hadoop.yarn.server.federation.store.records.SubClusterHeartbeatRequest-">subClusterHeartbeat</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterHeartbeatRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterHeartbeatRequest</a>&nbsp;subClusterHeartbeatRequest)</code>
<div class="block">Periodic heartbeat from a <code>ResourceManager</code> participating in
federation to indicate liveliness.</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="registerSubCluster-org.apache.hadoop.yarn.server.federation.store.records.SubClusterRegisterRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerSubCluster</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterRegisterResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterRegisterResponse</a>&nbsp;registerSubCluster(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterRegisterRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterRegisterRequest</a>&nbsp;registerSubClusterRequest)
throws org.apache.hadoop.yarn.exceptions.YarnException</pre>
<div class="block">Register a <em>subcluster</em> by publishing capabilities as represented by
<code>SubClusterInfo</code> to indicate participation in federation. This is
typically done during initialization or restart/failover of the
subcluster's <code>ResourceManager</code>. Upon successful registration, an
identifier for the <em>subcluster</em> which is unique across the federated
cluster is returned. The identifier is static, i.e. preserved across
restarts and failover.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>registerSubClusterRequest</code> - the capabilities of the subcluster that
wants to participate in federation. The subcluster id is also
specified in case registration is triggered by restart/failover</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>response empty on successfully if registration was successful</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="deregisterSubCluster-org.apache.hadoop.yarn.server.federation.store.records.SubClusterDeregisterRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deregisterSubCluster</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterDeregisterResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterDeregisterResponse</a>&nbsp;deregisterSubCluster(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterDeregisterRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterDeregisterRequest</a>&nbsp;subClusterDeregisterRequest)
throws org.apache.hadoop.yarn.exceptions.YarnException</pre>
<div class="block">Deregister a <em>subcluster</em> identified by <code>SubClusterId</code> to
change state in federation. This can be done to mark the sub cluster lost,
deregistered, or decommissioned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>subClusterDeregisterRequest</code> - - the request to deregister the
sub-cluster from federation.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>response empty on successfully deregistering the subcluster state</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="subClusterHeartbeat-org.apache.hadoop.yarn.server.federation.store.records.SubClusterHeartbeatRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subClusterHeartbeat</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterHeartbeatResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterHeartbeatResponse</a>&nbsp;subClusterHeartbeat(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterHeartbeatRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterHeartbeatRequest</a>&nbsp;subClusterHeartbeatRequest)
throws org.apache.hadoop.yarn.exceptions.YarnException</pre>
<div class="block">Periodic heartbeat from a <code>ResourceManager</code> participating in
federation to indicate liveliness. The heartbeat publishes the current
capabilities as represented by <code>SubClusterInfo</code> of the subcluster.
Currently response is empty if the operation was successful, if not an
exception reporting reason for a failure.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>subClusterHeartbeatRequest</code> - the capabilities of the subcluster that
wants to keep alive its participation in federation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>response currently empty on if heartbeat was successfully processed</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="getSubCluster-org.apache.hadoop.yarn.server.federation.store.records.GetSubClusterInfoRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubCluster</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterInfoResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClusterInfoResponse</a>&nbsp;getSubCluster(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterInfoRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClusterInfoRequest</a>&nbsp;subClusterRequest)
throws org.apache.hadoop.yarn.exceptions.YarnException</pre>
<div class="block">Get the membership information of <em>subcluster</em> as identified by
<code>SubClusterId</code>. The membership information includes the cluster
endpoint and current capabilities as represented by <code>SubClusterInfo</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>subClusterRequest</code> - the subcluster whose information is required</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>SubClusterInfo</code>, or <code>null</code> if there is no mapping
for the subcluster</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="getSubClusters-org.apache.hadoop.yarn.server.federation.store.records.GetSubClustersInfoRequest-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSubClusters</h4>
<pre><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClustersInfoResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClustersInfoResponse</a>&nbsp;getSubClusters(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetSubClustersInfoRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetSubClustersInfoRequest</a>&nbsp;subClustersRequest)
throws org.apache.hadoop.yarn.exceptions.YarnException</pre>
<div class="block">Get the membership information of all the <em>subclusters</em> that are
currently participating in federation. The membership information includes
the cluster endpoint and current capabilities as represented by
<code>SubClusterInfo</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>subClustersRequest</code> - request for sub-clusters information</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map of <code>SubClusterInfo</code> keyed by the <code>SubClusterId</code></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/FederationMembershipStateStore.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/FederationApplicationHomeSubClusterStore.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/FederationPolicyStore.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/FederationMembershipStateStore.html" target="_top">Frames</a></li>
<li><a href="FederationMembershipStateStore.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>