blob: eb09655da0f39de6cd7db4669f85c5d06a24f34b [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>RebalanceRegionResult (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="RebalanceRegionResult (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,"i8":6,"i9":6,"i10":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/PdxInfo.html" title="class in org.apache.geode.management.runtime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/geode/management/runtime/RebalanceResult.html" title="interface 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/RebalanceRegionResult.html" target="_top">Frames</a></li>
<li><a href="RebalanceRegionResult.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.geode.management.runtime</div>
<h2 title="Interface RebalanceRegionResult" class="title">Interface RebalanceRegionResult</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">RebalanceRegionResult</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">Details of the rebalancing work performed for a partitioned region.</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>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RebalanceRegionResult.html#getBucketCreateBytes--">getBucketCreateBytes</a></span>()</code>
<div class="block">Returns the size, in bytes, of all of the buckets that were created as part of the rebalance
operation for this region</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/RebalanceRegionResult.html#getBucketCreatesCompleted--">getBucketCreatesCompleted</a></span>()</code>
<div class="block">Returns the number of buckets created during the rebalance operation</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RebalanceRegionResult.html#getBucketCreateTimeInMilliseconds--">getBucketCreateTimeInMilliseconds</a></span>()</code>
<div class="block">Returns the time, in milliseconds, taken to create buckets for this region</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RebalanceRegionResult.html#getBucketTransferBytes--">getBucketTransferBytes</a></span>()</code>
<div class="block">Returns the size, in bytes, of buckets that were transferred for this region.</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/management/runtime/RebalanceRegionResult.html#getBucketTransfersCompleted--">getBucketTransfersCompleted</a></span>()</code>
<div class="block">Returns the number of buckets transferred for this region.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RebalanceRegionResult.html#getBucketTransferTimeInMilliseconds--">getBucketTransferTimeInMilliseconds</a></span>()</code>
<div class="block">Returns the amount of time, in milliseconds, it took to transfer buckets for this region.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RebalanceRegionResult.html#getNumOfMembers--">getNumOfMembers</a></span>()</code>
<div class="block">Returns the number of members on which rebalance operation is executed.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RebalanceRegionResult.html#getPrimaryTransfersCompleted--">getPrimaryTransfersCompleted</a></span>()</code>
<div class="block">Returns the number of primaries that were transferred for this region.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RebalanceRegionResult.html#getPrimaryTransferTimeInMilliseconds--">getPrimaryTransferTimeInMilliseconds</a></span>()</code>
<div class="block">Returns the time, in milliseconds, spent transferring primaries for this region.</div>
</td>
</tr>
<tr id="i9" 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/management/runtime/RebalanceRegionResult.html#getRegionName--">getRegionName</a></span>()</code>
<div class="block">Returns the name of this region</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/runtime/RebalanceRegionResult.html#getTimeInMilliseconds--">getTimeInMilliseconds</a></span>()</code>
<div class="block">Returns the time, in milliseconds, that the rebalance operation took for this region.</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 this region</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the region</dd>
</dl>
</li>
</ul>
<a name="getBucketCreateBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBucketCreateBytes</h4>
<pre>long&nbsp;getBucketCreateBytes()</pre>
<div class="block">Returns the size, in bytes, of all of the buckets that were created as part of the rebalance
operation for this region</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the size, in bytes, of all the buckets that were created</dd>
</dl>
</li>
</ul>
<a name="getBucketCreateTimeInMilliseconds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBucketCreateTimeInMilliseconds</h4>
<pre>long&nbsp;getBucketCreateTimeInMilliseconds()</pre>
<div class="block">Returns the time, in milliseconds, taken to create buckets for this region</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the time, in milliseconds, taken to create buckets</dd>
</dl>
</li>
</ul>
<a name="getBucketCreatesCompleted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBucketCreatesCompleted</h4>
<pre>int&nbsp;getBucketCreatesCompleted()</pre>
<div class="block">Returns the number of buckets created during the rebalance operation</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of buckets created during the rebalance operation</dd>
</dl>
</li>
</ul>
<a name="getBucketTransferBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBucketTransferBytes</h4>
<pre>long&nbsp;getBucketTransferBytes()</pre>
<div class="block">Returns the size, in bytes, of buckets that were transferred for this region.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the size, in bytes, of buckets that were transferred</dd>
</dl>
</li>
</ul>
<a name="getBucketTransferTimeInMilliseconds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBucketTransferTimeInMilliseconds</h4>
<pre>long&nbsp;getBucketTransferTimeInMilliseconds()</pre>
<div class="block">Returns the amount of time, in milliseconds, it took to transfer buckets for this region.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the amount of time, in milliseconds, it took to transfer buckets</dd>
</dl>
</li>
</ul>
<a name="getBucketTransfersCompleted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBucketTransfersCompleted</h4>
<pre>int&nbsp;getBucketTransfersCompleted()</pre>
<div class="block">Returns the number of buckets transferred for this region.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of buckets transferred</dd>
</dl>
</li>
</ul>
<a name="getPrimaryTransferTimeInMilliseconds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrimaryTransferTimeInMilliseconds</h4>
<pre>long&nbsp;getPrimaryTransferTimeInMilliseconds()</pre>
<div class="block">Returns the time, in milliseconds, spent transferring primaries for this region.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the time, in milliseconds, spent transferring primaries</dd>
</dl>
</li>
</ul>
<a name="getPrimaryTransfersCompleted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrimaryTransfersCompleted</h4>
<pre>int&nbsp;getPrimaryTransfersCompleted()</pre>
<div class="block">Returns the number of primaries that were transferred for this region.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of primaries that were transferred</dd>
</dl>
</li>
</ul>
<a name="getTimeInMilliseconds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeInMilliseconds</h4>
<pre>long&nbsp;getTimeInMilliseconds()</pre>
<div class="block">Returns the time, in milliseconds, that the rebalance operation took for this region.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the time, in milliseconds, that the rebalance operation took</dd>
</dl>
</li>
</ul>
<a name="getNumOfMembers--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getNumOfMembers</h4>
<pre>int&nbsp;getNumOfMembers()</pre>
<div class="block">Returns the number of members on which rebalance operation is executed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of members on which rebalance operation was executed</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/PdxInfo.html" title="class in org.apache.geode.management.runtime"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/geode/management/runtime/RebalanceResult.html" title="interface 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/RebalanceRegionResult.html" target="_top">Frames</a></li>
<li><a href="RebalanceRegionResult.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 ======= -->
</body>
</html>