| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>NamespaceQuotaSnapshotStore (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: NamespaceQuotaSnapshotStore"> |
| <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/NamespaceQuotaSnapshotStore.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>Nested | </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 NamespaceQuotaSnapshotStore" class="title">Class NamespaceQuotaSnapshotStore</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.NamespaceQuotaSnapshotStore</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="QuotaSnapshotStore.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaSnapshotStore</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-40">NamespaceQuotaSnapshotStore</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="QuotaSnapshotStore.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaSnapshotStore</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span></div> |
| <div class="block"><a href="QuotaSnapshotStore.html" title="interface in org.apache.hadoop.hbase.quotas"><code>QuotaSnapshotStore</code></a> implementation for namespaces.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== 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 final <a href="QuotaObserverChore.html" title="class in org.apache.hadoop.hbase.quotas">QuotaObserverChore</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#chore" class="member-name-link">chore</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final <a href="../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#conn" class="member-name-link">conn</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReentrantReadWriteLock.html" title="class or interface in java.util.concurrent.locks" class="external-link">ReentrantReadWriteLock</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#lock" class="member-name-link">lock</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#regionUsage" class="member-name-link">regionUsage</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReentrantReadWriteLock.ReadLock.html" title="class or interface in java.util.concurrent.locks" class="external-link">ReentrantReadWriteLock.ReadLock</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#rlock" class="member-name-link">rlock</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReentrantReadWriteLock.WriteLock.html" title="class or interface in java.util.concurrent.locks" class="external-link">ReentrantReadWriteLock.WriteLock</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#wlock" class="member-name-link">wlock</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.quotas.QuotaSnapshotStore">Fields inherited from interface org.apache.hadoop.hbase.quotas.<a href="QuotaSnapshotStore.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaSnapshotStore</a></h3> |
| <code><a href="QuotaSnapshotStore.html#NO_QUOTA">NO_QUOTA</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.hbase.client.Connection,org.apache.hadoop.hbase.quotas.QuotaObserverChore,java.util.Map)" class="member-name-link">NamespaceQuotaSnapshotStore</a><wbr>(<a href="../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <a href="QuotaObserverChore.html" title="class in org.apache.hadoop.hbase.quotas">QuotaObserverChore</a> chore, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> regionUsage)</code></div> |
| <div class="col-last even-row-color"> </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-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><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.Entry.html" title="class or interface in java.util" class="external-link">Map.Entry</a><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#filterBySubject(java.lang.String)" class="member-name-link">filterBySubject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> namespace)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Filters the provided <code>regions</code>, returning those which match the given |
| <code>subject</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas">SpaceQuotaSnapshot</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentState(java.lang.String)" class="member-name-link">getCurrentState</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> namespace)</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 current <a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas"><code>SpaceQuotaSnapshot</code></a> for the given <code>subject</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuotaForNamespace(java.lang.String)" class="member-name-link">getQuotaForNamespace</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> namespace)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Fetches the namespace quota.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuota</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSpaceQuota(java.lang.String)" class="member-name-link">getSpaceQuota</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> namespace)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Fetch the Quota for the given <code>subject</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas">SpaceQuotaSnapshot</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetState(java.lang.String,org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuota)" class="member-name-link">getTargetState</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> subject, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuota spaceQuota)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Computes the target <a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas"><code>SpaceQuotaSnapshot</code></a> for the given <code>subject</code> and |
| <code>spaceQuota</code>.</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="#setCurrentState(java.lang.String,org.apache.hadoop.hbase.quotas.SpaceQuotaSnapshot)" class="member-name-link">setCurrentState</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> namespace, |
| <a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas">SpaceQuotaSnapshot</a> snapshot)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Persists the current <a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas"><code>SpaceQuotaSnapshot</code></a> for the <code>subject</code>.</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="#setRegionUsage(java.util.Map)" class="member-name-link">setRegionUsage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> regionUsage)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Updates <code>this</code> with the latest snapshot of filesystem use by region.</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> |
| </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="lock"> |
| <h3>lock</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReentrantReadWriteLock.html" title="class or interface in java.util.concurrent.locks" class="external-link">ReentrantReadWriteLock</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-42">lock</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rlock"> |
| <h3>rlock</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReentrantReadWriteLock.ReadLock.html" title="class or interface in java.util.concurrent.locks" class="external-link">ReentrantReadWriteLock.ReadLock</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-43">rlock</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="wlock"> |
| <h3>wlock</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReentrantReadWriteLock.WriteLock.html" title="class or interface in java.util.concurrent.locks" class="external-link">ReentrantReadWriteLock.WriteLock</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-44">wlock</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="conn"> |
| <h3>conn</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-46">conn</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="chore"> |
| <h3>chore</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="QuotaObserverChore.html" title="class in org.apache.hadoop.hbase.quotas">QuotaObserverChore</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-47">chore</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="regionUsage"> |
| <h3>regionUsage</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-48">regionUsage</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.hbase.client.Connection,org.apache.hadoop.hbase.quotas.QuotaObserverChore,java.util.Map)"> |
| <h3>NamespaceQuotaSnapshotStore</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-50">NamespaceQuotaSnapshotStore</a></span><wbr><span class="parameters">(<a href="../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> conn, |
| <a href="QuotaObserverChore.html" title="class in org.apache.hadoop.hbase.quotas">QuotaObserverChore</a> chore, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> regionUsage)</span></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="getSpaceQuota(java.lang.String)"> |
| <h3>getSpaceQuota</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuota</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-57">getSpaceQuota</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> namespace)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaSnapshotStore.html#getSpaceQuota(T)">QuotaSnapshotStore</a></code></span></div> |
| <div class="block">Fetch the Quota for the given <code>subject</code>. May be null.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaSnapshotStore.html#getSpaceQuota(T)">getSpaceQuota</a></code> in interface <code><a href="QuotaSnapshotStore.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaSnapshotStore</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - The object for which the quota should be fetched</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQuotaForNamespace(java.lang.String)"> |
| <h3>getQuotaForNamespace</h3> |
| <div class="member-signature"><span class="return-type">org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-69">getQuotaForNamespace</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> namespace)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Fetches the namespace quota. Visible for mocking/testing.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCurrentState(java.lang.String)"> |
| <h3>getCurrentState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas">SpaceQuotaSnapshot</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-73">getCurrentState</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> namespace)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaSnapshotStore.html#getCurrentState(T)">QuotaSnapshotStore</a></code></span></div> |
| <div class="block">Returns the current <a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas"><code>SpaceQuotaSnapshot</code></a> for the given <code>subject</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaSnapshotStore.html#getCurrentState(T)">getCurrentState</a></code> in interface <code><a href="QuotaSnapshotStore.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaSnapshotStore</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - The object which the quota snapshot should be fetched</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTargetState(java.lang.String,org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuota)"> |
| <h3>getTargetState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas">SpaceQuotaSnapshot</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-79">getTargetState</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> subject, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuota spaceQuota)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaSnapshotStore.html#getTargetState(T,org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuota)">QuotaSnapshotStore</a></code></span></div> |
| <div class="block">Computes the target <a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas"><code>SpaceQuotaSnapshot</code></a> for the given <code>subject</code> and |
| <code>spaceQuota</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaSnapshotStore.html#getTargetState(T,org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuota)">getTargetState</a></code> in interface <code><a href="QuotaSnapshotStore.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaSnapshotStore</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>subject</code> - The object which to determine the target SpaceQuotaSnapshot of</dd> |
| <dd><code>spaceQuota</code> - The quota "definition" for the <code>subject</code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="filterBySubject(java.lang.String)"> |
| <h3>filterBySubject</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.Entry.html" title="class or interface in java.util" class="external-link">Map.Entry</a><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/NamespaceQuotaSnapshotStore.html#line-101">filterBySubject</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> namespace)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaSnapshotStore.html#filterBySubject(T)">QuotaSnapshotStore</a></code></span></div> |
| <div class="block">Filters the provided <code>regions</code>, returning those which match the given |
| <code>subject</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaSnapshotStore.html#filterBySubject(T)">filterBySubject</a></code> in interface <code><a href="QuotaSnapshotStore.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaSnapshotStore</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - The filter criteria. Only regions belonging to this parameter will be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCurrentState(java.lang.String,org.apache.hadoop.hbase.quotas.SpaceQuotaSnapshot)"> |
| <h3>setCurrentState</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/NamespaceQuotaSnapshotStore.html#line-113">setCurrentState</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> namespace, |
| <a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas">SpaceQuotaSnapshot</a> snapshot)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaSnapshotStore.html#setCurrentState(T,org.apache.hadoop.hbase.quotas.SpaceQuotaSnapshot)">QuotaSnapshotStore</a></code></span></div> |
| <div class="block">Persists the current <a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas"><code>SpaceQuotaSnapshot</code></a> for the <code>subject</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaSnapshotStore.html#setCurrentState(T,org.apache.hadoop.hbase.quotas.SpaceQuotaSnapshot)">setCurrentState</a></code> in interface <code><a href="QuotaSnapshotStore.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaSnapshotStore</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>namespace</code> - The object which the <a href="SpaceQuotaSnapshot.html" title="class in org.apache.hadoop.hbase.quotas"><code>SpaceQuotaSnapshot</code></a> is being persisted for</dd> |
| <dd><code>snapshot</code> - The current state of the <code>subject</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRegionUsage(java.util.Map)"> |
| <h3>setRegionUsage</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/NamespaceQuotaSnapshotStore.html#line-119">setRegionUsage</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>> regionUsage)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaSnapshotStore.html#setRegionUsage(java.util.Map)">QuotaSnapshotStore</a></code></span></div> |
| <div class="block">Updates <code>this</code> with the latest snapshot of filesystem use by region.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaSnapshotStore.html#setRegionUsage(java.util.Map)">setRegionUsage</a></code> in interface <code><a href="QuotaSnapshotStore.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaSnapshotStore</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>regionUsage</code> - A map of <code>RegionInfo</code> objects to their filesystem usage in bytes</dd> |
| </dl> |
| </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> |
