| <!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>RestoreRedundancyOperation (Apache Geode 1.15.0)</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="RestoreRedundancyOperation (Apache Geode 1.15.0)"; |
| } |
| } |
| 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="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/control/ResourceManager.html" title="interface in org.apache.geode.cache.control"><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/control/RestoreRedundancyOperation.html" target="_top">Frames</a></li> |
| <li><a href="RestoreRedundancyOperation.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.control</div> |
| <h2 title="Interface RestoreRedundancyOperation" class="title">Interface RestoreRedundancyOperation</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RestoreRedundancyOperation</span></pre> |
| <div class="block">Class for defining and starting a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that returns |
| <a href="../../../../../org/apache/geode/management/runtime/RestoreRedundancyResults.html" title="interface in org.apache.geode.management.runtime"><code>RestoreRedundancyResults</code></a>.</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"> </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><a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html" title="interface in org.apache.geode.cache.control">RestoreRedundancyOperation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html#excludeRegions-java.util.Set-">excludeRegions</a></span>(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> regions)</code> |
| <div class="block">Exclude specific regions from the restore redundancy operation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html" title="interface in org.apache.geode.cache.control">RestoreRedundancyOperation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html#includeRegions-java.util.Set-">includeRegions</a></span>(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> regions)</code> |
| <div class="block">Specify which regions to include in the restore redundancy operation.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/management/runtime/RestoreRedundancyResults.html" title="interface in org.apache.geode.management.runtime">RestoreRedundancyResults</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html#redundancyStatus--">redundancyStatus</a></span>()</code> |
| <div class="block">Determines the current redundancy status for the partitioned regions associated with this |
| operation.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html" title="interface in org.apache.geode.cache.control">RestoreRedundancyOperation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html#shouldReassignPrimaries-boolean-">shouldReassignPrimaries</a></span>(boolean shouldReassign)</code> |
| <div class="block">Set whether the restore redundancy operation should reassign primary buckets.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/geode/management/runtime/RestoreRedundancyResults.html" title="interface in org.apache.geode.management.runtime">RestoreRedundancyResults</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html#start--">start</a></span>()</code> |
| <div class="block">Asynchronously starts a new restore redundancy operation.</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="includeRegions-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>includeRegions</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html" title="interface in org.apache.geode.cache.control">RestoreRedundancyOperation</a> includeRegions(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> regions)</pre> |
| <div class="block">Specify which regions to include in the restore redundancy operation. The default, |
| <code>null</code>, means all regions should be included. Includes take precedence over |
| excludes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regions</code> - A set containing the names of regions to include.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html" title="interface in org.apache.geode.cache.control"><code>RestoreRedundancyOperation</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="excludeRegions-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>excludeRegions</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html" title="interface in org.apache.geode.cache.control">RestoreRedundancyOperation</a> excludeRegions(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> regions)</pre> |
| <div class="block">Exclude specific regions from the restore redundancy operation. The default, |
| <code>null</code>, means don't exclude any regions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regions</code> - A set containing the names of regions to exclude.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html" title="interface in org.apache.geode.cache.control"><code>RestoreRedundancyOperation</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shouldReassignPrimaries-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldReassignPrimaries</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html" title="interface in org.apache.geode.cache.control">RestoreRedundancyOperation</a> shouldReassignPrimaries(boolean shouldReassign)</pre> |
| <div class="block">Set whether the restore redundancy operation should reassign primary buckets. The default, |
| <code>true</code>, will result in primary buckets being reassigned for better load balancing |
| across members.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shouldReassign</code> - A boolean indicating whether or not the operation created by this |
| class should reassign primary bucket hosts.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../../../../../org/apache/geode/cache/control/RestoreRedundancyOperation.html" title="interface in org.apache.geode.cache.control"><code>RestoreRedundancyOperation</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/geode/management/runtime/RestoreRedundancyResults.html" title="interface in org.apache.geode.management.runtime">RestoreRedundancyResults</a>> start()</pre> |
| <div class="block">Asynchronously starts a new restore redundancy operation. Only the cache resources used by this |
| member will have redundancy restored. The operation may queue as needed for resources in |
| contention by other active restore redundancy operations.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> which will return the results of the restore redundancy |
| operation started by this method.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="redundancyStatus--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>redundancyStatus</h4> |
| <pre><a href="../../../../../org/apache/geode/management/runtime/RestoreRedundancyResults.html" title="interface in org.apache.geode.management.runtime">RestoreRedundancyResults</a> redundancyStatus()</pre> |
| <div class="block">Determines the current redundancy status for the partitioned regions associated with this |
| operation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="../../../../../org/apache/geode/management/runtime/RestoreRedundancyResults.html" title="interface in org.apache.geode.management.runtime"><code>RestoreRedundancyResults</code></a> containing the redundancy information for each |
| included region.</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/control/ResourceManager.html" title="interface in org.apache.geode.cache.control"><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/control/RestoreRedundancyOperation.html" target="_top">Frames</a></li> |
| <li><a href="RestoreRedundancyOperation.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> |
