blob: 9e5ca9eba3bfb9747008643b7da78317ec881fa4 [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 -->
<title>RegionRedundancyStatus (Apache Geode 1.15.1)</title>
<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="RegionRedundancyStatus (Apache Geode 1.15.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":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="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/geode/management/runtime/RebalanceResult.html" title="interface in org.apache.geode.management.runtime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/geode/management/runtime/RegionRedundancyStatus.RedundancyStatus.html" title="enum in org.apache.geode.management.runtime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/geode/management/runtime/RegionRedundancyStatus.html" target="_top">Frames</a></li>
<li><a href="RegionRedundancyStatus.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><a href="#nested.class.summary">Nested</a>&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.geode.management.runtime</div>
<h2 title="Interface RegionRedundancyStatus" class="title">Interface RegionRedundancyStatus</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/geode/management/api/JsonSerializable.html" title="interface in org.apache.geode.management.api">JsonSerializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../org/apache/geode/annotations/Experimental.html" title="annotation in org.apache.geode.annotations">@Experimental</a>
public interface <span class="typeNameLabel">RegionRedundancyStatus</span>
extends <a href="../../../../../org/apache/geode/management/api/JsonSerializable.html" title="interface in org.apache.geode.management.api">JsonSerializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">Used to calculate and store a snapshot of the redundancy status for a partitioned region.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RegionRedundancyStatus.RedundancyStatus.html" title="enum in org.apache.geode.management.runtime">RegionRedundancyStatus.RedundancyStatus</a></span></code>
<div class="block">The redundancy status of the region used to create this object at time of creation.</div>
</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">&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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RegionRedundancyStatus.html#getActualRedundancy--">getActualRedundancy</a></span>()</code>
<div class="block">Returns the number of redundant copies for all buckets in the region used to create this
RegionRedundancyStatus, at the time of creation.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RegionRedundancyStatus.html#getConfiguredRedundancy--">getConfiguredRedundancy</a></span>()</code>
<div class="block">Returns the configured redundancy level for the region used to create this
RegionRedundancyStatus.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RegionRedundancyStatus.html#getRegionName--">getRegionName</a></span>()</code>
<div class="block">Returns the name of the region used to create this RegionRedundancyStatus.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/geode/management/runtime/RegionRedundancyStatus.RedundancyStatus.html" title="enum in org.apache.geode.management.runtime">RegionRedundancyStatus.RedundancyStatus</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RegionRedundancyStatus.html#getStatus--">getStatus</a></span>()</code>
<div class="block">Returns the <a href="../../../../../org/apache/geode/management/runtime/RegionRedundancyStatus.RedundancyStatus.html" title="enum in org.apache.geode.management.runtime"><code>RegionRedundancyStatus.RedundancyStatus</code></a> for the region used to create this RegionRedundancyStatus
at the time of creation.</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="getRegionName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRegionName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getRegionName()</pre>
<div class="block">Returns the name of the region used to create this RegionRedundancyStatus.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of the region used to create this RegionRedundancyStatus.</dd>
</dl>
</li>
</ul>
<a name="getConfiguredRedundancy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguredRedundancy</h4>
<pre>int&nbsp;getConfiguredRedundancy()</pre>
<div class="block">Returns the configured redundancy level for the region used to create this
RegionRedundancyStatus.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The configured redundancy level for the region used to create this
RegionRedundancyStatus.</dd>
</dl>
</li>
</ul>
<a name="getActualRedundancy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActualRedundancy</h4>
<pre>int&nbsp;getActualRedundancy()</pre>
<div class="block">Returns the number of redundant copies for all buckets in the region used to create this
RegionRedundancyStatus, at the time of creation. If some buckets have fewer redundant copies
than others, the lower number is returned.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of redundant copies for all buckets in the region used to create this
RegionRedundancyStatus, at the time of creation.</dd>
</dl>
</li>
</ul>
<a name="getStatus--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStatus</h4>
<pre><a href="../../../../../org/apache/geode/management/runtime/RegionRedundancyStatus.RedundancyStatus.html" title="enum in org.apache.geode.management.runtime">RegionRedundancyStatus.RedundancyStatus</a>&nbsp;getStatus()</pre>
<div class="block">Returns the <a href="../../../../../org/apache/geode/management/runtime/RegionRedundancyStatus.RedundancyStatus.html" title="enum in org.apache.geode.management.runtime"><code>RegionRedundancyStatus.RedundancyStatus</code></a> for the region used to create this RegionRedundancyStatus
at the time of creation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="../../../../../org/apache/geode/management/runtime/RegionRedundancyStatus.RedundancyStatus.html" title="enum in org.apache.geode.management.runtime"><code>RegionRedundancyStatus.RedundancyStatus</code></a> for the region used to create this RegionRedundancyStatus.</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="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/geode/management/runtime/RebalanceResult.html" title="interface in org.apache.geode.management.runtime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/geode/management/runtime/RegionRedundancyStatus.RedundancyStatus.html" title="enum in org.apache.geode.management.runtime"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/geode/management/runtime/RegionRedundancyStatus.html" target="_top">Frames</a></li>
<li><a href="RegionRedundancyStatus.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><a href="#nested.class.summary">Nested</a>&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 ======= -->
</body>
</html>