blob: ebdc9f91313e1214cf09369d03817985e285449d [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>DefaultOperationQuota (Apache HBase 3.0.0-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="DefaultOperationQuota (Apache HBase 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/DefaultOperationQuota.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/quotas/AverageIntervalRateLimiter.html" title="class in org.apache.hadoop.hbase.quotas"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/quotas/ExceedOperationQuota.html" title="class in org.apache.hadoop.hbase.quotas"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html" target="_top">Frames</a></li>
<li><a href="DefaultOperationQuota.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.quotas</div>
<h2 title="Class DefaultOperationQuota" class="title">Class DefaultOperationQuota</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.quotas.DefaultOperationQuota</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/quotas/ExceedOperationQuota.html" title="class in org.apache.hadoop.hbase.quotas">ExceedOperationQuota</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Private
@InterfaceStability.Evolving
public class <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.32">DefaultOperationQuota</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.hbase.quotas.OperationQuota">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.hadoop.hbase.quotas.<a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.OperationType.html" title="enum in org.apache.hadoop.hbase.quotas">OperationQuota.OperationType</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#limiters">limiters</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private long[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#operationSize">operationSize</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#readAvailable">readAvailable</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#readCapacityUnit">readCapacityUnit</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#readCapacityUnitConsumed">readCapacityUnitConsumed</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#readCapacityUnitDiff">readCapacityUnitDiff</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#readConsumed">readConsumed</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#readDiff">readDiff</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#writeCapacityUnit">writeCapacityUnit</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#writeCapacityUnitConsumed">writeCapacityUnitConsumed</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#writeCapacityUnitDiff">writeCapacityUnitDiff</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#writeConsumed">writeConsumed</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#writeDiff">writeDiff</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#DefaultOperationQuota-org.apache.hadoop.conf.Configuration-java.util.List-">DefaultOperationQuota</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>&gt;&nbsp;limiters)</code>
<div class="block">NOTE: The order matters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#DefaultOperationQuota-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.quotas.QuotaLimiter...-">DefaultOperationQuota</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>...&nbsp;limiters)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/hadoop/hbase/quotas/DefaultOperationQuota.html#addGetResult-org.apache.hadoop.hbase.client.Result-">addGetResult</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>&nbsp;result)</code>
<div class="block">Add a get result.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#addMutation-org.apache.hadoop.hbase.client.Mutation-">addMutation</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Mutation.html" title="class in org.apache.hadoop.hbase.client">Mutation</a>&nbsp;mutation)</code>
<div class="block">Add a mutation result.</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/hadoop/hbase/quotas/DefaultOperationQuota.html#addScanResult-java.util.List-">addScanResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>&gt;&nbsp;results)</code>
<div class="block">Add a scan result.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#calculateReadCapacityUnit-long-">calculateReadCapacityUnit</a></span>(long&nbsp;size)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#calculateReadCapacityUnitDiff-long-long-">calculateReadCapacityUnitDiff</a></span>(long&nbsp;actualSize,
long&nbsp;estimateSize)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#calculateWriteCapacityUnit-long-">calculateWriteCapacityUnit</a></span>(long&nbsp;size)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#calculateWriteCapacityUnitDiff-long-long-">calculateWriteCapacityUnitDiff</a></span>(long&nbsp;actualSize,
long&nbsp;estimateSize)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#checkQuota-int-int-int-">checkQuota</a></span>(int&nbsp;numWrites,
int&nbsp;numReads,
int&nbsp;numScans)</code>
<div class="block">Checks if it is possible to execute the specified operation.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#close--">close</a></span>()</code>
<div class="block">Cleanup method on operation completion</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#estimateConsume-org.apache.hadoop.hbase.quotas.OperationQuota.OperationType-int-long-">estimateConsume</a></span>(<a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.OperationType.html" title="enum in org.apache.hadoop.hbase.quotas">OperationQuota.OperationType</a>&nbsp;type,
int&nbsp;numReqs,
long&nbsp;avgSize)</code>&nbsp;</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/quotas/DefaultOperationQuota.html#getReadAvailable--">getReadAvailable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#updateEstimateConsumeQuota-int-int-int-">updateEstimateConsumeQuota</a></span>(int&nbsp;numWrites,
int&nbsp;numReads,
int&nbsp;numScans)</code>
<div class="block">Update estimate quota(read/write size/capacityUnits) which will be consumed</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="limiters">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>limiters</h4>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>&gt; <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.34">limiters</a></pre>
</li>
</ul>
<a name="writeCapacityUnit">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeCapacityUnit</h4>
<pre>private final&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.35">writeCapacityUnit</a></pre>
</li>
</ul>
<a name="readCapacityUnit">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readCapacityUnit</h4>
<pre>private final&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.36">readCapacityUnit</a></pre>
</li>
</ul>
<a name="readAvailable">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readAvailable</h4>
<pre>protected&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.39">readAvailable</a></pre>
</li>
</ul>
<a name="writeConsumed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeConsumed</h4>
<pre>protected&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.41">writeConsumed</a></pre>
</li>
</ul>
<a name="readConsumed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readConsumed</h4>
<pre>protected&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.42">readConsumed</a></pre>
</li>
</ul>
<a name="writeCapacityUnitConsumed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeCapacityUnitConsumed</h4>
<pre>protected&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.43">writeCapacityUnitConsumed</a></pre>
</li>
</ul>
<a name="readCapacityUnitConsumed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readCapacityUnitConsumed</h4>
<pre>protected&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.44">readCapacityUnitConsumed</a></pre>
</li>
</ul>
<a name="operationSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>operationSize</h4>
<pre>private final&nbsp;long[] <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.46">operationSize</a></pre>
</li>
</ul>
<a name="writeDiff">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeDiff</h4>
<pre>protected&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.50">writeDiff</a></pre>
</li>
</ul>
<a name="readDiff">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readDiff</h4>
<pre>protected&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.51">readDiff</a></pre>
</li>
</ul>
<a name="writeCapacityUnitDiff">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeCapacityUnitDiff</h4>
<pre>protected&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.52">writeCapacityUnitDiff</a></pre>
</li>
</ul>
<a name="readCapacityUnitDiff">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readCapacityUnitDiff</h4>
<pre>protected&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.53">readCapacityUnitDiff</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DefaultOperationQuota-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.quotas.QuotaLimiter...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DefaultOperationQuota</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.55">DefaultOperationQuota</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>...&nbsp;limiters)</pre>
</li>
</ul>
<a name="DefaultOperationQuota-org.apache.hadoop.conf.Configuration-java.util.List-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultOperationQuota</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.62">DefaultOperationQuota</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>&gt;&nbsp;limiters)</pre>
<div class="block">NOTE: The order matters. It should be something like [user, table, namespace, global]</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="checkQuota-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkQuota</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.77">checkQuota</a>(int&nbsp;numWrites,
int&nbsp;numReads,
int&nbsp;numScans)
throws <a href="../../../../../org/apache/hadoop/hbase/quotas/RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html#checkQuota-int-int-int-">OperationQuota</a></code></span></div>
<div class="block">Checks if it is possible to execute the specified operation.
The quota will be estimated based on the number of operations to perform
and the average size accumulated during time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html#checkQuota-int-int-int-">checkQuota</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numWrites</code> - number of write operation that will be performed</dd>
<dd><code>numReads</code> - number of small-read operation that will be performed</dd>
<dd><code>numScans</code> - number of long-read operation that will be performed</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></code> - if the operation cannot be performed because
RPC quota is exceeded.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.96">close</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html#close--">OperationQuota</a></code></span></div>
<div class="block">Cleanup method on operation completion</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd>
</dl>
</li>
</ul>
<a name="getReadAvailable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadAvailable</h4>
<pre>public&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.118">getReadAvailable</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html#getReadAvailable--">getReadAvailable</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes available to read to avoid exceeding the quota</dd>
</dl>
</li>
</ul>
<a name="addGetResult-org.apache.hadoop.hbase.client.Result-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGetResult</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.123">addGetResult</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>&nbsp;result)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html#addGetResult-org.apache.hadoop.hbase.client.Result-">OperationQuota</a></code></span></div>
<div class="block">Add a get result. This will be used to calculate the exact quota and
have a better short-read average size for the next time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html#addGetResult-org.apache.hadoop.hbase.client.Result-">addGetResult</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd>
</dl>
</li>
</ul>
<a name="addScanResult-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addScanResult</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.128">addScanResult</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>&gt;&nbsp;results)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html#addScanResult-java.util.List-">OperationQuota</a></code></span></div>
<div class="block">Add a scan result. This will be used to calculate the exact quota and
have a better long-read average size for the next time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html#addScanResult-java.util.List-">addScanResult</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd>
</dl>
</li>
</ul>
<a name="addMutation-org.apache.hadoop.hbase.client.Mutation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMutation</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.133">addMutation</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Mutation.html" title="class in org.apache.hadoop.hbase.client">Mutation</a>&nbsp;mutation)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html#addMutation-org.apache.hadoop.hbase.client.Mutation-">OperationQuota</a></code></span></div>
<div class="block">Add a mutation result. This will be used to calculate the exact quota and
have a better mutation average size for the next time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html#addMutation-org.apache.hadoop.hbase.client.Mutation-">addMutation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd>
</dl>
</li>
</ul>
<a name="updateEstimateConsumeQuota-int-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateEstimateConsumeQuota</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.143">updateEstimateConsumeQuota</a>(int&nbsp;numWrites,
int&nbsp;numReads,
int&nbsp;numScans)</pre>
<div class="block">Update estimate quota(read/write size/capacityUnits) which will be consumed</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numWrites</code> - the number of write requests</dd>
<dd><code>numReads</code> - the number of read requests</dd>
<dd><code>numScans</code> - the number of scan requests</dd>
</dl>
</li>
</ul>
<a name="estimateConsume-org.apache.hadoop.hbase.quotas.OperationQuota.OperationType-int-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>estimateConsume</h4>
<pre>private&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.152">estimateConsume</a>(<a href="../../../../../org/apache/hadoop/hbase/quotas/OperationQuota.OperationType.html" title="enum in org.apache.hadoop.hbase.quotas">OperationQuota.OperationType</a>&nbsp;type,
int&nbsp;numReqs,
long&nbsp;avgSize)</pre>
</li>
</ul>
<a name="calculateWriteCapacityUnit-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateWriteCapacityUnit</h4>
<pre>private&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.159">calculateWriteCapacityUnit</a>(long&nbsp;size)</pre>
</li>
</ul>
<a name="calculateReadCapacityUnit-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateReadCapacityUnit</h4>
<pre>private&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.163">calculateReadCapacityUnit</a>(long&nbsp;size)</pre>
</li>
</ul>
<a name="calculateWriteCapacityUnitDiff-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateWriteCapacityUnitDiff</h4>
<pre>private&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.167">calculateWriteCapacityUnitDiff</a>(long&nbsp;actualSize,
long&nbsp;estimateSize)</pre>
</li>
</ul>
<a name="calculateReadCapacityUnitDiff-long-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>calculateReadCapacityUnitDiff</h4>
<pre>private&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line.171">calculateReadCapacityUnitDiff</a>(long&nbsp;actualSize,
long&nbsp;estimateSize)</pre>
</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/DefaultOperationQuota.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/quotas/AverageIntervalRateLimiter.html" title="class in org.apache.hadoop.hbase.quotas"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/quotas/ExceedOperationQuota.html" title="class in org.apache.hadoop.hbase.quotas"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html" target="_top">Frames</a></li>
<li><a href="DefaultOperationQuota.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>