Google Git
Sign in
apache / geode-site / e34feab93a412b3a69cbf8fa62066688ee68dae4 / . / releases / latest / javadoc / org / apache / geode / management / DiskStoreMXBean.html
blob: adff284cc19a19d36fc0f9020b61f7872a0583ff [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>DiskStoreMXBean (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="DiskStoreMXBean (Apache Geode 1.15.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":18,"i6":6,"i7":6,"i8":6,"i9":18,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/DiskMetrics.html" title="class in org.apache.geode.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/management/DistributedLockServiceMXBean.html" title="interface in org.apache.geode.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/management/DiskStoreMXBean.html" target="_top">Frames</a></li>
<li><a href="DiskStoreMXBean.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</div>
<h2 title="Interface DiskStoreMXBean" class="title">Interface DiskStoreMXBean</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">DiskStoreMXBean</span></pre>
<div class="block">MBean that provides access to information and management functionality for a <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 7.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">&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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#flush--">flush</a></span>()</code>
<div class="block">Causes any data that is currently in the asynchronous queue to be written to disk.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#forceCompaction--">forceCompaction</a></span>()</code>
<div class="block">Requests the DiskStore to start compacting.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#forceRoll--">forceRoll</a></span>()</code>
<div class="block">Requests the DiskStore to start writing to a new op-log.</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/management/DiskStoreMXBean.html#getCompactionThreshold--">getCompactionThreshold</a></span>()</code>
<div class="block">Returns the threshold at which an op-log may be compacted.</div>
</td>
</tr>
<tr id="i4" 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/DiskStoreMXBean.html#getDiskDirectories--">getDiskDirectories</a></span>()</code>
<div class="block">Returns the path of the directories to which the region's data will be written.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>default float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getDiskFreePercentage--">getDiskFreePercentage</a></span>()</code>
<div class="block">Returns the free percentage of this disk storage if directories where created with max size.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getDiskReadsAvgLatency--">getDiskReadsAvgLatency</a></span>()</code>
<div class="block">Returns the disk reads average latency in nanoseconds.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getDiskReadsRate--">getDiskReadsRate</a></span>()</code>
<div class="block">Returns the average latency of disk reads in nanoseconds Its the average latency required to
read a byte from disk.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getDiskUsageCriticalPercentage--">getDiskUsageCriticalPercentage</a></span>()</code>
<div class="block">Returns the critical threshold for disk usage as a percentage of the total disk volume.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>default float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getDiskUsagePercentage--">getDiskUsagePercentage</a></span>()</code>
<div class="block">Returns the usage percentage of this disk storage if directories where created with max size.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getDiskUsageWarningPercentage--">getDiskUsageWarningPercentage</a></span>()</code>
<div class="block">Returns the warning threshold for disk usage as a percentage of the total disk volume.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getDiskWritesAvgLatency--">getDiskWritesAvgLatency</a></span>()</code>
<div class="block">Returns the disk writes average latency in nanoseconds.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getDiskWritesRate--">getDiskWritesRate</a></span>()</code>
<div class="block">Returns the average latency of disk writes in nanoseconds.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getFlushTimeAvgLatency--">getFlushTimeAvgLatency</a></span>()</code>
<div class="block">Returns the flush time average latency.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getMaxOpLogSize--">getMaxOpLogSize</a></span>()</code>
<div class="block">Returns the maximum size (in megabytes) that a single op-log can grow to.</div>
</td>
</tr>
<tr id="i15" 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/DiskStoreMXBean.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name of the DiskStore.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getQueueSize--">getQueueSize</a></span>()</code>
<div class="block">Returns the maximum number of operations that can be asynchronously queued for saving to disk.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getTimeInterval--">getTimeInterval</a></span>()</code>
<div class="block">Returns the time (in milliseconds) that can elapse before unwritten data is saved to disk.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getTotalBackupCompleted--">getTotalBackupCompleted</a></span>()</code>
<div class="block">Returns the number of backups of this DiskStore that have been completed.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getTotalBackupInProgress--">getTotalBackupInProgress</a></span>()</code>
<div class="block">Returns the number of backups currently in progress on this DiskStore.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getTotalBytesOnDisk--">getTotalBytesOnDisk</a></span>()</code>
<div class="block">Returns the total number of bytes of space this DiskStore has used.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getTotalQueueSize--">getTotalQueueSize</a></span>()</code>
<div class="block">Returns the number of entries in the asynchronous queue waiting to be written to disk.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getTotalRecoveriesInProgress--">getTotalRecoveriesInProgress</a></span>()</code>
<div class="block">Returns the number of persistent regions currently being recovered from disk.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#getWriteBufferSize--">getWriteBufferSize</a></span>()</code>
<div class="block">Returns the size of the write buffer that this DiskStore will use when writing data to disk.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#isAutoCompact--">isAutoCompact</a></span>()</code>
<div class="block">Returns whether disk files are to be automatically compacted.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#isForceCompactionAllowed--">isForceCompactionAllowed</a></span>()</code>
<div class="block">Returns whether manual compaction of disk files is allowed.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#setDiskUsageCriticalPercentage-float-">setDiskUsageCriticalPercentage</a></span>(float&nbsp;criticalPercent)</code>
<div class="block">Sets the value of the disk usage critical percentage.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DiskStoreMXBean.html#setDiskUsageWarningPercentage-float-">setDiskUsageWarningPercentage</a></span>(float&nbsp;warningPercent)</code>
<div class="block">Sets the value of the disk usage warning percentage.</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="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</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;getName()</pre>
<div class="block">Returns the name of the DiskStore.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the DiskStore</dd>
</dl>
</li>
</ul>
<a name="isAutoCompact--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAutoCompact</h4>
<pre>boolean&nbsp;isAutoCompact()</pre>
<div class="block">Returns whether disk files are to be automatically compacted.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if disk files are automatically compacted, false otherwise</dd>
</dl>
</li>
</ul>
<a name="getCompactionThreshold--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompactionThreshold</h4>
<pre>int&nbsp;getCompactionThreshold()</pre>
<div class="block">Returns the threshold at which an op-log may be compacted. Until it reaches this threshold the
op-log will not be compacted. The threshold is a percentage in the range 0..100.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the threshold at which an op-log may be compacted</dd>
</dl>
</li>
</ul>
<a name="isForceCompactionAllowed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isForceCompactionAllowed</h4>
<pre>boolean&nbsp;isForceCompactionAllowed()</pre>
<div class="block">Returns whether manual compaction of disk files is allowed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if manual compaction is allowed, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="getMaxOpLogSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxOpLogSize</h4>
<pre>long&nbsp;getMaxOpLogSize()</pre>
<div class="block">Returns the maximum size (in megabytes) that a single op-log can grow to.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum size (in megabytes) that a single op-log can grow to</dd>
</dl>
</li>
</ul>
<a name="getTimeInterval--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeInterval</h4>
<pre>long&nbsp;getTimeInterval()</pre>
<div class="block">Returns the time (in milliseconds) that can elapse before unwritten data is saved to disk.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the time (in milliseconds) that can elapse before unwritten data is saved to disk</dd>
</dl>
</li>
</ul>
<a name="getWriteBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteBufferSize</h4>
<pre>int&nbsp;getWriteBufferSize()</pre>
<div class="block">Returns the size of the write buffer that this DiskStore will use when writing data to disk.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the size of the write buffer that this DiskStore will use when writing data to disk</dd>
</dl>
</li>
</ul>
<a name="getDiskDirectories--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskDirectories</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;getDiskDirectories()</pre>
<div class="block">Returns the path of the directories to which the region's data will be written.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the path of the directories to which the region's data will be written</dd>
</dl>
</li>
</ul>
<a name="getQueueSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueSize</h4>
<pre>int&nbsp;getQueueSize()</pre>
<div class="block">Returns the maximum number of operations that can be asynchronously queued for saving to disk.
When this limit is reached operations will block until they can be put in the queue.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of operations that can be asynchronously queued for saving to disk</dd>
</dl>
</li>
</ul>
<a name="getTotalBytesOnDisk--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalBytesOnDisk</h4>
<pre>long&nbsp;getTotalBytesOnDisk()</pre>
<div class="block">Returns the total number of bytes of space this DiskStore has used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of bytes of space this DiskStore has used</dd>
</dl>
</li>
</ul>
<a name="getDiskReadsRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskReadsRate</h4>
<pre>float&nbsp;getDiskReadsRate()</pre>
<div class="block">Returns the average latency of disk reads in nanoseconds Its the average latency required to
read a byte from disk.
Each entry in region has some overhead in terms of number of extra bytes while persisting data.
So this rate won't match the number of bytes put in all regions.This is rate of actual bytes
system is persisting.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average latency of disk reads in nanoseconds</dd>
</dl>
</li>
</ul>
<a name="getDiskWritesRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskWritesRate</h4>
<pre>float&nbsp;getDiskWritesRate()</pre>
<div class="block">Returns the average latency of disk writes in nanoseconds. Its the average latency required to
write a byte to disk.
Each entry in region has some overhead in terms of number of extra bytes while persisting data.
So this rate won't match the number of bytes put in all regions. This is rate of actual bytes
system is persisting.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average latency of disk writes in nanoseconds</dd>
</dl>
</li>
</ul>
<a name="getDiskReadsAvgLatency--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskReadsAvgLatency</h4>
<pre>long&nbsp;getDiskReadsAvgLatency()</pre>
<div class="block">Returns the disk reads average latency in nanoseconds. It depicts average time needed to read
one byte of data from disk.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the disk reads average latency in nanoseconds</dd>
</dl>
</li>
</ul>
<a name="getDiskWritesAvgLatency--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskWritesAvgLatency</h4>
<pre>long&nbsp;getDiskWritesAvgLatency()</pre>
<div class="block">Returns the disk writes average latency in nanoseconds. It depicts average time needed to write
one byte of data to disk.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the disk writes average latency in nanoseconds</dd>
</dl>
</li>
</ul>
<a name="getFlushTimeAvgLatency--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlushTimeAvgLatency</h4>
<pre>long&nbsp;getFlushTimeAvgLatency()</pre>
<div class="block">Returns the flush time average latency.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the flush time average latency</dd>
</dl>
</li>
</ul>
<a name="getTotalQueueSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalQueueSize</h4>
<pre>int&nbsp;getTotalQueueSize()</pre>
<div class="block">Returns the number of entries in the asynchronous queue waiting to be written to disk.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of entries in the asynchronous queue waiting to be written to disk</dd>
</dl>
</li>
</ul>
<a name="getTotalBackupInProgress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalBackupInProgress</h4>
<pre>int&nbsp;getTotalBackupInProgress()</pre>
<div class="block">Returns the number of backups currently in progress on this DiskStore.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of backups currently in progress on this DiskStore</dd>
</dl>
</li>
</ul>
<a name="getTotalBackupCompleted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalBackupCompleted</h4>
<pre>int&nbsp;getTotalBackupCompleted()</pre>
<div class="block">Returns the number of backups of this DiskStore that have been completed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of backups of this DiskStore that have been completed</dd>
</dl>
</li>
</ul>
<a name="getTotalRecoveriesInProgress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalRecoveriesInProgress</h4>
<pre>int&nbsp;getTotalRecoveriesInProgress()</pre>
<div class="block">Returns the number of persistent regions currently being recovered from disk.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of persistent regions currently being recovered from disk</dd>
</dl>
</li>
</ul>
<a name="forceRoll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceRoll</h4>
<pre>void&nbsp;forceRoll()</pre>
<div class="block">Requests the DiskStore to start writing to a new op-log. The old oplog will be asynchronously
compressed if compaction is set to true. The new op-log will be created in the next available
directory with free space. If there is no directory with free space available and compaction is
set to false, then a DiskAccessException saying that the disk is full will be thrown. If
compaction is true then the application will wait for the other op-logs to be compacted and
additional space is available.</div>
</li>
</ul>
<a name="forceCompaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceCompaction</h4>
<pre>boolean&nbsp;forceCompaction()</pre>
<div class="block">Requests the DiskStore to start compacting. The compaction is done even if automatic compaction
is not configured. If the current, active op-log has had data written to it, and may be
compacted, then an implicit call to forceRoll will be made so that the active op-log can be
compacted. This method will block until compaction finishes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if one or more op-logs were compacted or false to indicate that no op-logs were
ready to be compacted or that a compaction was already in progress.</dd>
</dl>
</li>
</ul>
<a name="flush--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
<pre>void&nbsp;flush()</pre>
<div class="block">Causes any data that is currently in the asynchronous queue to be written to disk. Does not
return until the flush is complete.</div>
</li>
</ul>
<a name="getDiskUsageWarningPercentage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskUsageWarningPercentage</h4>
<pre>float&nbsp;getDiskUsageWarningPercentage()</pre>
<div class="block">Returns the warning threshold for disk usage as a percentage of the total disk volume.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the warning percent</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 8.0</dd>
</dl>
</li>
</ul>
<a name="getDiskUsageCriticalPercentage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskUsageCriticalPercentage</h4>
<pre>float&nbsp;getDiskUsageCriticalPercentage()</pre>
<div class="block">Returns the critical threshold for disk usage as a percentage of the total disk volume.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the critical percent</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 8.0</dd>
</dl>
</li>
</ul>
<a name="getDiskUsagePercentage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskUsagePercentage</h4>
<pre>default&nbsp;float&nbsp;getDiskUsagePercentage()</pre>
<div class="block">Returns the usage percentage of this disk storage if directories where created with max size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the usage percentage of this disk storage if directories where created with max size</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Geode 1.10</dd>
</dl>
</li>
</ul>
<a name="getDiskFreePercentage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskFreePercentage</h4>
<pre>default&nbsp;float&nbsp;getDiskFreePercentage()</pre>
<div class="block">Returns the free percentage of this disk storage if directories where created with max size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the free percentage of this disk storage if directories where created with max size</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Geode 1.11</dd>
</dl>
</li>
</ul>
<a name="setDiskUsageWarningPercentage-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDiskUsageWarningPercentage</h4>
<pre>void&nbsp;setDiskUsageWarningPercentage(float&nbsp;warningPercent)</pre>
<div class="block">Sets the value of the disk usage warning percentage.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>warningPercent</code> - the warning percent</dd>
</dl>
</li>
</ul>
<a name="setDiskUsageCriticalPercentage-float-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setDiskUsageCriticalPercentage</h4>
<pre>void&nbsp;setDiskUsageCriticalPercentage(float&nbsp;criticalPercent)</pre>
<div class="block">Sets the value of the disk usage critical percentage.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>criticalPercent</code> - the critical percent</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/DiskMetrics.html" title="class in org.apache.geode.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/management/DistributedLockServiceMXBean.html" title="interface in org.apache.geode.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/management/DiskStoreMXBean.html" target="_top">Frames</a></li>
<li><a href="DiskStoreMXBean.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>