| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ImmutableScan (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.client, class: ImmutableScan"> |
| <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/ImmutableScan.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.client</a></div> |
| <h1 title="Class ImmutableScan" class="title">Class ImmutableScan</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"><a href="Operation.html" title="class in org.apache.hadoop.hbase.client">org.apache.hadoop.hbase.client.Operation</a> |
| <div class="inheritance"><a href="OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">org.apache.hadoop.hbase.client.OperationWithAttributes</a> |
| <div class="inheritance"><a href="Query.html" title="class in org.apache.hadoop.hbase.client">org.apache.hadoop.hbase.client.Query</a> |
| <div class="inheritance"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">org.apache.hadoop.hbase.client.Scan</a> |
| <div class="inheritance">org.apache.hadoop.hbase.client.ImmutableScan</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="Attributes.html" title="interface in org.apache.hadoop.hbase.client">Attributes</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public final class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-35">ImmutableScan</a></span> |
| <span class="extends-implements">extends <a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span></div> |
| <div class="block">Immutable version of Scan</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.client.Scan">Nested classes/interfaces inherited from class org.apache.hadoop.hbase.client.<a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></h2> |
| <code><a href="Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client">Scan.ReadType</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 final <a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#delegateScan" class="member-name-link">delegateScan</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.client.Scan">Fields inherited from class org.apache.hadoop.hbase.client.<a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></h3> |
| <code><a href="Scan.html#DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH">DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</a>, <a href="Scan.html#HBASE_CLIENT_SCANNER_ASYNC_PREFETCH">HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</a>, <a href="Scan.html#SCAN_ATTRIBUTES_TABLE_NAME">SCAN_ATTRIBUTES_TABLE_NAME</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.client.Query">Fields inherited from class org.apache.hadoop.hbase.client.<a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></h3> |
| <code><a href="Query.html#colFamTimeRangeMap">colFamTimeRangeMap</a>, <a href="Query.html#consistency">consistency</a>, <a href="Query.html#filter">filter</a>, <a href="Query.html#loadColumnFamiliesOnDemand">loadColumnFamiliesOnDemand</a>, <a href="Query.html#targetReplicaId">targetReplicaId</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.client.OperationWithAttributes">Fields inherited from class org.apache.hadoop.hbase.client.<a href="OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">OperationWithAttributes</a></h3> |
| <code><a href="OperationWithAttributes.html#ID_ATRIBUTE">ID_ATRIBUTE</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.Scan)" class="member-name-link">ImmutableScan</a><wbr>(<a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Create Immutable instance of Scan from given Scan object</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-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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addColumn(byte%5B%5D,byte%5B%5D)" class="member-name-link">addColumn</a><wbr>(byte[] family, |
| byte[] qualifier)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the column from the specified family with the specified qualifier.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addFamily(byte%5B%5D)" class="member-name-link">addFamily</a><wbr>(byte[] family)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get all columns from the specified family.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doLoadColumnFamiliesOnDemand()" class="member-name-link">doLoadColumnFamiliesOnDemand</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the logical value indicating whether on-demand CF loading should be allowed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getACL()" class="member-name-link">getACL</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 serialized ACL for this operation, or null if none</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAllowPartialResults()" class="member-name-link">getAllowPartialResults</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 true when the constructor of this scan understands that the results they will see may |
| only represent a partial portion of a row.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAttribute(java.lang.String)" class="member-name-link">getAttribute</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> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets an attribute</div> |
| </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="#getAttributeSize()" class="member-name-link">getAttributeSize</a>()</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><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="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>,<wbr>byte[]></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAttributesMap()" class="member-name-link">getAttributesMap</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets all attributes</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../security/visibility/Authorizations.html" title="class in org.apache.hadoop.hbase.security.visibility">Authorizations</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAuthorizations()" class="member-name-link">getAuthorizations</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 authorizations this Query is associated with.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBatch()" class="member-name-link">getBatch</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 maximum number of values to return for a single call to next()</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCacheBlocks()" class="member-name-link">getCacheBlocks</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get whether blocks should be cached for this Scan.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCaching()" class="member-name-link">getCaching</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 caching the number of rows fetched when calling next on a scanner</div> |
| </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/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><byte[],<wbr><a href="../io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getColumnFamilyTimeRange()" class="member-name-link">getColumnFamilyTimeRange</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 A map of column families to time ranges</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Consistency.html" title="enum class in org.apache.hadoop.hbase.client">Consistency</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConsistency()" class="member-name-link">getConsistency</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 consistency level for this operation</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[][]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFamilies()" class="member-name-link">getFamilies</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 keys of the familyMap</div> |
| </div> |
| <div class="col-first odd-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/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><byte[],<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/NavigableSet.html" title="class or interface in java.util" class="external-link">NavigableSet</a><byte[]>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFamilyMap()" class="member-name-link">getFamilyMap</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Getting the familyMap</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFilter()" class="member-name-link">getFilter</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 RowFilter</div> |
| </div> |
| <div class="col-first odd-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/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<wbr><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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFingerprint()" class="member-name-link">getFingerprint</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compile the table and column family (i.e.</div> |
| </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/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getId()" class="member-name-link">getId</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This method allows you to retrieve the identifier for the operation if one was set.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="IsolationLevel.html" title="enum class in org.apache.hadoop.hbase.client">IsolationLevel</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getIsolationLevel()" class="member-name-link">getIsolationLevel</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 isolation level of this query.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLimit()" class="member-name-link">getLimit</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 limit of rows for this scan</div> |
| </div> |
| <div class="col-first odd-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/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLoadColumnFamiliesOnDemandValue()" class="member-name-link">getLoadColumnFamiliesOnDemandValue</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the raw loadColumnFamiliesOnDemand setting; if it's not set, can be null.</div> |
| </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="#getMaxResultSize()" class="member-name-link">getMaxResultSize</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 maximum result size in bytes.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxResultsPerColumnFamily()" class="member-name-link">getMaxResultsPerColumnFamily</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 maximum number of values to return per row per CF</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxVersions()" class="member-name-link">getMaxVersions</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 max number of versions to fetch</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package 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="#getMvccReadPoint()" class="member-name-link">getMvccReadPoint</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the mvcc read point used to open a scanner.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPriority()" class="member-name-link">getPriority</a>()</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><a href="Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client">Scan.ReadType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReadType()" class="member-name-link">getReadType</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 read type for this scan</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReplicaId()" class="member-name-link">getReplicaId</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 region replica id where Query will fetch data from.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRowOffsetPerColumnFamily()" class="member-name-link">getRowOffsetPerColumnFamily</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Method for retrieving the scan's offset per row per column family (#kvs to be skipped)</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStartRow()" class="member-name-link">getStartRow</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 startrow</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStopRow()" class="member-name-link">getStopRow</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 stoprow</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTimeRange()" class="member-name-link">getTimeRange</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 TimeRange</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasFamilies()" class="member-name-link">hasFamilies</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 true if familyMap is non empty, false otherwise</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasFilter()" class="member-name-link">hasFilter</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 true is a filter has been specified, false if not</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#includeStartRow()" class="member-name-link">includeStartRow</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 if we should include start row when scan</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#includeStopRow()" class="member-name-link">includeStopRow</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 if we should include stop row when scan</div> |
| </div> |
| <div class="col-first odd-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/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAsyncPrefetch()" class="member-name-link">isAsyncPrefetch</a>()</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isGetScan()" class="member-name-link">isGetScan</a>()</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>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isNeedCursorResult()" class="member-name-link">isNeedCursorResult</a>()</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRaw()" class="member-name-link">isRaw</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 True if this Scan is in "raw" mode.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isReversed()" class="member-name-link">isReversed</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get whether this scan is a reversed one.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isScanMetricsEnabled()" class="member-name-link">isScanMetricsEnabled</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 True if collection of scan metrics is enabled.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#numFamilies()" class="member-name-link">numFamilies</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 families in familyMap</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readAllVersions()" class="member-name-link">readAllVersions</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get all available versions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readVersions(int)" class="member-name-link">readVersions</a><wbr>(int versions)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get up to the specified number of versions of each column.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetMvccReadPoint()" class="member-name-link">resetMvccReadPoint</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the mvcc read point to -1 which means do not use it.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setACL(java.lang.String,org.apache.hadoop.hbase.security.access.Permission)" class="member-name-link">setACL</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> user, |
| <a href="../security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a> perms)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the ACL for the operation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setACL(java.util.Map)" class="member-name-link">setACL</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="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>,<wbr><a href="../security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a>> perms)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the ACL for the operation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAllowPartialResults(boolean)" class="member-name-link">setAllowPartialResults</a><wbr>(boolean allowPartialResults)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Setting whether the caller wants to see the partial results when server returns |
| less-than-expected cells.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setAsyncPrefetch(boolean)" class="member-name-link">setAsyncPrefetch</a><wbr>(boolean asyncPrefetch)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAttribute(java.lang.String,byte%5B%5D)" class="member-name-link">setAttribute</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> name, |
| byte[] value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets an attribute.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAuthorizations(org.apache.hadoop.hbase.security.visibility.Authorizations)" class="member-name-link">setAuthorizations</a><wbr>(<a href="../security/visibility/Authorizations.html" title="class in org.apache.hadoop.hbase.security.visibility">Authorizations</a> authorizations)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the authorizations to be used by this Query</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBatch(int)" class="member-name-link">setBatch</a><wbr>(int batch)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the maximum number of cells to return for each call to next().</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCacheBlocks(boolean)" class="member-name-link">setCacheBlocks</a><wbr>(boolean cacheBlocks)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set whether blocks should be cached for this Scan.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCaching(int)" class="member-name-link">setCaching</a><wbr>(int caching)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the number of rows for caching that will be passed to scanners.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setColumnFamilyTimeRange(byte%5B%5D,long,long)" class="member-name-link">setColumnFamilyTimeRange</a><wbr>(byte[] cf, |
| long minStamp, |
| long maxStamp)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get versions of columns only within the specified timestamp range, [minStamp, maxStamp) on a |
| per CF bases.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setConsistency(org.apache.hadoop.hbase.client.Consistency)" class="member-name-link">setConsistency</a><wbr>(<a href="Consistency.html" title="enum class in org.apache.hadoop.hbase.client">Consistency</a> consistency)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the consistency level for this operation</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFamilyMap(java.util.Map)" class="member-name-link">setFamilyMap</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><byte[],<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/NavigableSet.html" title="class or interface in java.util" class="external-link">NavigableSet</a><byte[]>> familyMap)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Setting the familyMap</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFilter(org.apache.hadoop.hbase.filter.Filter)" class="member-name-link">setFilter</a><wbr>(<a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Apply the specified server-side filter when performing the Query.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setId(java.lang.String)" class="member-name-link">setId</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> id)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This method allows you to set an identifier on an operation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setIsolationLevel(org.apache.hadoop.hbase.client.IsolationLevel)" class="member-name-link">setIsolationLevel</a><wbr>(<a href="IsolationLevel.html" title="enum class in org.apache.hadoop.hbase.client">IsolationLevel</a> level)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the isolation level for this query.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLimit(int)" class="member-name-link">setLimit</a><wbr>(int limit)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the limit of rows for this scan.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLoadColumnFamiliesOnDemand(boolean)" class="member-name-link">setLoadColumnFamiliesOnDemand</a><wbr>(boolean value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the value indicating whether loading CFs on demand should be allowed (cluster default is |
| false).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxResultSize(long)" class="member-name-link">setMaxResultSize</a><wbr>(long maxResultSize)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the maximum result size.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxResultsPerColumnFamily(int)" class="member-name-link">setMaxResultsPerColumnFamily</a><wbr>(int limit)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the maximum number of values to return per row per Column Family</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMvccReadPoint(long)" class="member-name-link">setMvccReadPoint</a><wbr>(long mvccReadPoint)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the mvcc read point used to open a scanner.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNeedCursorResult(boolean)" class="member-name-link">setNeedCursorResult</a><wbr>(boolean needCursorResult)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">When the server is slow or we scan a table with many deleted data or we use a sparse filter, |
| the server will response heartbeat to prevent timeout.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOneRowLimit()" class="member-name-link">setOneRowLimit</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Call this when you only want to get one row.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPriority(int)" class="member-name-link">setPriority</a><wbr>(int priority)</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><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRaw(boolean)" class="member-name-link">setRaw</a><wbr>(boolean raw)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Enable/disable "raw" mode for this scan.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReadType(org.apache.hadoop.hbase.client.Scan.ReadType)" class="member-name-link">setReadType</a><wbr>(<a href="Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client">Scan.ReadType</a> readType)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the read type for this scan.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReplicaId(int)" class="member-name-link">setReplicaId</a><wbr>(int id)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specify region replica id where Query will fetch data from.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReversed(boolean)" class="member-name-link">setReversed</a><wbr>(boolean reversed)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set whether this scan is a reversed one</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRowOffsetPerColumnFamily(int)" class="member-name-link">setRowOffsetPerColumnFamily</a><wbr>(int offset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set offset for the row per Column Family.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setScanMetricsEnabled(boolean)" class="member-name-link">setScanMetricsEnabled</a><wbr>(boolean enabled)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Enable collection of <a href="metrics/ScanMetrics.html" title="class in org.apache.hadoop.hbase.client.metrics"><code>ScanMetrics</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStartStopRowForPrefixScan(byte%5B%5D)" class="member-name-link">setStartStopRowForPrefixScan</a><wbr>(byte[] rowPrefix)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block"> |
| Set a filter (using stopRow and startRow) so the result set only contains rows where the rowKey |
| starts with the specified prefix.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTimeRange(long,long)" class="member-name-link">setTimeRange</a><wbr>(long minStamp, |
| long maxStamp)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get versions of columns only within the specified timestamp range, [minStamp, maxStamp).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTimestamp(long)" class="member-name-link">setTimestamp</a><wbr>(long timestamp)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get versions of columns with the specified timestamp.</div> |
| </div> |
| <div class="col-first odd-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/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toJSON()" class="member-name-link">toJSON</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Produces a JSON object sufficient for description of a query in a debugging or logging context.</div> |
| </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/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toJSON(int)" class="member-name-link">toJSON</a><wbr>(int maxCols)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Produces a JSON object for fingerprint and details exposure in a parseable format.</div> |
| </div> |
| <div class="col-first odd-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/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<wbr><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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toMap()" class="member-name-link">toMap</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Produces a Map containing a full summary of a query.</div> |
| </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/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<wbr><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>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toMap(int)" class="member-name-link">toMap</a><wbr>(int maxCols)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compile the details beyond the scope of getFingerprint (row, columns, timestamps, etc.) into a |
| Map along with the fingerprinted information.</div> |
| </div> |
| <div class="col-first odd-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/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Produces a string representation of this Operation.</div> |
| </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/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString(int)" class="member-name-link">toString</a><wbr>(int maxCols)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Produces a string representation of this Operation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withStartRow(byte%5B%5D)" class="member-name-link">withStartRow</a><wbr>(byte[] startRow)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the start row of the scan.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withStartRow(byte%5B%5D,boolean)" class="member-name-link">withStartRow</a><wbr>(byte[] startRow, |
| boolean inclusive)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the start row of the scan.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withStopRow(byte%5B%5D)" class="member-name-link">withStopRow</a><wbr>(byte[] stopRow)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the stop row of the scan.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withStopRow(byte%5B%5D,boolean)" class="member-name-link">withStopRow</a><wbr>(byte[] stopRow, |
| boolean inclusive)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the stop row of the scan.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.client.Scan">Methods inherited from class org.apache.hadoop.hbase.client.<a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></h3> |
| <code><a href="Scan.html#createScanFromCursor(org.apache.hadoop.hbase.client.Cursor)">createScanFromCursor</a>, <a href="Scan.html#setRowPrefixFilter(byte%5B%5D)">setRowPrefixFilter</a></code></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#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="delegateScan"> |
| <h3>delegateScan</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-38">delegateScan</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.Scan)"> |
| <h3>ImmutableScan</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-44">ImmutableScan</a></span><wbr><span class="parameters">(<a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)</span></div> |
| <div class="block">Create Immutable instance of Scan from given Scan object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>scan</code> - Copy all values from Scan</dd> |
| </dl> |
| </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="addFamily(byte[])"> |
| <h3>addFamily</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-48">addFamily</a></span><wbr><span class="parameters">(byte[] family)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#addFamily(byte%5B%5D)">Scan</a></code></span></div> |
| <div class="block">Get all columns from the specified family. |
| <p> |
| Overrides previous calls to addColumn for this family.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#addFamily(byte%5B%5D)">addFamily</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>family</code> - family name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addColumn(byte[],byte[])"> |
| <h3>addColumn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-53">addColumn</a></span><wbr><span class="parameters">(byte[] family, |
| byte[] qualifier)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#addColumn(byte%5B%5D,byte%5B%5D)">Scan</a></code></span></div> |
| <div class="block">Get the column from the specified family with the specified qualifier. |
| <p> |
| Overrides previous calls to addFamily for this family.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#addColumn(byte%5B%5D,byte%5B%5D)">addColumn</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>family</code> - family name</dd> |
| <dd><code>qualifier</code> - column qualifier</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTimeRange(long,long)"> |
| <h3>setTimeRange</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-58">setTimeRange</a></span><wbr><span class="parameters">(long minStamp, |
| long maxStamp)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setTimeRange(long,long)">Scan</a></code></span></div> |
| <div class="block">Get versions of columns only within the specified timestamp range, [minStamp, maxStamp). Note, |
| default maximum versions to return is 1. If your time range spans more than one version and you |
| want all versions returned, up the number of versions beyond the default.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setTimeRange(long,long)">setTimeRange</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>minStamp</code> - minimum timestamp value, inclusive</dd> |
| <dd><code>maxStamp</code> - maximum timestamp value, exclusive</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="Scan.html#readAllVersions()"><code>Scan.readAllVersions()</code></a></li> |
| <li><a href="Scan.html#readVersions(int)"><code>Scan.readVersions(int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTimestamp(long)"> |
| <h3>setTimestamp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-63">setTimestamp</a></span><wbr><span class="parameters">(long timestamp)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setTimestamp(long)">Scan</a></code></span></div> |
| <div class="block">Get versions of columns with the specified timestamp. Note, default maximum versions to return |
| is 1. If your time range spans more than one version and you want all versions returned, up the |
| number of versions beyond the defaut.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setTimestamp(long)">setTimestamp</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>timestamp</code> - version timestamp</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="Scan.html#readAllVersions()"><code>Scan.readAllVersions()</code></a></li> |
| <li><a href="Scan.html#readVersions(int)"><code>Scan.readVersions(int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setColumnFamilyTimeRange(byte[],long,long)"> |
| <h3>setColumnFamilyTimeRange</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-68">setColumnFamilyTimeRange</a></span><wbr><span class="parameters">(byte[] cf, |
| long minStamp, |
| long maxStamp)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#setColumnFamilyTimeRange(byte%5B%5D,long,long)">Query</a></code></span></div> |
| <div class="block">Get versions of columns only within the specified timestamp range, [minStamp, maxStamp) on a |
| per CF bases. Note, default maximum versions to return is 1. If your time range spans more than |
| one version and you want all versions returned, up the number of versions beyond the default. |
| Column Family time ranges take precedence over the global time range.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setColumnFamilyTimeRange(byte%5B%5D,long,long)">setColumnFamilyTimeRange</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>cf</code> - the column family for which you want to restrict</dd> |
| <dd><code>minStamp</code> - minimum timestamp value, inclusive</dd> |
| <dd><code>maxStamp</code> - maximum timestamp value, exclusive</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withStartRow(byte[])"> |
| <h3>withStartRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-74">withStartRow</a></span><wbr><span class="parameters">(byte[] startRow)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#withStartRow(byte%5B%5D)">Scan</a></code></span></div> |
| <div class="block">Set the start row of the scan. |
| <p> |
| If the specified row does not exist, the Scanner will start from the next closest row after the |
| specified row. |
| <p> |
| <b>Note:</b> <strong>Do NOT use this in combination with <a href="Scan.html#setRowPrefixFilter(byte%5B%5D)"><code>Scan.setRowPrefixFilter(byte[])</code></a> or |
| <a href="Scan.html#setStartStopRowForPrefixScan(byte%5B%5D)"><code>Scan.setStartStopRowForPrefixScan(byte[])</code></a>.</strong> Doing so will make the scan result |
| unexpected or even undefined. |
| </p></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#withStartRow(byte%5B%5D)">withStartRow</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>startRow</code> - row to start scanner at or after</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withStartRow(byte[],boolean)"> |
| <h3>withStartRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-79">withStartRow</a></span><wbr><span class="parameters">(byte[] startRow, |
| boolean inclusive)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#withStartRow(byte%5B%5D,boolean)">Scan</a></code></span></div> |
| <div class="block">Set the start row of the scan. |
| <p> |
| If the specified row does not exist, or the <code>inclusive</code> is <code>false</code>, the Scanner |
| will start from the next closest row after the specified row. |
| <p> |
| <b>Note:</b> <strong>Do NOT use this in combination with <a href="Scan.html#setRowPrefixFilter(byte%5B%5D)"><code>Scan.setRowPrefixFilter(byte[])</code></a> or |
| <a href="Scan.html#setStartStopRowForPrefixScan(byte%5B%5D)"><code>Scan.setStartStopRowForPrefixScan(byte[])</code></a>.</strong> Doing so will make the scan result |
| unexpected or even undefined. |
| </p></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#withStartRow(byte%5B%5D,boolean)">withStartRow</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>startRow</code> - row to start scanner at or after</dd> |
| <dd><code>inclusive</code> - whether we should include the start row when scan</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withStopRow(byte[])"> |
| <h3>withStopRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-84">withStopRow</a></span><wbr><span class="parameters">(byte[] stopRow)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#withStopRow(byte%5B%5D)">Scan</a></code></span></div> |
| <div class="block">Set the stop row of the scan. |
| <p> |
| The scan will include rows that are lexicographically less than the provided stopRow. |
| <p> |
| <b>Note:</b> <strong>Do NOT use this in combination with <a href="Scan.html#setRowPrefixFilter(byte%5B%5D)"><code>Scan.setRowPrefixFilter(byte[])</code></a> or |
| <a href="Scan.html#setStartStopRowForPrefixScan(byte%5B%5D)"><code>Scan.setStartStopRowForPrefixScan(byte[])</code></a>.</strong> Doing so will make the scan result |
| unexpected or even undefined. |
| </p></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#withStopRow(byte%5B%5D)">withStopRow</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>stopRow</code> - row to end at (exclusive)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withStopRow(byte[],boolean)"> |
| <h3>withStopRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-89">withStopRow</a></span><wbr><span class="parameters">(byte[] stopRow, |
| boolean inclusive)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#withStopRow(byte%5B%5D,boolean)">Scan</a></code></span></div> |
| <div class="block">Set the stop row of the scan. |
| <p> |
| The scan will include rows that are lexicographically less than (or equal to if |
| <code>inclusive</code> is <code>true</code>) the provided stopRow. |
| <p> |
| <b>Note:</b> <strong>Do NOT use this in combination with <a href="Scan.html#setRowPrefixFilter(byte%5B%5D)"><code>Scan.setRowPrefixFilter(byte[])</code></a> or |
| <a href="Scan.html#setStartStopRowForPrefixScan(byte%5B%5D)"><code>Scan.setStartStopRowForPrefixScan(byte[])</code></a>.</strong> Doing so will make the scan result |
| unexpected or even undefined. |
| </p></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#withStopRow(byte%5B%5D,boolean)">withStopRow</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>stopRow</code> - row to end at</dd> |
| <dd><code>inclusive</code> - whether we should include the stop row when scan</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStartStopRowForPrefixScan(byte[])"> |
| <h3>setStartStopRowForPrefixScan</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-94">setStartStopRowForPrefixScan</a></span><wbr><span class="parameters">(byte[] rowPrefix)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setStartStopRowForPrefixScan(byte%5B%5D)">Scan</a></code></span></div> |
| <div class="block"><p> |
| Set a filter (using stopRow and startRow) so the result set only contains rows where the rowKey |
| starts with the specified prefix. |
| </p> |
| <p> |
| This is a utility method that converts the desired rowPrefix into the appropriate values for |
| the startRow and stopRow to achieve the desired result. |
| </p> |
| <p> |
| This can safely be used in combination with setFilter. |
| </p> |
| <p> |
| <strong>This CANNOT be used in combination with withStartRow and/or withStopRow.</strong> Such |
| a combination will yield unexpected and even undefined results. |
| </p></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setStartStopRowForPrefixScan(byte%5B%5D)">setStartStopRowForPrefixScan</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>rowPrefix</code> - the prefix all rows must start with. (Set <i>null</i> to remove the filter.)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readAllVersions()"> |
| <h3>readAllVersions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-100">readAllVersions</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#readAllVersions()">Scan</a></code></span></div> |
| <div class="block">Get all available versions.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#readAllVersions()">readAllVersions</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readVersions(int)"> |
| <h3>readVersions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-106">readVersions</a></span><wbr><span class="parameters">(int versions)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#readVersions(int)">Scan</a></code></span></div> |
| <div class="block">Get up to the specified number of versions of each column.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#readVersions(int)">readVersions</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>versions</code> - specified number of versions for each column</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBatch(int)"> |
| <h3>setBatch</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-111">setBatch</a></span><wbr><span class="parameters">(int batch)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setBatch(int)">Scan</a></code></span></div> |
| <div class="block">Set the maximum number of cells to return for each call to next(). Callers should be aware that |
| this is not equivalent to calling <a href="Scan.html#setAllowPartialResults(boolean)"><code>Scan.setAllowPartialResults(boolean)</code></a>. If you don't allow |
| partial results, the number of cells in each Result must equal to your batch setting unless it |
| is the last Result for current row. So this method is helpful in paging queries. If you just |
| want to prevent OOM at client, use setAllowPartialResults(true) is better.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setBatch(int)">setBatch</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>batch</code> - the maximum number of values</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="Result.html#mayHaveMoreCellsInRow()"><code>Result.mayHaveMoreCellsInRow()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMaxResultsPerColumnFamily(int)"> |
| <h3>setMaxResultsPerColumnFamily</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-116">setMaxResultsPerColumnFamily</a></span><wbr><span class="parameters">(int limit)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setMaxResultsPerColumnFamily(int)">Scan</a></code></span></div> |
| <div class="block">Set the maximum number of values to return per row per Column Family</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setMaxResultsPerColumnFamily(int)">setMaxResultsPerColumnFamily</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>limit</code> - the maximum number of values returned / row / CF</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRowOffsetPerColumnFamily(int)"> |
| <h3>setRowOffsetPerColumnFamily</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-122">setRowOffsetPerColumnFamily</a></span><wbr><span class="parameters">(int offset)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setRowOffsetPerColumnFamily(int)">Scan</a></code></span></div> |
| <div class="block">Set offset for the row per Column Family.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setRowOffsetPerColumnFamily(int)">setRowOffsetPerColumnFamily</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>offset</code> - is the number of kvs that will be skipped.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCaching(int)"> |
| <h3>setCaching</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-128">setCaching</a></span><wbr><span class="parameters">(int caching)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setCaching(int)">Scan</a></code></span></div> |
| <div class="block">Set the number of rows for caching that will be passed to scanners. If not set, the |
| Configuration setting <a href="../HConstants.html#HBASE_CLIENT_SCANNER_CACHING"><code>HConstants.HBASE_CLIENT_SCANNER_CACHING</code></a> will apply. Higher |
| caching values will enable faster scanners but will use more memory.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setCaching(int)">setCaching</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>caching</code> - the number of rows for caching</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMaxResultSize(long)"> |
| <h3>setMaxResultSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-133">setMaxResultSize</a></span><wbr><span class="parameters">(long maxResultSize)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setMaxResultSize(long)">Scan</a></code></span></div> |
| <div class="block">Set the maximum result size. The default is -1; this means that no specific maximum result size |
| will be set for this scan, and the global configured value will be used instead. (Defaults to |
| unlimited).</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setMaxResultSize(long)">setMaxResultSize</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>maxResultSize</code> - The maximum result size in bytes.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFilter(org.apache.hadoop.hbase.filter.Filter)"> |
| <h3>setFilter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-139">setFilter</a></span><wbr><span class="parameters">(<a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#setFilter(org.apache.hadoop.hbase.filter.Filter)">Query</a></code></span></div> |
| <div class="block">Apply the specified server-side filter when performing the Query. Only |
| <a href="../filter/Filter.html#filterCell(org.apache.hadoop.hbase.Cell)"><code>Filter.filterCell(org.apache.hadoop.hbase.Cell)</code></a> is called AFTER all tests for ttl, |
| column match, deletes and column family's max versions have been run.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setFilter(org.apache.hadoop.hbase.filter.Filter)">setFilter</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>filter</code> - filter to run on the server</dd> |
| <dt>Returns:</dt> |
| <dd>this for invocation chaining</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFamilyMap(java.util.Map)"> |
| <h3>setFamilyMap</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-144">setFamilyMap</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><byte[],<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/NavigableSet.html" title="class or interface in java.util" class="external-link">NavigableSet</a><byte[]>> familyMap)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setFamilyMap(java.util.Map)">Scan</a></code></span></div> |
| <div class="block">Setting the familyMap</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setFamilyMap(java.util.Map)">setFamilyMap</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>familyMap</code> - map of family to qualifier</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCacheBlocks(boolean)"> |
| <h3>setCacheBlocks</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-149">setCacheBlocks</a></span><wbr><span class="parameters">(boolean cacheBlocks)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setCacheBlocks(boolean)">Scan</a></code></span></div> |
| <div class="block">Set whether blocks should be cached for this Scan. |
| <p> |
| This is true by default. When true, default settings of the table and family are used (this |
| will never override caching blocks if the block cache is disabled for that family or entirely).</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setCacheBlocks(boolean)">setCacheBlocks</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>cacheBlocks</code> - if false, default settings are overridden and blocks will not be cached</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setReversed(boolean)"> |
| <h3>setReversed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-155">setReversed</a></span><wbr><span class="parameters">(boolean reversed)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setReversed(boolean)">Scan</a></code></span></div> |
| <div class="block">Set whether this scan is a reversed one |
| <p> |
| This is false by default which means forward(normal) scan.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setReversed(boolean)">setReversed</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>reversed</code> - if true, scan will be backward order</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAllowPartialResults(boolean)"> |
| <h3>setAllowPartialResults</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-160">setAllowPartialResults</a></span><wbr><span class="parameters">(boolean allowPartialResults)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setAllowPartialResults(boolean)">Scan</a></code></span></div> |
| <div class="block">Setting whether the caller wants to see the partial results when server returns |
| less-than-expected cells. It is helpful while scanning a huge row to prevent OOM at client. By |
| default this value is false and the complete results will be assembled client side before being |
| delivered to the caller.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setAllowPartialResults(boolean)">setAllowPartialResults</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="Result.html#mayHaveMoreCellsInRow()"><code>Result.mayHaveMoreCellsInRow()</code></a></li> |
| <li><a href="Scan.html#setBatch(int)"><code>Scan.setBatch(int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLoadColumnFamiliesOnDemand(boolean)"> |
| <h3>setLoadColumnFamiliesOnDemand</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-166">setLoadColumnFamiliesOnDemand</a></span><wbr><span class="parameters">(boolean value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#setLoadColumnFamiliesOnDemand(boolean)">Query</a></code></span></div> |
| <div class="block">Set the value indicating whether loading CFs on demand should be allowed (cluster default is |
| false). On-demand CF loading doesn't load column families until necessary, e.g. if you filter |
| on one column, the other column family data will be loaded only for the rows that are included |
| in result, not all rows like in normal case. With column-specific filters, like |
| SingleColumnValueFilter w/filterIfMissing == true, this can deliver huge perf gains when |
| there's a cf with lots of data; however, it can also lead to some inconsistent results, as |
| follows: - if someone does a concurrent update to both column families in question you may get |
| a row that never existed, e.g. for { rowKey = 5, { cat_videos => 1 }, { video => "my cat" |
| } } someone puts rowKey 5 with { cat_videos => 0 }, { video => "my dog" }, concurrent |
| scan filtering on "cat_videos == 1" can get { rowKey = 5, { cat_videos => 1 }, { video => |
| "my dog" } }. - if there's a concurrent split and you have more than 2 column families, some |
| rows may be missing some column families.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setLoadColumnFamiliesOnDemand(boolean)">setLoadColumnFamiliesOnDemand</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRaw(boolean)"> |
| <h3>setRaw</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-172">setRaw</a></span><wbr><span class="parameters">(boolean raw)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setRaw(boolean)">Scan</a></code></span></div> |
| <div class="block">Enable/disable "raw" mode for this scan. If "raw" is enabled the scan will return all delete |
| marker and deleted rows that have not been collected, yet. This is mostly useful for Scan on |
| column families that have KEEP_DELETED_ROWS enabled. It is an error to specify any column when |
| "raw" is set.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setRaw(boolean)">setRaw</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>raw</code> - True/False to enable/disable "raw" mode.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAttribute(java.lang.String,byte[])"> |
| <h3>setAttribute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-177">setAttribute</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> name, |
| byte[] value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Attributes.html#setAttribute(java.lang.String,byte%5B%5D)">Attributes</a></code></span></div> |
| <div class="block">Sets an attribute. In case value = null attribute is removed from the attributes map. Attribute |
| names starting with _ indicate system attributes.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Attributes.html#setAttribute(java.lang.String,byte%5B%5D)">setAttribute</a></code> in interface <code><a href="Attributes.html" title="interface in org.apache.hadoop.hbase.client">Attributes</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setAttribute(java.lang.String,byte%5B%5D)">setAttribute</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - attribute name</dd> |
| <dd><code>value</code> - attribute value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setId(java.lang.String)"> |
| <h3>setId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-182">setId</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> id)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="OperationWithAttributes.html#setId(java.lang.String)">OperationWithAttributes</a></code></span></div> |
| <div class="block">This method allows you to set an identifier on an operation. The original motivation for this |
| was to allow the identifier to be used in slow query logging, but this could obviously be |
| useful in other places. One use of this could be to put a class.method identifier in here to |
| see where the slow query is coming from. id to set for the scan</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setId(java.lang.String)">setId</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAuthorizations(org.apache.hadoop.hbase.security.visibility.Authorizations)"> |
| <h3>setAuthorizations</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-187">setAuthorizations</a></span><wbr><span class="parameters">(<a href="../security/visibility/Authorizations.html" title="class in org.apache.hadoop.hbase.security.visibility">Authorizations</a> authorizations)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#setAuthorizations(org.apache.hadoop.hbase.security.visibility.Authorizations)">Query</a></code></span></div> |
| <div class="block">Sets the authorizations to be used by this Query</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setAuthorizations(org.apache.hadoop.hbase.security.visibility.Authorizations)">setAuthorizations</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setACL(java.util.Map)"> |
| <h3>setACL</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-193">setACL</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="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>,<wbr><a href="../security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a>> perms)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#setACL(java.util.Map)">Query</a></code></span></div> |
| <div class="block">Set the ACL for the operation.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setACL(java.util.Map)">setACL</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>perms</code> - A map of permissions for a user or users</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setACL(java.lang.String,org.apache.hadoop.hbase.security.access.Permission)"> |
| <h3>setACL</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-198">setACL</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> user, |
| <a href="../security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a> perms)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#setACL(java.lang.String,org.apache.hadoop.hbase.security.access.Permission)">Query</a></code></span></div> |
| <div class="block">Set the ACL for the operation.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setACL(java.lang.String,org.apache.hadoop.hbase.security.access.Permission)">setACL</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>user</code> - User short name</dd> |
| <dd><code>perms</code> - Permissions for the user</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setConsistency(org.apache.hadoop.hbase.client.Consistency)"> |
| <h3>setConsistency</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-203">setConsistency</a></span><wbr><span class="parameters">(<a href="Consistency.html" title="enum class in org.apache.hadoop.hbase.client">Consistency</a> consistency)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#setConsistency(org.apache.hadoop.hbase.client.Consistency)">Query</a></code></span></div> |
| <div class="block">Sets the consistency level for this operation</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setConsistency(org.apache.hadoop.hbase.client.Consistency)">setConsistency</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>consistency</code> - the consistency level</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setReplicaId(int)"> |
| <h3>setReplicaId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-209">setReplicaId</a></span><wbr><span class="parameters">(int id)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#setReplicaId(int)">Query</a></code></span></div> |
| <div class="block">Specify region replica id where Query will fetch data from. Use this together with |
| <a href="Query.html#setConsistency(org.apache.hadoop.hbase.client.Consistency)"><code>Query.setConsistency(Consistency)</code></a> passing <a href="Consistency.html#TIMELINE"><code>Consistency.TIMELINE</code></a> to read data from a |
| specific replicaId. <br> |
| <b> Expert: </b>This is an advanced API exposed. Only use it if you know what you are doing</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setReplicaId(int)">setReplicaId</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setIsolationLevel(org.apache.hadoop.hbase.client.IsolationLevel)"> |
| <h3>setIsolationLevel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-214">setIsolationLevel</a></span><wbr><span class="parameters">(<a href="IsolationLevel.html" title="enum class in org.apache.hadoop.hbase.client">IsolationLevel</a> level)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#setIsolationLevel(org.apache.hadoop.hbase.client.IsolationLevel)">Query</a></code></span></div> |
| <div class="block">Set the isolation level for this query. If the isolation level is set to READ_UNCOMMITTED, then |
| this query will return data from committed and uncommitted transactions. If the isolation level |
| is set to READ_COMMITTED, then this query will return data from committed transactions only. If |
| a isolation level is not explicitly set on a Query, then it is assumed to be READ_COMMITTED.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setIsolationLevel(org.apache.hadoop.hbase.client.IsolationLevel)">setIsolationLevel</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>level</code> - IsolationLevel for this query</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPriority(int)"> |
| <h3>setPriority</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-220">setPriority</a></span><wbr><span class="parameters">(int priority)</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setPriority(int)">setPriority</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setScanMetricsEnabled(boolean)"> |
| <h3>setScanMetricsEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-225">setScanMetricsEnabled</a></span><wbr><span class="parameters">(boolean enabled)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setScanMetricsEnabled(boolean)">Scan</a></code></span></div> |
| <div class="block">Enable collection of <a href="metrics/ScanMetrics.html" title="class in org.apache.hadoop.hbase.client.metrics"><code>ScanMetrics</code></a>. For advanced users.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setScanMetricsEnabled(boolean)">setScanMetricsEnabled</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>enabled</code> - Set to true to enable accumulating scan metrics</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAsyncPrefetch(boolean)"> |
| <h3>setAsyncPrefetch</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-231">setAsyncPrefetch</a></span><wbr><span class="parameters">(boolean asyncPrefetch)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setAsyncPrefetch(boolean)">setAsyncPrefetch</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLimit(int)"> |
| <h3>setLimit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-238">setLimit</a></span><wbr><span class="parameters">(int limit)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setLimit(int)">Scan</a></code></span></div> |
| <div class="block">Set the limit of rows for this scan. We will terminate the scan if the number of returned rows |
| reaches this value. |
| <p> |
| This condition will be tested at last, after all other conditions such as stopRow, filter, etc.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setLimit(int)">setLimit</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>limit</code> - the limit of rows for this scan</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setOneRowLimit()"> |
| <h3>setOneRowLimit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-243">setOneRowLimit</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setOneRowLimit()">Scan</a></code></span></div> |
| <div class="block">Call this when you only want to get one row. It will set <code>limit</code> to <code>1</code>, and also |
| set <code>readType</code> to <a href="Scan.ReadType.html#PREAD"><code>Scan.ReadType.PREAD</code></a>.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setOneRowLimit()">setOneRowLimit</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setReadType(org.apache.hadoop.hbase.client.Scan.ReadType)"> |
| <h3>setReadType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-249">setReadType</a></span><wbr><span class="parameters">(<a href="Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client">Scan.ReadType</a> readType)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setReadType(org.apache.hadoop.hbase.client.Scan.ReadType)">Scan</a></code></span></div> |
| <div class="block">Set the read type for this scan. |
| <p> |
| Notice that we may choose to use pread even if you specific <a href="Scan.ReadType.html#STREAM"><code>Scan.ReadType.STREAM</code></a> here. For |
| example, we will always use pread if this is a get scan.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setReadType(org.apache.hadoop.hbase.client.Scan.ReadType)">setReadType</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMvccReadPoint(long)"> |
| <h3>setMvccReadPoint</h3> |
| <div class="member-signature"><span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-254">setMvccReadPoint</a></span><wbr><span class="parameters">(long mvccReadPoint)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setMvccReadPoint(long)">Scan</a></code></span></div> |
| <div class="block">Set the mvcc read point used to open a scanner.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setMvccReadPoint(long)">setMvccReadPoint</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="resetMvccReadPoint()"> |
| <h3>resetMvccReadPoint</h3> |
| <div class="member-signature"><span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-260">resetMvccReadPoint</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#resetMvccReadPoint()">Scan</a></code></span></div> |
| <div class="block">Set the mvcc read point to -1 which means do not use it.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#resetMvccReadPoint()">resetMvccReadPoint</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setNeedCursorResult(boolean)"> |
| <h3>setNeedCursorResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-266">setNeedCursorResult</a></span><wbr><span class="parameters">(boolean needCursorResult)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#setNeedCursorResult(boolean)">Scan</a></code></span></div> |
| <div class="block">When the server is slow or we scan a table with many deleted data or we use a sparse filter, |
| the server will response heartbeat to prevent timeout. However the scanner will return a Result |
| only when client can do it. So if there are many heartbeats, the blocking time on |
| ResultScanner#next() may be very long, which is not friendly to online services. Set this to |
| true then you can get a special Result whose #isCursor() returns true and is not contains any |
| real data. It only tells you where the server has scanned. You can call next to continue |
| scanning or open a new scanner with this row key as start row whenever you want. Users can get |
| a cursor when and only when there is a response from the server but we can not return a Result |
| to users, for example, this response is a heartbeat or there are partial cells but users do not |
| allow partial result. Now the cursor is in row level which means the special Result will only |
| contains a row key. <a href="Result.html#isCursor()"><code>Result.isCursor()</code></a> <a href="Result.html#getCursor()"><code>Result.getCursor()</code></a> <a href="Cursor.html" title="class in org.apache.hadoop.hbase.client"><code>Cursor</code></a></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#setNeedCursorResult(boolean)">setNeedCursorResult</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxResultSize()"> |
| <h3>getMaxResultSize</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/client/ImmutableScan.html#line-272">getMaxResultSize</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getMaxResultSize()">Scan</a></code></span></div> |
| <div class="block">Returns the maximum result size in bytes. See <a href="Scan.html#setMaxResultSize(long)"><code>Scan.setMaxResultSize(long)</code></a></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getMaxResultSize()">getMaxResultSize</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFamilyMap()"> |
| <h3>getFamilyMap</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/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><byte[],<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/NavigableSet.html" title="class or interface in java.util" class="external-link">NavigableSet</a><byte[]>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-277">getFamilyMap</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getFamilyMap()">Scan</a></code></span></div> |
| <div class="block">Getting the familyMap</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getFamilyMap()">getFamilyMap</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="numFamilies()"> |
| <h3>numFamilies</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-282">numFamilies</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#numFamilies()">Scan</a></code></span></div> |
| <div class="block">Returns the number of families in familyMap</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#numFamilies()">numFamilies</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasFamilies()"> |
| <h3>hasFamilies</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-287">hasFamilies</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#hasFamilies()">Scan</a></code></span></div> |
| <div class="block">Returns true if familyMap is non empty, false otherwise</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#hasFamilies()">hasFamilies</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFamilies()"> |
| <h3>getFamilies</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[][]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-292">getFamilies</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getFamilies()">Scan</a></code></span></div> |
| <div class="block">Returns the keys of the familyMap</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getFamilies()">getFamilies</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStartRow()"> |
| <h3>getStartRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-302">getStartRow</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getStartRow()">Scan</a></code></span></div> |
| <div class="block">Returns the startrow</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getStartRow()">getStartRow</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="includeStartRow()"> |
| <h3>includeStartRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-308">includeStartRow</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#includeStartRow()">Scan</a></code></span></div> |
| <div class="block">Returns if we should include start row when scan</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#includeStartRow()">includeStartRow</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStopRow()"> |
| <h3>getStopRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-313">getStopRow</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getStopRow()">Scan</a></code></span></div> |
| <div class="block">Returns the stoprow</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getStopRow()">getStopRow</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="includeStopRow()"> |
| <h3>includeStopRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-319">includeStopRow</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#includeStopRow()">Scan</a></code></span></div> |
| <div class="block">Returns if we should include stop row when scan</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#includeStopRow()">includeStopRow</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxVersions()"> |
| <h3>getMaxVersions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-324">getMaxVersions</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getMaxVersions()">Scan</a></code></span></div> |
| <div class="block">Returns the max number of versions to fetch</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getMaxVersions()">getMaxVersions</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBatch()"> |
| <h3>getBatch</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-329">getBatch</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getBatch()">Scan</a></code></span></div> |
| <div class="block">Returns maximum number of values to return for a single call to next()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getBatch()">getBatch</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxResultsPerColumnFamily()"> |
| <h3>getMaxResultsPerColumnFamily</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-334">getMaxResultsPerColumnFamily</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getMaxResultsPerColumnFamily()">Scan</a></code></span></div> |
| <div class="block">Returns maximum number of values to return per row per CF</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getMaxResultsPerColumnFamily()">getMaxResultsPerColumnFamily</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRowOffsetPerColumnFamily()"> |
| <h3>getRowOffsetPerColumnFamily</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-339">getRowOffsetPerColumnFamily</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getRowOffsetPerColumnFamily()">Scan</a></code></span></div> |
| <div class="block">Method for retrieving the scan's offset per row per column family (#kvs to be skipped)</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getRowOffsetPerColumnFamily()">getRowOffsetPerColumnFamily</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>row offset</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCaching()"> |
| <h3>getCaching</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-344">getCaching</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getCaching()">Scan</a></code></span></div> |
| <div class="block">Returns caching the number of rows fetched when calling next on a scanner</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getCaching()">getCaching</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTimeRange()"> |
| <h3>getTimeRange</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-349">getTimeRange</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getTimeRange()">Scan</a></code></span></div> |
| <div class="block">Returns TimeRange</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getTimeRange()">getTimeRange</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFilter()"> |
| <h3>getFilter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-354">getFilter</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getFilter()">Scan</a></code></span></div> |
| <div class="block">Returns RowFilter</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getFilter()">getFilter</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasFilter()"> |
| <h3>hasFilter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-359">hasFilter</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#hasFilter()">Scan</a></code></span></div> |
| <div class="block">Returns true is a filter has been specified, false if not</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#hasFilter()">hasFilter</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCacheBlocks()"> |
| <h3>getCacheBlocks</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-364">getCacheBlocks</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getCacheBlocks()">Scan</a></code></span></div> |
| <div class="block">Get whether blocks should be cached for this Scan.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getCacheBlocks()">getCacheBlocks</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if default caching should be used, false if blocks should not be cached</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isReversed()"> |
| <h3>isReversed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-369">isReversed</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#isReversed()">Scan</a></code></span></div> |
| <div class="block">Get whether this scan is a reversed one.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#isReversed()">isReversed</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if backward scan, false if forward(default) scan</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAllowPartialResults()"> |
| <h3>getAllowPartialResults</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-374">getAllowPartialResults</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getAllowPartialResults()">Scan</a></code></span></div> |
| <div class="block">Returns true when the constructor of this scan understands that the results they will see may |
| only represent a partial portion of a row. The entire row would be retrieved by subsequent |
| calls to <a href="ResultScanner.html#next()"><code>ResultScanner.next()</code></a></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getAllowPartialResults()">getAllowPartialResults</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getACL()"> |
| <h3>getACL</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-379">getACL</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#getACL()">Query</a></code></span></div> |
| <div class="block">Returns The serialized ACL for this operation, or null if none</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Query.html#getACL()">getACL</a></code> in class <code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFingerprint()"> |
| <h3>getFingerprint</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/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<wbr><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>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-385">getFingerprint</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getFingerprint()">Scan</a></code></span></div> |
| <div class="block">Compile the table and column family (i.e. schema) information into a String. Useful for parsing |
| and aggregation by debugging, logging, and administration tools.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getFingerprint()">getFingerprint</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a map containing fingerprint information (i.e. column families)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toMap(int)"> |
| <h3>toMap</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/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<wbr><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>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-390">toMap</a></span><wbr><span class="parameters">(int maxCols)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#toMap(int)">Scan</a></code></span></div> |
| <div class="block">Compile the details beyond the scope of getFingerprint (row, columns, timestamps, etc.) into a |
| Map along with the fingerprinted information. Useful for debugging, logging, and administration |
| tools.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#toMap(int)">toMap</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>maxCols</code> - a limit on the number of columns output prior to truncation</dd> |
| <dt>Returns:</dt> |
| <dd>a map containing parameters of a query (i.e. rows, columns...)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRaw()"> |
| <h3>isRaw</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-395">isRaw</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#isRaw()">Scan</a></code></span></div> |
| <div class="block">Returns True if this Scan is in "raw" mode.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#isRaw()">isRaw</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isScanMetricsEnabled()"> |
| <h3>isScanMetricsEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-400">isScanMetricsEnabled</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#isScanMetricsEnabled()">Scan</a></code></span></div> |
| <div class="block">Returns True if collection of scan metrics is enabled. For advanced users.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#isScanMetricsEnabled()">isScanMetricsEnabled</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isAsyncPrefetch()"> |
| <h3>isAsyncPrefetch</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/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-405">isAsyncPrefetch</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#isAsyncPrefetch()">isAsyncPrefetch</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLimit()"> |
| <h3>getLimit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-410">getLimit</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getLimit()">Scan</a></code></span></div> |
| <div class="block">Returns the limit of rows for this scan</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getLimit()">getLimit</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReadType()"> |
| <h3>getReadType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client">Scan.ReadType</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-415">getReadType</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getReadType()">Scan</a></code></span></div> |
| <div class="block">Returns the read type for this scan</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getReadType()">getReadType</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMvccReadPoint()"> |
| <h3>getMvccReadPoint</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-420">getMvccReadPoint</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Scan.html#getMvccReadPoint()">Scan</a></code></span></div> |
| <div class="block">Get the mvcc read point used to open a scanner.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#getMvccReadPoint()">getMvccReadPoint</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isNeedCursorResult()"> |
| <h3>isNeedCursorResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-425">isNeedCursorResult</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#isNeedCursorResult()">isNeedCursorResult</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAttribute(java.lang.String)"> |
| <h3>getAttribute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-430">getAttribute</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> name)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Attributes.html#getAttribute(java.lang.String)">Attributes</a></code></span></div> |
| <div class="block">Gets an attribute</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Attributes.html#getAttribute(java.lang.String)">getAttribute</a></code> in interface <code><a href="Attributes.html" title="interface in org.apache.hadoop.hbase.client">Attributes</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="OperationWithAttributes.html#getAttribute(java.lang.String)">getAttribute</a></code> in class <code><a href="OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">OperationWithAttributes</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - attribute name</dd> |
| <dt>Returns:</dt> |
| <dd>attribute value if attribute is set, <tt>null</tt> otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConsistency()"> |
| <h3>getConsistency</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Consistency.html" title="enum class in org.apache.hadoop.hbase.client">Consistency</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-436">getConsistency</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#getConsistency()">Query</a></code></span></div> |
| <div class="block">Returns the consistency level for this operation</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Query.html#getConsistency()">getConsistency</a></code> in class <code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the consistency level</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAttributeSize()"> |
| <h3>getAttributeSize</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/client/ImmutableScan.html#line-441">getAttributeSize</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="OperationWithAttributes.html#getAttributeSize()">getAttributeSize</a></code> in class <code><a href="OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">OperationWithAttributes</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAttributesMap()"> |
| <h3>getAttributesMap</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/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<wbr>byte[]></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-446">getAttributesMap</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Attributes.html#getAttributesMap()">Attributes</a></code></span></div> |
| <div class="block">Gets all attributes</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Attributes.html#getAttributesMap()">getAttributesMap</a></code> in interface <code><a href="Attributes.html" title="interface in org.apache.hadoop.hbase.client">Attributes</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="OperationWithAttributes.html#getAttributesMap()">getAttributesMap</a></code> in class <code><a href="OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">OperationWithAttributes</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>unmodifiable map of all attributes</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLoadColumnFamiliesOnDemandValue()"> |
| <h3>getLoadColumnFamiliesOnDemandValue</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/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-451">getLoadColumnFamiliesOnDemandValue</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#getLoadColumnFamiliesOnDemandValue()">Query</a></code></span></div> |
| <div class="block">Get the raw loadColumnFamiliesOnDemand setting; if it's not set, can be null.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Query.html#getLoadColumnFamiliesOnDemandValue()">getLoadColumnFamiliesOnDemandValue</a></code> in class <code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPriority()"> |
| <h3>getPriority</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-456">getPriority</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="OperationWithAttributes.html#getPriority()">getPriority</a></code> in class <code><a href="OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">OperationWithAttributes</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getColumnFamilyTimeRange()"> |
| <h3>getColumnFamilyTimeRange</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/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><byte[],<wbr><a href="../io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-461">getColumnFamilyTimeRange</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#getColumnFamilyTimeRange()">Query</a></code></span></div> |
| <div class="block">Returns A map of column families to time ranges</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Query.html#getColumnFamilyTimeRange()">getColumnFamilyTimeRange</a></code> in class <code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReplicaId()"> |
| <h3>getReplicaId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-466">getReplicaId</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#getReplicaId()">Query</a></code></span></div> |
| <div class="block">Returns region replica id where Query will fetch data from.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Query.html#getReplicaId()">getReplicaId</a></code> in class <code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>region replica id or -1 if not set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doLoadColumnFamiliesOnDemand()"> |
| <h3>doLoadColumnFamiliesOnDemand</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-471">doLoadColumnFamiliesOnDemand</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#doLoadColumnFamiliesOnDemand()">Query</a></code></span></div> |
| <div class="block">Get the logical value indicating whether on-demand CF loading should be allowed.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Query.html#doLoadColumnFamiliesOnDemand()">doLoadColumnFamiliesOnDemand</a></code> in class <code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getId()"> |
| <h3>getId</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/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-476">getId</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="OperationWithAttributes.html#getId()">OperationWithAttributes</a></code></span></div> |
| <div class="block">This method allows you to retrieve the identifier for the operation if one was set.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="OperationWithAttributes.html#getId()">getId</a></code> in class <code><a href="OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">OperationWithAttributes</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the id or null if not set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isGetScan()"> |
| <h3>isGetScan</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-481">isGetScan</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Scan.html#isGetScan()">isGetScan</a></code> in class <code><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIsolationLevel()"> |
| <h3>getIsolationLevel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="IsolationLevel.html" title="enum class in org.apache.hadoop.hbase.client">IsolationLevel</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-486">getIsolationLevel</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#getIsolationLevel()">Query</a></code></span></div> |
| <div class="block">Returns The isolation level of this query. If no isolation level was set for this query object, |
| then it returns READ_COMMITTED.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Query.html#getIsolationLevel()">getIsolationLevel</a></code> in class <code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAuthorizations()"> |
| <h3>getAuthorizations</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../security/visibility/Authorizations.html" title="class in org.apache.hadoop.hbase.security.visibility">Authorizations</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-491">getAuthorizations</a></span>() |
| throws <span class="exceptions"><a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Query.html#getAuthorizations()">Query</a></code></span></div> |
| <div class="block">Returns The authorizations this Query is associated with. n</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Query.html#getAuthorizations()">getAuthorizations</a></code> in class <code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString(int)"> |
| <h3>toString</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/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-496">toString</a></span><wbr><span class="parameters">(int maxCols)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Operation.html#toString(int)">Operation</a></code></span></div> |
| <div class="block">Produces a string representation of this Operation. It defaults to a JSON representation, but |
| falls back to a string representation of the fingerprint and details in the case of a JSON |
| encoding failure.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Operation.html#toString(int)">toString</a></code> in class <code><a href="Operation.html" title="class in org.apache.hadoop.hbase.client">Operation</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>maxCols</code> - a limit on the number of columns output in the summary prior to truncation</dd> |
| <dt>Returns:</dt> |
| <dd>a JSON-parseable String</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</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/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-501">toString</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Operation.html#toString()">Operation</a></code></span></div> |
| <div class="block">Produces a string representation of this Operation. It defaults to a JSON representation, but |
| falls back to a string representation of the fingerprint and details in the case of a JSON |
| encoding failure.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Operation.html#toString()">toString</a></code> in class <code><a href="Operation.html" title="class in org.apache.hadoop.hbase.client">Operation</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toMap()"> |
| <h3>toMap</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/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<wbr><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>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-506">toMap</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Operation.html#toMap()">Operation</a></code></span></div> |
| <div class="block">Produces a Map containing a full summary of a query.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Operation.html#toMap()">toMap</a></code> in class <code><a href="Operation.html" title="class in org.apache.hadoop.hbase.client">Operation</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a map containing parameters of a query (i.e. rows, columns...)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toJSON(int)"> |
| <h3>toJSON</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/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-511">toJSON</a></span><wbr><span class="parameters">(int maxCols)</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 class: <code><a href="Operation.html#toJSON(int)">Operation</a></code></span></div> |
| <div class="block">Produces a JSON object for fingerprint and details exposure in a parseable format.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Operation.html#toJSON(int)">toJSON</a></code> in class <code><a href="Operation.html" title="class in org.apache.hadoop.hbase.client">Operation</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>maxCols</code> - a limit on the number of columns to include in the JSON</dd> |
| <dt>Returns:</dt> |
| <dd>a JSONObject containing this Operation's information, as a string</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="toJSON()"> |
| <h3>toJSON</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/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/ImmutableScan.html#line-516">toJSON</a></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 class: <code><a href="Operation.html#toJSON()">Operation</a></code></span></div> |
| <div class="block">Produces a JSON object sufficient for description of a query in a debugging or logging context.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Operation.html#toJSON()">toJSON</a></code> in class <code><a href="Operation.html" title="class in org.apache.hadoop.hbase.client">Operation</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the produced JSON object, as a string</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> |
| </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> |