| <!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>PartitionRegionInfo (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="PartitionRegionInfo (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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/cache/partition/PartitionRegionHelper.html" title="class in org.apache.geode.cache.partition"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/partition/PartitionRegionInfo.html" target="_top">Frames</a></li> |
| <li><a href="PartitionRegionInfo.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.cache.partition</div> |
| <h2 title="Interface PartitionRegionInfo" class="title">Interface PartitionRegionInfo</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">PartitionRegionInfo</span></pre> |
| <div class="block">Information describing the data storage and distribution of a partitioned region. The |
| <a href="../../../../../org/apache/geode/cache/partition/PartitionRegionHelper.html" title="class in org.apache.geode.cache.partition"><code>PartitionRegionHelper</code></a> is used to gather <code>PartitionRegionInfo</code>. Each instance |
| describes a single partitioned region identified by <a href="../../../../../org/apache/geode/cache/partition/PartitionRegionInfo.html#getRegionPath--"><code>getRegionPath()</code></a>. |
| <p> |
| This is an immutable snapshot of the information.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/partition/PartitionRegionInfo.html#getActualRedundantCopies--">getActualRedundantCopies</a></span>()</code> |
| <div class="block">Returns the lowest number of redundant copies for any bucket holding data for the partitioned |
| region.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <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/cache/partition/PartitionRegionInfo.html#getColocatedWith--">getColocatedWith</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../../org/apache/geode/cache/Region.html#getFullPath--"><code>full path</code></a> of the partitioned |
| region that this region has been configured to be |
| <a href="../../../../../org/apache/geode/cache/PartitionAttributes.html#getColocatedWith--"><code>colocated with</code></a> or null if |
| it is not colocated.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/partition/PartitionRegionInfo.html#getConfiguredBucketCount--">getConfiguredBucketCount</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../../org/apache/geode/cache/PartitionAttributes.html#getTotalNumBuckets--"><code>configured |
| number of buckets</code></a> for the partitioned region.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/partition/PartitionRegionInfo.html#getConfiguredRedundantCopies--">getConfiguredRedundantCopies</a></span>()</code> |
| <div class="block">Returns the number of <a href="../../../../../org/apache/geode/cache/PartitionAttributes.html#getRedundantCopies--"><code>redundant copies</code></a> the partitioned region was configured for.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/partition/PartitionRegionInfo.html#getCreatedBucketCount--">getCreatedBucketCount</a></span>()</code> |
| <div class="block">Returns the number of actual buckets that have been created to hold data for the partitioned |
| region.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/partition/PartitionRegionInfo.html#getLowRedundancyBucketCount--">getLowRedundancyBucketCount</a></span>()</code> |
| <div class="block">Returns the number of created buckets that have fewer than the |
| <a href="../../../../../org/apache/geode/cache/partition/PartitionRegionInfo.html#getConfiguredRedundantCopies--"><code>configured redundant copies</code></a> for this partitioned |
| region.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/geode/cache/partition/PartitionMemberInfo.html" title="interface in org.apache.geode.cache.partition">PartitionMemberInfo</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/partition/PartitionRegionInfo.html#getPartitionMemberInfo--">getPartitionMemberInfo</a></span>()</code> |
| <div class="block">Returns an immutable set of <code>PartitionMemberInfo</code> representing every member that is |
| configured to provide storage space to the partitioned region.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <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/cache/partition/PartitionRegionInfo.html#getRegionPath--">getRegionPath</a></span>()</code> |
| <div class="block">Returns the <a href="../../../../../org/apache/geode/cache/Region.html#getFullPath--"><code>full path</code></a> of the partitioned |
| region that this object describes.</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="getRegionPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionPath</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> getRegionPath()</pre> |
| <div class="block">Returns the <a href="../../../../../org/apache/geode/cache/Region.html#getFullPath--"><code>full path</code></a> of the partitioned |
| region that this object describes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the full path of the partitioned region that this info describes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPartitionMemberInfo--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartitionMemberInfo</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/geode/cache/partition/PartitionMemberInfo.html" title="interface in org.apache.geode.cache.partition">PartitionMemberInfo</a>> getPartitionMemberInfo()</pre> |
| <div class="block">Returns an immutable set of <code>PartitionMemberInfo</code> representing every member that is |
| configured to provide storage space to the partitioned region.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>set of member info configured for storage space</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConfiguredBucketCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfiguredBucketCount</h4> |
| <pre>int getConfiguredBucketCount()</pre> |
| <div class="block">Returns the <a href="../../../../../org/apache/geode/cache/PartitionAttributes.html#getTotalNumBuckets--"><code>configured |
| number of buckets</code></a> for the partitioned region.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configured number of buckets</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCreatedBucketCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCreatedBucketCount</h4> |
| <pre>int getCreatedBucketCount()</pre> |
| <div class="block">Returns the number of actual buckets that have been created to hold data for the partitioned |
| region. This is less than or equal to {#link #getConfiguredBucketCount()}.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current number of actual buckets that have been created</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLowRedundancyBucketCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLowRedundancyBucketCount</h4> |
| <pre>int getLowRedundancyBucketCount()</pre> |
| <div class="block">Returns the number of created buckets that have fewer than the |
| <a href="../../../../../org/apache/geode/cache/partition/PartitionRegionInfo.html#getConfiguredRedundantCopies--"><code>configured redundant copies</code></a> for this partitioned |
| region.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of created buckets that have fewer than the configured redundant copies</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/partition/PartitionRegionInfo.html#getActualRedundantCopies--"><code>getActualRedundantCopies()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConfiguredRedundantCopies--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfiguredRedundantCopies</h4> |
| <pre>int getConfiguredRedundantCopies()</pre> |
| <div class="block">Returns the number of <a href="../../../../../org/apache/geode/cache/PartitionAttributes.html#getRedundantCopies--"><code>redundant copies</code></a> the partitioned region was configured for.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of redundant copies the partitioned region was configured for</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getActualRedundantCopies--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getActualRedundantCopies</h4> |
| <pre>int getActualRedundantCopies()</pre> |
| <div class="block">Returns the lowest number of redundant copies for any bucket holding data for the partitioned |
| region. If all data is currently at full redundancy then this will return the same value as |
| <a href="../../../../../org/apache/geode/cache/partition/PartitionRegionInfo.html#getConfiguredRedundantCopies--"><code>getConfiguredRedundantCopies()</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the lowest number of redundant copies for any bucket of the partitioned region.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getColocatedWith--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getColocatedWith</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> getColocatedWith()</pre> |
| <div class="block">Returns the <a href="../../../../../org/apache/geode/cache/Region.html#getFullPath--"><code>full path</code></a> of the partitioned |
| region that this region has been configured to be |
| <a href="../../../../../org/apache/geode/cache/PartitionAttributes.html#getColocatedWith--"><code>colocated with</code></a> or null if |
| it is not colocated.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the full path of the partitioned region that the region is colocated with or null if |
| there is none.</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/cache/partition/PartitionRegionHelper.html" title="class in org.apache.geode.cache.partition"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/partition/PartitionRegionInfo.html" target="_top">Frames</a></li> |
| <li><a href="PartitionRegionInfo.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
