| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>DefaultOperationQuota (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.quotas, class: DefaultOperationQuota"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.quotas</a></div> |
| <h1 title="Class DefaultOperationQuota" class="title">Class DefaultOperationQuota</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.hbase.quotas.DefaultOperationQuota</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="ExceedOperationQuota.html" title="class in org.apache.hadoop.hbase.quotas">ExceedOperationQuota</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| @Evolving |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-32">DefaultOperationQuota</a></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.hadoop.hbase.quotas.OperationQuota">Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.quotas.<a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></h2> |
| <code><a href="OperationQuota.OperationType.html" title="enum class in org.apache.hadoop.hbase.quotas">OperationQuota.OperationType</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private long</code></div> |
| <div class="col-second even-row-color"><code><a href="#blockSizeBytes" class="member-name-link">blockSizeBytes</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#limiters" class="member-name-link">limiters</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private static final double</code></div> |
| <div class="col-second even-row-color"><code><a href="#MAX_SCAN_ESTIMATE_PROPORTIONAL_LIMIT_CONSUMPTION" class="member-name-link">MAX_SCAN_ESTIMATE_PROPORTIONAL_LIMIT_CONSUMPTION</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#maxScanEstimate" class="member-name-link">maxScanEstimate</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final long[]</code></div> |
| <div class="col-second even-row-color"><code><a href="#operationSize" class="member-name-link">operationSize</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#readAvailable" class="member-name-link">readAvailable</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final long</code></div> |
| <div class="col-second even-row-color"><code><a href="#readCapacityUnit" class="member-name-link">readCapacityUnit</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#readCapacityUnitConsumed" class="member-name-link">readCapacityUnitConsumed</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected long</code></div> |
| <div class="col-second even-row-color"><code><a href="#readCapacityUnitDiff" class="member-name-link">readCapacityUnitDiff</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#readConsumed" class="member-name-link">readConsumed</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected long</code></div> |
| <div class="col-second even-row-color"><code><a href="#readDiff" class="member-name-link">readDiff</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#useResultSizeBytes" class="member-name-link">useResultSizeBytes</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final long</code></div> |
| <div class="col-second even-row-color"><code><a href="#writeCapacityUnit" class="member-name-link">writeCapacityUnit</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#writeCapacityUnitConsumed" class="member-name-link">writeCapacityUnitConsumed</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected long</code></div> |
| <div class="col-second even-row-color"><code><a href="#writeCapacityUnitDiff" class="member-name-link">writeCapacityUnitDiff</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#writeConsumed" class="member-name-link">writeConsumed</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected long</code></div> |
| <div class="col-second even-row-color"><code><a href="#writeDiff" class="member-name-link">writeDiff</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.quotas.OperationQuota">Fields inherited from interface org.apache.hadoop.hbase.quotas.<a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></h3> |
| <code><a href="OperationQuota.html#USE_RESULT_SIZE_BYTES">USE_RESULT_SIZE_BYTES</a>, <a href="OperationQuota.html#USE_RESULT_SIZE_BYTES_DEFAULT">USE_RESULT_SIZE_BYTES_DEFAULT</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration,int,org.apache.hadoop.hbase.quotas.QuotaLimiter...)" class="member-name-link">DefaultOperationQuota</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| int blockSizeBytes, |
| <a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>... limiters)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration,java.util.List)" class="member-name-link">DefaultOperationQuota</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>> limiters)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">NOTE: The order matters.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addGetResult(org.apache.hadoop.hbase.client.Result)" class="member-name-link">addGetResult</a><wbr>(<a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a> result)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a get result.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addMutation(org.apache.hadoop.hbase.client.Mutation)" class="member-name-link">addMutation</a><wbr>(<a href="../client/Mutation.html" title="class in org.apache.hadoop.hbase.client">Mutation</a> mutation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a mutation result.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addScanResult(java.util.List)" class="member-name-link">addScanResult</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>> results)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a scan result.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#calculateReadCapacityUnit(long)" class="member-name-link">calculateReadCapacityUnit</a><wbr>(long size)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#calculateReadCapacityUnitDiff(long,long)" class="member-name-link">calculateReadCapacityUnitDiff</a><wbr>(long actualSize, |
| long estimateSize)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#calculateWriteCapacityUnit(long)" class="member-name-link">calculateWriteCapacityUnit</a><wbr>(long size)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#calculateWriteCapacityUnitDiff(long,long)" class="member-name-link">calculateWriteCapacityUnitDiff</a><wbr>(long actualSize, |
| long estimateSize)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkBatchQuota(int,int)" class="member-name-link">checkBatchQuota</a><wbr>(int numWrites, |
| int numReads)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks if it is possible to execute the specified operation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkQuota(long,long)" class="member-name-link">checkQuota</a><wbr>(long numWrites, |
| long numReads)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkScanQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest,long,long,long)" class="member-name-link">checkScanQuota</a><wbr>(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest scanRequest, |
| long maxScannerResultSize, |
| long maxBlockBytesScanned, |
| long prevBlockBytesScannedDifference)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks if it is possible to execute the scan.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Cleanup method on operation completion</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#estimateConsume(org.apache.hadoop.hbase.quotas.OperationQuota.OperationType,int,long)" class="member-name-link">estimateConsume</a><wbr>(<a href="OperationQuota.OperationType.html" title="enum class in org.apache.hadoop.hbase.quotas">OperationQuota.OperationType</a> type, |
| int numReqs, |
| long avgSize)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReadAvailable()" class="member-name-link">getReadAvailable</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of bytes available to read to avoid exceeding the quota</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReadConsumed()" class="member-name-link">getReadConsumed</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of bytes consumed from the quota by the operation</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getScanReadConsumeEstimate(long,long,long,long,long)" class="member-name-link">getScanReadConsumeEstimate</a><wbr>(long blockSizeBytes, |
| long nextCallSeq, |
| long maxScannerResultSize, |
| long maxBlockBytesScanned, |
| long prevBlockBytesScannedDifference)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateEstimateConsumeBatchQuota(int,int)" class="member-name-link">updateEstimateConsumeBatchQuota</a><wbr>(int numWrites, |
| int numReads)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Update estimate quota(read/write size/capacityUnits) which will be consumed</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateEstimateConsumeScanQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest,long,long,long)" class="member-name-link">updateEstimateConsumeScanQuota</a><wbr>(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest scanRequest, |
| long maxScannerResultSize, |
| long maxBlockBytesScanned, |
| long prevBlockBytesScannedDifference)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Update estimate quota(read/write size/capacityUnits) which will be consumed</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.quotas.OperationQuota">Methods inherited from interface org.apache.hadoop.hbase.quotas.<a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></h3> |
| <code><a href="OperationQuota.html#getMaxResultSize()">getMaxResultSize</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="MAX_SCAN_ESTIMATE_PROPORTIONAL_LIMIT_CONSUMPTION"> |
| <h3>MAX_SCAN_ESTIMATE_PROPORTIONAL_LIMIT_CONSUMPTION</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">double</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-39">MAX_SCAN_ESTIMATE_PROPORTIONAL_LIMIT_CONSUMPTION</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.quotas.DefaultOperationQuota.MAX_SCAN_ESTIMATE_PROPORTIONAL_LIMIT_CONSUMPTION">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="limiters"> |
| <h3>limiters</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-41">limiters</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeCapacityUnit"> |
| <h3>writeCapacityUnit</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-42">writeCapacityUnit</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readCapacityUnit"> |
| <h3>readCapacityUnit</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-43">readCapacityUnit</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readAvailable"> |
| <h3>readAvailable</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-46">readAvailable</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeConsumed"> |
| <h3>writeConsumed</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-48">writeConsumed</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readConsumed"> |
| <h3>readConsumed</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-49">readConsumed</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeCapacityUnitConsumed"> |
| <h3>writeCapacityUnitConsumed</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-50">writeCapacityUnitConsumed</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readCapacityUnitConsumed"> |
| <h3>readCapacityUnitConsumed</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-51">readCapacityUnitConsumed</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="operationSize"> |
| <h3>operationSize</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">long[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-53">operationSize</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeDiff"> |
| <h3>writeDiff</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-57">writeDiff</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readDiff"> |
| <h3>readDiff</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-58">readDiff</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeCapacityUnitDiff"> |
| <h3>writeCapacityUnitDiff</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-59">writeCapacityUnitDiff</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readCapacityUnitDiff"> |
| <h3>readCapacityUnitDiff</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-60">readCapacityUnitDiff</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="useResultSizeBytes"> |
| <h3>useResultSizeBytes</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-61">useResultSizeBytes</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="blockSizeBytes"> |
| <h3>blockSizeBytes</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-62">blockSizeBytes</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="maxScanEstimate"> |
| <h3>maxScanEstimate</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-63">maxScanEstimate</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.conf.Configuration,int,org.apache.hadoop.hbase.quotas.QuotaLimiter...)"> |
| <h3>DefaultOperationQuota</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-65">DefaultOperationQuota</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| int blockSizeBytes, |
| <a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>... limiters)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.conf.Configuration,java.util.List)"> |
| <h3>DefaultOperationQuota</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-79">DefaultOperationQuota</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>> limiters)</span></div> |
| <div class="block">NOTE: The order matters. It should be something like [user, table, namespace, global]</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="checkBatchQuota(int,int)"> |
| <h3>checkBatchQuota</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-93">checkBatchQuota</a></span><wbr><span class="parameters">(int numWrites, |
| int numReads)</span> |
| throws <span class="exceptions"><a href="RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="OperationQuota.html#checkBatchQuota(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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="OperationQuota.html#checkBatchQuota(int,int)">checkBatchQuota</a></code> in interface <code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd> |
| <dt>Parameters:</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> |
| <dt>Throws:</dt> |
| <dd><code><a href="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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkScanQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest,long,long,long)"> |
| <h3>checkScanQuota</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-99">checkScanQuota</a></span><wbr><span class="parameters">(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest scanRequest, |
| long maxScannerResultSize, |
| long maxBlockBytesScanned, |
| long prevBlockBytesScannedDifference)</span> |
| throws <span class="exceptions"><a href="RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="OperationQuota.html#checkScanQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest,long,long,long)">OperationQuota</a></code></span></div> |
| <div class="block">Checks if it is possible to execute the scan. The quota will be estimated based on the |
| composition of the scan.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="OperationQuota.html#checkScanQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest,long,long,long)">checkScanQuota</a></code> in interface <code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>scanRequest</code> - the given scan operation</dd> |
| <dd><code>maxScannerResultSize</code> - the maximum bytes to be returned by the scanner</dd> |
| <dd><code>maxBlockBytesScanned</code> - the maximum bytes scanned in a single RPC call by the |
| scanner</dd> |
| <dd><code>prevBlockBytesScannedDifference</code> - the difference between BBS of the previous two next |
| calls</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkQuota(long,long)"> |
| <h3>checkQuota</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-107">checkQuota</a></span><wbr><span class="parameters">(long numWrites, |
| long numReads)</span> |
| throws <span class="exceptions"><a href="RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-133">close</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="OperationQuota.html#close()">OperationQuota</a></code></span></div> |
| <div class="block">Cleanup method on operation completion</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="OperationQuota.html#close()">close</a></code> in interface <code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReadAvailable()"> |
| <h3>getReadAvailable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-164">getReadAvailable</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="OperationQuota.html#getReadAvailable()">OperationQuota</a></code></span></div> |
| <div class="block">Returns the number of bytes available to read to avoid exceeding the quota</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="OperationQuota.html#getReadAvailable()">getReadAvailable</a></code> in interface <code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReadConsumed()"> |
| <h3>getReadConsumed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-169">getReadConsumed</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="OperationQuota.html#getReadConsumed()">OperationQuota</a></code></span></div> |
| <div class="block">Returns the number of bytes consumed from the quota by the operation</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="OperationQuota.html#getReadConsumed()">getReadConsumed</a></code> in interface <code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addGetResult(org.apache.hadoop.hbase.client.Result)"> |
| <h3>addGetResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-174">addGetResult</a></span><wbr><span class="parameters">(<a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a> result)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="OperationQuota.html#addGetResult(org.apache.hadoop.hbase.client.Result)">addGetResult</a></code> in interface <code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addScanResult(java.util.List)"> |
| <h3>addScanResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-179">addScanResult</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>> results)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="OperationQuota.html#addScanResult(java.util.List)">addScanResult</a></code> in interface <code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addMutation(org.apache.hadoop.hbase.client.Mutation)"> |
| <h3>addMutation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-184">addMutation</a></span><wbr><span class="parameters">(<a href="../client/Mutation.html" title="class in org.apache.hadoop.hbase.client">Mutation</a> mutation)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="OperationQuota.html#addMutation(org.apache.hadoop.hbase.client.Mutation)">addMutation</a></code> in interface <code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateEstimateConsumeBatchQuota(int,int)"> |
| <h3>updateEstimateConsumeBatchQuota</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-194">updateEstimateConsumeBatchQuota</a></span><wbr><span class="parameters">(int numWrites, |
| int numReads)</span></div> |
| <div class="block">Update estimate quota(read/write size/capacityUnits) which will be consumed</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>numWrites</code> - the number of write requests</dd> |
| <dd><code>numReads</code> - the number of read requests</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateEstimateConsumeScanQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest,long,long,long)"> |
| <h3>updateEstimateConsumeScanQuota</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-217">updateEstimateConsumeScanQuota</a></span><wbr><span class="parameters">(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest scanRequest, |
| long maxScannerResultSize, |
| long maxBlockBytesScanned, |
| long prevBlockBytesScannedDifference)</span></div> |
| <div class="block">Update estimate quota(read/write size/capacityUnits) which will be consumed</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>scanRequest</code> - the scan to be executed</dd> |
| <dd><code>maxScannerResultSize</code> - the maximum bytes to be returned by the scanner</dd> |
| <dd><code>maxBlockBytesScanned</code> - the maximum bytes scanned in a single RPC call by the |
| scanner</dd> |
| <dd><code>prevBlockBytesScannedDifference</code> - the difference between BBS of the previous two next |
| calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScanReadConsumeEstimate(long,long,long,long,long)"> |
| <h3>getScanReadConsumeEstimate</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-230">getScanReadConsumeEstimate</a></span><wbr><span class="parameters">(long blockSizeBytes, |
| long nextCallSeq, |
| long maxScannerResultSize, |
| long maxBlockBytesScanned, |
| long prevBlockBytesScannedDifference)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="estimateConsume(org.apache.hadoop.hbase.quotas.OperationQuota.OperationType,int,long)"> |
| <h3>estimateConsume</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-256">estimateConsume</a></span><wbr><span class="parameters">(<a href="OperationQuota.OperationType.html" title="enum class in org.apache.hadoop.hbase.quotas">OperationQuota.OperationType</a> type, |
| int numReqs, |
| long avgSize)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="calculateWriteCapacityUnit(long)"> |
| <h3>calculateWriteCapacityUnit</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-263">calculateWriteCapacityUnit</a></span><wbr><span class="parameters">(long size)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="calculateReadCapacityUnit(long)"> |
| <h3>calculateReadCapacityUnit</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-267">calculateReadCapacityUnit</a></span><wbr><span class="parameters">(long size)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="calculateWriteCapacityUnitDiff(long,long)"> |
| <h3>calculateWriteCapacityUnitDiff</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-271">calculateWriteCapacityUnitDiff</a></span><wbr><span class="parameters">(long actualSize, |
| long estimateSize)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="calculateReadCapacityUnitDiff(long,long)"> |
| <h3>calculateReadCapacityUnitDiff</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/DefaultOperationQuota.html#line-275">calculateReadCapacityUnitDiff</a></span><wbr><span class="parameters">(long actualSize, |
| long estimateSize)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |