blob: ab72562c6058f33e406b70a96c594aa9ca7078ea [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Snapshot (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</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="Snapshot (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)";
}
}
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,"i11":6,"i12":6,"i13":6,"i14":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="class-use/Snapshot.html">Use</a></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/hadoop/hbase/metrics/PackageMarker.html" title="annotation in org.apache.hadoop.hbase.metrics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/metrics/Timer.html" title="interface in org.apache.hadoop.hbase.metrics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/metrics/Snapshot.html" target="_top">Frames</a></li>
<li><a href="Snapshot.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.hadoop.hbase.metrics</div>
<h2 title="Interface Snapshot" class="title">Interface Snapshot</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@InterfaceAudience.Private
public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.29">Snapshot</a></pre>
<div class="block">A statictical sample of histogram values.</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/hadoop/hbase/metrics/Snapshot.html#get25thPercentile--">get25thPercentile</a></span>()</code>
<div class="block">Returns the value at the 25th percentile in the distribution.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/Snapshot.html#get75thPercentile--">get75thPercentile</a></span>()</code>
<div class="block">Returns the value at the 75th percentile in the distribution.</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/hadoop/hbase/metrics/Snapshot.html#get90thPercentile--">get90thPercentile</a></span>()</code>
<div class="block">Returns the value at the 90th percentile in the distribution.</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/hadoop/hbase/metrics/Snapshot.html#get95thPercentile--">get95thPercentile</a></span>()</code>
<div class="block">Returns the value at the 95th percentile in the distribution.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/Snapshot.html#get98thPercentile--">get98thPercentile</a></span>()</code>
<div class="block">Returns the value at the 98th percentile in the distribution.</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/hadoop/hbase/metrics/Snapshot.html#get999thPercentile--">get999thPercentile</a></span>()</code>
<div class="block">Returns the value at the 99.9th percentile in the distribution.</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/hadoop/hbase/metrics/Snapshot.html#get99thPercentile--">get99thPercentile</a></span>()</code>
<div class="block">Returns the value at the 99th percentile in the distribution.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/Snapshot.html#getCount--">getCount</a></span>()</code>
<div class="block">Returns the number of values in the snapshot.</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/hadoop/hbase/metrics/Snapshot.html#getCountAtOrBelow-long-">getCountAtOrBelow</a></span>(long&nbsp;val)</code>
<div class="block">Returns the total count below the given value</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/Snapshot.html#getMax--">getMax</a></span>()</code>
<div class="block">Returns the highest value in the snapshot.</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/hadoop/hbase/metrics/Snapshot.html#getMean--">getMean</a></span>()</code>
<div class="block">Returns the arithmetic mean of the values in the snapshot.</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/hadoop/hbase/metrics/Snapshot.html#getMedian--">getMedian</a></span>()</code>
<div class="block">Returns the median value in the distribution.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/metrics/Snapshot.html#getMin--">getMin</a></span>()</code>
<div class="block">Returns the lowest value in the snapshot.</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/hadoop/hbase/metrics/Snapshot.html#getQuantiles--">getQuantiles</a></span>()</code>
<div class="block">Return the values with the default quantiles.</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/hadoop/hbase/metrics/Snapshot.html#getQuantiles-double:A-">getQuantiles</a></span>(double[]&nbsp;quantiles)</code>
<div class="block">Return the values with the given quantiles.</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="getQuantiles-double:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQuantiles</h4>
<pre>long[]&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.36">getQuantiles</a>(double[]&nbsp;quantiles)</pre>
<div class="block">Return the values with the given quantiles.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>quantiles</code> - the requested quantiles.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value for the quantiles.</dd>
</dl>
</li>
</ul>
<a name="getQuantiles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQuantiles</h4>
<pre>long[]&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.42">getQuantiles</a>()</pre>
<div class="block">Return the values with the default quantiles.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value for default the quantiles.</dd>
</dl>
</li>
</ul>
<a name="getCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCount</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.49">getCount</a>()</pre>
<div class="block">Returns the number of values in the snapshot.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of values</dd>
</dl>
</li>
</ul>
<a name="getCountAtOrBelow-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCountAtOrBelow</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.56">getCountAtOrBelow</a>(long&nbsp;val)</pre>
<div class="block">Returns the total count below the given value</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>val</code> - the value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total count below the given value</dd>
</dl>
</li>
</ul>
<a name="get25thPercentile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get25thPercentile</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.63">get25thPercentile</a>()</pre>
<div class="block">Returns the value at the 25th percentile in the distribution.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value at the 25th percentile</dd>
</dl>
</li>
</ul>
<a name="get75thPercentile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get75thPercentile</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.70">get75thPercentile</a>()</pre>
<div class="block">Returns the value at the 75th percentile in the distribution.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value at the 75th percentile</dd>
</dl>
</li>
</ul>
<a name="get90thPercentile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get90thPercentile</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.77">get90thPercentile</a>()</pre>
<div class="block">Returns the value at the 90th percentile in the distribution.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value at the 90th percentile</dd>
</dl>
</li>
</ul>
<a name="get95thPercentile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get95thPercentile</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.84">get95thPercentile</a>()</pre>
<div class="block">Returns the value at the 95th percentile in the distribution.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value at the 95th percentile</dd>
</dl>
</li>
</ul>
<a name="get98thPercentile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get98thPercentile</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.91">get98thPercentile</a>()</pre>
<div class="block">Returns the value at the 98th percentile in the distribution.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value at the 98th percentile</dd>
</dl>
</li>
</ul>
<a name="get99thPercentile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get99thPercentile</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.98">get99thPercentile</a>()</pre>
<div class="block">Returns the value at the 99th percentile in the distribution.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value at the 99th percentile</dd>
</dl>
</li>
</ul>
<a name="get999thPercentile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get999thPercentile</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.105">get999thPercentile</a>()</pre>
<div class="block">Returns the value at the 99.9th percentile in the distribution.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value at the 99.9th percentile</dd>
</dl>
</li>
</ul>
<a name="getMedian--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMedian</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.112">getMedian</a>()</pre>
<div class="block">Returns the median value in the distribution.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the median value</dd>
</dl>
</li>
</ul>
<a name="getMax--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMax</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.119">getMax</a>()</pre>
<div class="block">Returns the highest value in the snapshot.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the highest value</dd>
</dl>
</li>
</ul>
<a name="getMean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMean</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.126">getMean</a>()</pre>
<div class="block">Returns the arithmetic mean of the values in the snapshot.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the arithmetic mean</dd>
</dl>
</li>
</ul>
<a name="getMin--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMin</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/metrics/Snapshot.html#line.133">getMin</a>()</pre>
<div class="block">Returns the lowest value in the snapshot.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the lowest value</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="class-use/Snapshot.html">Use</a></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/hadoop/hbase/metrics/PackageMarker.html" title="annotation in org.apache.hadoop.hbase.metrics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/metrics/Timer.html" title="interface in org.apache.hadoop.hbase.metrics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/metrics/Snapshot.html" target="_top">Frames</a></li>
<li><a href="Snapshot.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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>