blob: 15835ded0c4bb389ddae656d3bf6b76855c8793f [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:11:00 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.hadoop.yarn.server.federation.store.records (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="org.apache.hadoop.yarn.server.federation.store.records (Apache Hadoop YARN Server Common 3.3.1 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/metrics/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/impl/pb/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/federation/store/records/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.hadoop.yarn.server.federation.store.records</h1>
<div class="docSummary">
<div class="block">Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/AddApplicationHomeSubClusterRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">AddApplicationHomeSubClusterRequest</a></td>
<td class="colLast">
<div class="block">
The request sent by the <code>Router</code> to <code>Federation state
store</code> to map the home subcluster of a newly submitted application.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/AddApplicationHomeSubClusterResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">AddApplicationHomeSubClusterResponse</a></td>
<td class="colLast">
<div class="block">AddApplicationHomeSubClusterResponse contains the answer from the
<code>FederationApplicationHomeSubClusterStore</code> to a request to insert a
newly generated applicationId and its owner.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/ApplicationHomeSubCluster.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">ApplicationHomeSubCluster</a></td>
<td class="colLast">
<div class="block">
ApplicationHomeSubCluster is a report of the runtime information of the
application that is running in the federated cluster.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/DeleteApplicationHomeSubClusterRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">DeleteApplicationHomeSubClusterRequest</a></td>
<td class="colLast">
<div class="block">The request to <code>Federation state store</code> to delete the mapping of
home subcluster of a submitted application.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/DeleteApplicationHomeSubClusterResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">DeleteApplicationHomeSubClusterResponse</a></td>
<td class="colLast">
<div class="block">DeleteApplicationHomeSubClusterResponse contains the answer from the <code>FederationApplicationHomeSubClusterStore</code> to a request to delete the mapping
of home subcluster of a submitted application.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetApplicationHomeSubClusterRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetApplicationHomeSubClusterRequest</a></td>
<td class="colLast">
<div class="block">Request class to obtain the home sub-cluster for the specified
<code>ApplicationId</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetApplicationHomeSubClusterResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetApplicationHomeSubClusterResponse</a></td>
<td class="colLast">
<div class="block">
The response sent by <code>Federation state
store</code> to a query for the home subcluster of a newly submitted
application.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetApplicationsHomeSubClusterRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetApplicationsHomeSubClusterRequest</a></td>
<td class="colLast">
<div class="block">Request class to obtain the home sub-cluster mapping of all active
applications.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/GetApplicationsHomeSubClusterResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">GetApplicationsHomeSubClusterResponse</a></td>
<td class="colLast">
<div class="block">
The response sent by <code>Federation state
store</code> to a query for the home subcluster of all submitted
applications.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">Request class to obtain information about a sub-cluster identified by its
<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>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">Response to a query with <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterInfo.html" title="class in org.apache.hadoop.yarn.server.federation.store.records"><code>SubClusterInfo</code></a> about a sub-cluster.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">GetSubClusterPoliciesConfigurationsRequest is a request to the
<code>FederationPolicyStore</code> to obtain all policy configurations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">GetSubClusterPolicyConfigurationResponse contains the answer from the <code>FederationPolicyStore</code> to a request to get all the policies configured in the
system via a <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterPolicyConfiguration.html" title="class in org.apache.hadoop.yarn.server.federation.store.records"><code>SubClusterPolicyConfiguration</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">GetSubClusterPolicyConfigurationRequest is a request to the
<code>FederationPolicyStore</code> to get the configuration of a policy for a
given queue.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">GetSubClusterPolicyConfigurationResponse contains the answer from the <code>FederationPolicyStore</code> to a request to get the information about how a policy
should be configured via a <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterPolicyConfiguration.html" title="class in org.apache.hadoop.yarn.server.federation.store.records"><code>SubClusterPolicyConfiguration</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">Request class to obtain information about all sub-clusters that are
participating in federation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">Response to a query with list of <a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterInfo.html" title="class in org.apache.hadoop.yarn.server.federation.store.records"><code>SubClusterInfo</code></a> about all
sub-clusters that are currently participating in Federation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">SetSubClusterPolicyConfigurationRequest is a request to the
<code>FederationPolicyStore</code> to set the policy configuration corresponding
to a queue.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">SetSubClusterPolicyConfigurationResponse contains the answer from the
<code>FederationPolicyStore</code> to a request to set for a policy configuration
for a given queue.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">
The request sent to set the state of a subcluster to either
SC_DECOMMISSIONED, SC_LOST, or SC_DEREGISTERED.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">SubClusterDeregisterResponse contains the answer from the <code>FederationMembershipStateStore</code> to a request to deregister the sub cluster.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">
SubClusterHeartbeatRequest is a report of the runtime information of the
subcluster that is participating in federation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">SubClusterHeartbeatResponse contains the response from the <code>FederationMembershipStateStore</code> to a periodic heartbeat to indicate
liveliness from a <code>ResourceManager</code> participating in federation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">
SubClusterId represents the <em>globally unique</em> identifier for a
subcluster that is participating in federation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterIdInfo.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterIdInfo</a></td>
<td class="colLast">
<div class="block">This class represent a sub-cluster identifier in the JSON representation
of the policy configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterInfo.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterInfo</a></td>
<td class="colLast">
<div class="block">
SubClusterInfo is a report of the runtime information of the subcluster that
is participating in federation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterPolicyConfiguration.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterPolicyConfiguration</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterPolicyConfiguration.html" title="class in org.apache.hadoop.yarn.server.federation.store.records"><code>SubClusterPolicyConfiguration</code></a> is a class that represents a
configuration of a policy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">
SubClusterRegisterRequest is a request by a sub-cluster
<code>ResourceManager</code> to participate in federation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><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></td>
<td class="colLast">
<div class="block">SubClusterRegisterResponse contains the response from the <code>FederationMembershipStateStore</code> to a registration request from a
<code>ResourceManager</code> to participate in federation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/UpdateApplicationHomeSubClusterRequest.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">UpdateApplicationHomeSubClusterRequest</a></td>
<td class="colLast">
<div class="block">
The request sent by the <code>Router</code> to
<code>Federation state store</code> to update the home subcluster of a newly
submitted application.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/UpdateApplicationHomeSubClusterResponse.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">UpdateApplicationHomeSubClusterResponse</a></td>
<td class="colLast">
<div class="block">UpdateApplicationHomeSubClusterResponse contains the answer from the
<code>FederationApplicationHomeSubClusterStore</code> to a request to register the
home subcluster of a submitted application.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterState.html" title="enum in org.apache.hadoop.yarn.server.federation.store.records">SubClusterState</a></td>
<td class="colLast">
<div class="block">
State of a <code>SubCluster</code>.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.hadoop.yarn.server.federation.store.records Description">Package org.apache.hadoop.yarn.server.federation.store.records Description</h2>
<div class="block">Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with this
work for additional information regarding copyright ownership. The ASF
licenses this file to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at
<p>
http://www.apache.org/licenses/LICENSE-2.0
<p>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/metrics/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/impl/pb/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/federation/store/records/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>