devapidocs/org/apache/hadoop/hbase/client/Scan.html - hbase-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>Scan (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: Scan">
 <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/Scan.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:&nbsp;</li>
 <li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <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>&nbsp;<a href="package-summary.html">org.apache.hadoop.hbase.client</a></div>
 <h1 title="Class Scan" class="title">Class Scan</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">org.apache.hadoop.hbase.client.Scan</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>
 <dl class="notes">
 <dt>Direct Known Subclasses:</dt>
 <dd><code><a href="ImmutableScan.html" title="class in org.apache.hadoop.hbase.client">ImmutableScan</a></code>, <code><a href="../regionserver/InternalScan.html" title="class in org.apache.hadoop.hbase.regionserver">InternalScan</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="annotations">@Public
 </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-83">Scan</a></span>
 <span class="extends-implements">extends <a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></span></div>
 <div class="block">Used to perform Scan operations.
  <p>
  All operations are identical to <a href="Get.html" title="class in org.apache.hadoop.hbase.client"><code>Get</code></a> with the exception of instantiation. Rather than
  specifying a single row, an optional startRow and stopRow may be defined. If rows are not
  specified, the Scanner will iterate over all rows.
  <p>
  To get all columns from all rows of a Table, create an instance with no constraints; use the
  <a href="#%3Cinit%3E()"><code>Scan()</code></a> constructor. To constrain the scan to specific column families, call
  <a href="#addFamily(byte%5B%5D)"><code>addFamily</code></a> for each family to retrieve on your Scan instance.
  <p>
  To get specific columns, call <a href="#addColumn(byte%5B%5D,byte%5B%5D)"><code>addColumn</code></a> for each column to
  retrieve.
  <p>
  To only retrieve columns within a specific range of version timestamps, call
  <a href="#setTimeRange(long,long)"><code>setTimeRange</code></a>.
  <p>
  To only retrieve columns with a specific timestamp, call <a href="#setTimestamp(long)"><code>setTimestamp</code></a>
  .
  <p>
  To limit the number of versions of each column to be returned, call <a href="#readVersions(int)"><code>readVersions(int)</code></a>.
  <p>
  To limit the maximum number of values returned for each call to next(), call
  <a href="#setBatch(int)"><code>setBatch</code></a>.
  <p>
  To add a filter, call <a href="#setFilter(org.apache.hadoop.hbase.filter.Filter)"><code>setFilter</code></a>.
  <p>
  For small scan, it is deprecated in 2.0.0. Now we have a <a href="#setLimit(int)"><code>setLimit(int)</code></a> method in Scan
  object which is used to tell RS how many rows we want. If the rows return reaches the limit, the
  RS will close the RegionScanner automatically. And we will also fetch data when openScanner in
  the new implementation, this means we can also finish a scan operation in one rpc call. And we
  have also introduced a <a href="#setReadType(org.apache.hadoop.hbase.client.Scan.ReadType)"><code>setReadType(ReadType)</code></a> method. You can use this method to tell RS
  to use pread explicitly.
  <p>
  Expert: To explicitly disable server-side block caching for this scan, execute
  <a href="#setCacheBlocks(boolean)"><code>setCacheBlocks(boolean)</code></a>.
  <p>
  <em>Note:</em> Usage alters Scan instances. Internally, attributes are updated as the Scan runs
  and if enabled, metrics accumulate in the Scan instance. Be aware this is the case when you go to
  clone a Scan instance or if you go to reuse a created Scan instance; safer is create a Scan
  instance per usage.</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="caption"><span>Nested Classes</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">Class</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static enum&nbsp;</code></div>
 <div class="col-second even-row-color"><code><a href="Scan.ReadType.html" class="type-name-link" title="enum class in org.apache.hadoop.hbase.client">Scan.ReadType</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 </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 boolean</code></div>
 <div class="col-second even-row-color"><code><a href="#allowPartialResults" class="member-name-link">allowPartialResults</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Partial <a href="Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>s are <a href="Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>s must be combined to form a complete <a href="Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>.</div>
 </div>
 <div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#asyncPrefetch" class="member-name-link">asyncPrefetch</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private int</code></div>
 <div class="col-second even-row-color"><code><a href="#batch" class="member-name-link">batch</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private boolean</code></div>
 <div class="col-second odd-row-color"><code><a href="#cacheBlocks" class="member-name-link">cacheBlocks</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private int</code></div>
 <div class="col-second even-row-color"><code><a href="#caching" class="member-name-link">caching</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">-1 means no caching specified and the value of <a href="../HConstants.html#HBASE_CLIENT_SCANNER_CACHING"><code>HConstants.HBASE_CLIENT_SCANNER_CACHING</code></a>
  (default to <a href="../HConstants.html#DEFAULT_HBASE_CLIENT_SCANNER_CACHING"><code>HConstants.DEFAULT_HBASE_CLIENT_SCANNER_CACHING</code></a>) will be used</div>
 </div>
 <div class="col-first odd-row-color"><code>static final boolean</code></div>
 <div class="col-second odd-row-color"><code><a href="#DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH" class="member-name-link">DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">Default value of <a href="#HBASE_CLIENT_SCANNER_ASYNC_PREFETCH"><code>HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</code></a>.</div>
 </div>
 <div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;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>&lt;byte[]&gt;&gt;</code></div>
 <div class="col-second even-row-color"><code><a href="#familyMap" class="member-name-link">familyMap</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>static final <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"><code><a href="#HBASE_CLIENT_SCANNER_ASYNC_PREFETCH" class="member-name-link">HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">Parameter name for client scanner sync/async prefetch toggle.</div>
 </div>
 <div class="col-first even-row-color"><code>private boolean</code></div>
 <div class="col-second even-row-color"><code><a href="#includeStartRow" class="member-name-link">includeStartRow</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private boolean</code></div>
 <div class="col-second odd-row-color"><code><a href="#includeStopRow" class="member-name-link">includeStopRow</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private int</code></div>
 <div class="col-second even-row-color"><code><a href="#limit" class="member-name-link">limit</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">The number of rows we want for this scan.</div>
 </div>
 <div class="col-first odd-row-color"><code>private static final org.slf4j.Logger</code></div>
 <div class="col-second odd-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private long</code></div>
 <div class="col-second even-row-color"><code><a href="#maxResultSize" class="member-name-link">maxResultSize</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private int</code></div>
 <div class="col-second odd-row-color"><code><a href="#maxVersions" class="member-name-link">maxVersions</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private long</code></div>
 <div class="col-second even-row-color"><code><a href="#mvccReadPoint" class="member-name-link">mvccReadPoint</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">The mvcc read point to use when open a scanner.</div>
 </div>
 <div class="col-first odd-row-color"><code>private boolean</code></div>
 <div class="col-second odd-row-color"><code><a href="#needCursorResult" class="member-name-link">needCursorResult</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private static final <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"><code><a href="#RAW_ATTR" class="member-name-link">RAW_ATTR</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private <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"><code><a href="#readType" class="member-name-link">readType</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">Control whether to use pread at server side.</div>
 </div>
 <div class="col-first even-row-color"><code>private boolean</code></div>
 <div class="col-second even-row-color"><code><a href="#reversed" class="member-name-link">reversed</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private static final <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"><code><a href="#SCAN_ATTRIBUTES_METRICS_ENABLE" class="member-name-link">SCAN_ATTRIBUTES_METRICS_ENABLE</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>static final <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"><code><a href="#SCAN_ATTRIBUTES_TABLE_NAME" class="member-name-link">SCAN_ATTRIBUTES_TABLE_NAME</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private byte[]</code></div>
 <div class="col-second odd-row-color"><code><a href="#startRow" class="member-name-link">startRow</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private byte[]</code></div>
 <div class="col-second even-row-color"><code><a href="#stopRow" class="member-name-link">stopRow</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private int</code></div>
 <div class="col-second odd-row-color"><code><a href="#storeLimit" class="member-name-link">storeLimit</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private int</code></div>
 <div class="col-second even-row-color"><code><a href="#storeOffset" class="member-name-link">storeOffset</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private <a href="../io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#tr" class="member-name-link">tr</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 </div>
 <div class="inherited-list">
 <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.client.Query">Fields inherited from class&nbsp;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&nbsp;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()" class="member-name-link">Scan</a>()</code></div>
 <div class="col-last even-row-color">
 <div class="block">Create a Scan operation across all rows.</div>
 </div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.client.Get)" class="member-name-link">Scan</a><wbr>(<a href="Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>&nbsp;get)</code></div>
 <div class="col-last odd-row-color">
 <div class="block">Builds a scan object with the same specs as get.</div>
 </div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.client.Scan)" class="member-name-link">Scan</a><wbr>(<a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a new instance of this class while copying all values.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><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[]&nbsp;family,
  byte[]&nbsp;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[]&nbsp;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-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#createScanFromCursor(org.apache.hadoop.hbase.client.Cursor)" class="member-name-link">createScanFromCursor</a><wbr>(<a href="Cursor.html" title="class in org.apache.hadoop.hbase.client">Cursor</a>&nbsp;cursor)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Create a new Scan with a cursor.</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="#getAllowPartialResults()" class="member-name-link">getAllowPartialResults</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 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 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="#getBatch()" class="member-name-link">getBatch</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 maximum number of values to return for a single call to next()</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="#getCacheBlocks()" class="member-name-link">getCacheBlocks</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 blocks should be cached 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="#getCaching()" class="member-name-link">getCaching</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 caching the number of rows fetched when calling next on a scanner</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="#getFamilies()" class="member-name-link">getFamilies</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 keys of 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="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>&lt;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>&lt;byte[]&gt;&gt;</code></div>
 <div class="col-second even-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 even-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 odd-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 odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns RowFilter</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>&lt;<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>&gt;</code></div>
 <div class="col-second even-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 even-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 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="#getLimit()" class="member-name-link">getLimit</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 limit of rows for this scan</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><a href="Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client">Scan.ReadType</a></code></div>
 <div class="col-second even-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 even-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 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">&nbsp;</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">&nbsp;</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">&nbsp;</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&nbsp;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>&nbsp;user,
  <a href="../security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a>&nbsp;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>&lt;<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>&gt;&nbsp;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&nbsp;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&nbsp;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 class="deprecation-comment">Since 3.0.0, will be removed in 4.0.0.</div>
 </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>&nbsp;name,
  byte[]&nbsp;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>&nbsp;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&nbsp;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&nbsp;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&nbsp;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[]&nbsp;cf,
  long&nbsp;minStamp,
  long&nbsp;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>&nbsp;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>&lt;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>&lt;byte[]&gt;&gt;&nbsp;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>&nbsp;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>&nbsp;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>&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;priority)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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&nbsp;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>&nbsp;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&nbsp;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&nbsp;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&nbsp;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 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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setRowPrefixFilter(byte%5B%5D)" class="member-name-link">setRowPrefixFilter</a><wbr>(byte[]&nbsp;rowPrefix)</code></div>
 <div class="col-last odd-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 class="deprecation-comment">since 2.5.0, will be removed in 4.0.0.</div>
 </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="#setScanMetricsEnabled(boolean)" class="member-name-link">setScanMetricsEnabled</a><wbr>(boolean&nbsp;enabled)</code></div>
 <div class="col-last even-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 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="#setStartStopRowForPrefixScan(byte%5B%5D)" class="member-name-link">setStartStopRowForPrefixScan</a><wbr>(byte[]&nbsp;rowPrefix)</code></div>
 <div class="col-last odd-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 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="#setTimeRange(long,long)" class="member-name-link">setTimeRange</a><wbr>(long&nbsp;minStamp,
  long&nbsp;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).</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="#setTimestamp(long)" class="member-name-link">setTimestamp</a><wbr>(long&nbsp;timestamp)</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 with the specified timestamp.</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>&lt;<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>&gt;</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&nbsp;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="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[]&nbsp;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[]&nbsp;startRow,
  boolean&nbsp;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[]&nbsp;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[]&nbsp;stopRow,
  boolean&nbsp;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.Query">Methods inherited from class&nbsp;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#doLoadColumnFamiliesOnDemand()">doLoadColumnFamiliesOnDemand</a>, <a href="Query.html#getACL()">getACL</a>, <a href="Query.html#getAuthorizations()">getAuthorizations</a>, <a href="Query.html#getColumnFamilyTimeRange()">getColumnFamilyTimeRange</a>, <a href="Query.html#getConsistency()">getConsistency</a>, <a href="Query.html#getIsolationLevel()">getIsolationLevel</a>, <a href="Query.html#getLoadColumnFamiliesOnDemandValue()">getLoadColumnFamiliesOnDemandValue</a>, <a href="Query.html#getReplicaId()">getReplicaId</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.client.OperationWithAttributes">Methods inherited from class&nbsp;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#getAttribute(java.lang.String)">getAttribute</a>, <a href="OperationWithAttributes.html#getAttributeSize()">getAttributeSize</a>, <a href="OperationWithAttributes.html#getAttributesMap()">getAttributesMap</a>, <a href="OperationWithAttributes.html#getId()">getId</a>, <a href="OperationWithAttributes.html#getPriority()">getPriority</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.client.Operation">Methods inherited from class&nbsp;org.apache.hadoop.hbase.client.<a href="Operation.html" title="class in org.apache.hadoop.hbase.client">Operation</a></h3>
 <code><a href="Operation.html#toJSON()">toJSON</a>, <a href="Operation.html#toJSON(int)">toJSON</a>, <a href="Operation.html#toMap()">toMap</a>, <a href="Operation.html#toString()">toString</a>, <a href="Operation.html#toString(int)">toString</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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="LOG">
 <h3>LOG</h3>
 <div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<span class="return-type">org.slf4j.Logger</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-85">LOG</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="RAW_ATTR">
 <h3>RAW_ATTR</h3>
 <div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<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>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-87">RAW_ATTR</a></span></div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.Scan.RAW_ATTR">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="startRow">
 <h3>startRow</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-89">startRow</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="includeStartRow">
 <h3>includeStartRow</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-90">includeStartRow</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="stopRow">
 <h3>stopRow</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-91">stopRow</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="includeStopRow">
 <h3>includeStopRow</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-92">includeStopRow</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="maxVersions">
 <h3>maxVersions</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-93">maxVersions</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="batch">
 <h3>batch</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-94">batch</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="allowPartialResults">
 <h3>allowPartialResults</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-107">allowPartialResults</a></span></div>
 <div class="block">Partial <a href="Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>s are <a href="Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>s must be combined to form a complete <a href="Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>.
  The <a href="Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>s had to be returned in fragments (i.e. as partials) because the size of the
  cells in the row exceeded max result size on the server. Typically partial results will be
  combined client side into complete results before being delivered to the caller. However, if
  this flag is set, the caller is indicating that they do not mind seeing partial results (i.e.
  they understand that the results returned from the Scanner may only represent part of a
  particular row). In such a case, any attempt to combine the partials into a complete result on
  the client side will be skipped, and the caller will be able to see the exact results returned
  from the server.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="storeLimit">
 <h3>storeLimit</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-109">storeLimit</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="storeOffset">
 <h3>storeOffset</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-110">storeOffset</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="SCAN_ATTRIBUTES_METRICS_ENABLE">
 <h3>SCAN_ATTRIBUTES_METRICS_ENABLE</h3>
 <div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<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>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-112">SCAN_ATTRIBUTES_METRICS_ENABLE</a></span></div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.Scan.SCAN_ATTRIBUTES_METRICS_ENABLE">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="SCAN_ATTRIBUTES_TABLE_NAME">
 <h3>SCAN_ATTRIBUTES_TABLE_NAME</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<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>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-117">SCAN_ATTRIBUTES_TABLE_NAME</a></span></div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.Scan.SCAN_ATTRIBUTES_TABLE_NAME">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="caching">
 <h3>caching</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-123">caching</a></span></div>
 <div class="block">-1 means no caching specified and the value of <a href="../HConstants.html#HBASE_CLIENT_SCANNER_CACHING"><code>HConstants.HBASE_CLIENT_SCANNER_CACHING</code></a>
  (default to <a href="../HConstants.html#DEFAULT_HBASE_CLIENT_SCANNER_CACHING"><code>HConstants.DEFAULT_HBASE_CLIENT_SCANNER_CACHING</code></a>) will be used</div>
 </section>
 </li>
 <li>
 <section class="detail" id="maxResultSize">
 <h3>maxResultSize</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-124">maxResultSize</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="cacheBlocks">
 <h3>cacheBlocks</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-125">cacheBlocks</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="reversed">
 <h3>reversed</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-126">reversed</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="tr">
 <h3>tr</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-127">tr</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="familyMap">
 <h3>familyMap</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<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>&lt;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>&lt;byte[]&gt;&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-128">familyMap</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="asyncPrefetch">
 <h3>asyncPrefetch</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<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>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-130">asyncPrefetch</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="HBASE_CLIENT_SCANNER_ASYNC_PREFETCH">
 <h3>HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<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>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-137">HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</a></span></div>
 <div class="block">Parameter name for client scanner sync/async prefetch toggle. When using async scanner,
  prefetching data from the server is done at the background. The parameter currently won't have
  any effect in the case that the user has set Scan#setSmall or Scan#setReversed</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.Scan.HBASE_CLIENT_SCANNER_ASYNC_PREFETCH">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH">
 <h3>DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-143">DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</a></span></div>
 <div class="block">Default value of <a href="#HBASE_CLIENT_SCANNER_ASYNC_PREFETCH"><code>HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</code></a>.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.Scan.DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="mvccReadPoint">
 <h3>mvccReadPoint</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-149">mvccReadPoint</a></span></div>
 <div class="block">The mvcc read point to use when open a scanner. Remember to clear it after switching regions as
  the mvcc is only valid within region scope.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="limit">
 <h3>limit</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-155">limit</a></span></div>
 <div class="block">The number of rows we want for this scan. We will terminate the scan if the number of return
  rows reaches this value.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="readType">
 <h3>readType</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client">Scan.ReadType</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-160">readType</a></span></div>
 <div class="block">Control whether to use pread at server side.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="needCursorResult">
 <h3>needCursorResult</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-162">needCursorResult</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="&lt;init&gt;()">
 <h3>Scan</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-167">Scan</a></span>()</div>
 <div class="block">Create a Scan operation across all rows.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(org.apache.hadoop.hbase.client.Scan)">
 <h3>Scan</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-175">Scan</a></span><wbr><span class="parameters">(<a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan)</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">Creates a new instance of this class while copying all values.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>scan</code> - The scan instance to copy from.</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> - When copying the values fails.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(org.apache.hadoop.hbase.client.Get)">
 <h3>Scan</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-226">Scan</a></span><wbr><span class="parameters">(<a href="Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>&nbsp;get)</span></div>
 <div class="block">Builds a scan object with the same specs as get.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>get</code> - get to model scan after</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="isGetScan()">
 <h3>isGetScan</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-254">isGetScan</a></span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="addFamily(byte[])">
 <h3>addFamily</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-265">addFamily</a></span><wbr><span class="parameters">(byte[]&nbsp;family)</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>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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-278">addColumn</a></span><wbr><span class="parameters">(byte[]&nbsp;family,
  byte[]&nbsp;qualifier)</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>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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-300">setTimeRange</a></span><wbr><span class="parameters">(long&nbsp;minStamp,
  long&nbsp;maxStamp)</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">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>Parameters:</dt>
 <dd><code>minStamp</code> - minimum timestamp value, inclusive</dd>
 <dd><code>maxStamp</code> - maximum timestamp value, exclusive</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>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="#readAllVersions()"><code>readAllVersions()</code></a></li>
 <li><a href="#readVersions(int)"><code>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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-313">setTimestamp</a></span><wbr><span class="parameters">(long&nbsp;timestamp)</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>Parameters:</dt>
 <dd><code>timestamp</code> - version timestamp</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="#readAllVersions()"><code>readAllVersions()</code></a></li>
 <li><a href="#readVersions(int)"><code>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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-325">setColumnFamilyTimeRange</a></span><wbr><span class="parameters">(byte[]&nbsp;cf,
  long&nbsp;minStamp,
  long&nbsp;maxStamp)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<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="Query.html#setColumnFamilyTimeRange(byte%5B%5D,long,long)">setColumnFamilyTimeRange</a></code>&nbsp;in class&nbsp;<code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-344">withStartRow</a></span><wbr><span class="parameters">(byte[]&nbsp;startRow)</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="#setRowPrefixFilter(byte%5B%5D)"><code>setRowPrefixFilter(byte[])</code></a> or
  <a href="#setStartStopRowForPrefixScan(byte%5B%5D)"><code>setStartStopRowForPrefixScan(byte[])</code></a>.</strong> Doing so will make the scan result
  unexpected or even undefined.
  </p></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>startRow</code> - row to start scanner at or after</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if startRow does not meet criteria for a row key (when length
                                   exceeds <a href="../HConstants.html#MAX_ROW_LENGTH"><code>HConstants.MAX_ROW_LENGTH</code></a>)</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="withStartRow(byte[],boolean)">
 <h3>withStartRow</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-363">withStartRow</a></span><wbr><span class="parameters">(byte[]&nbsp;startRow,
  boolean&nbsp;inclusive)</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="#setRowPrefixFilter(byte%5B%5D)"><code>setRowPrefixFilter(byte[])</code></a> or
  <a href="#setStartStopRowForPrefixScan(byte%5B%5D)"><code>setStartStopRowForPrefixScan(byte[])</code></a>.</strong> Doing so will make the scan result
  unexpected or even undefined.
  </p></div>
 <dl class="notes">
 <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>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if startRow does not meet criteria for a row key (when length
                                   exceeds <a href="../HConstants.html#MAX_ROW_LENGTH"><code>HConstants.MAX_ROW_LENGTH</code></a>)</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="withStopRow(byte[])">
 <h3>withStopRow</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-386">withStopRow</a></span><wbr><span class="parameters">(byte[]&nbsp;stopRow)</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="#setRowPrefixFilter(byte%5B%5D)"><code>setRowPrefixFilter(byte[])</code></a> or
  <a href="#setStartStopRowForPrefixScan(byte%5B%5D)"><code>setStartStopRowForPrefixScan(byte[])</code></a>.</strong> Doing so will make the scan result
  unexpected or even undefined.
  </p></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>stopRow</code> - row to end at (exclusive)</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if stopRow does not meet criteria for a row key (when length
                                   exceeds <a href="../HConstants.html#MAX_ROW_LENGTH"><code>HConstants.MAX_ROW_LENGTH</code></a>)</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="withStopRow(byte[],boolean)">
 <h3>withStopRow</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-405">withStopRow</a></span><wbr><span class="parameters">(byte[]&nbsp;stopRow,
  boolean&nbsp;inclusive)</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="#setRowPrefixFilter(byte%5B%5D)"><code>setRowPrefixFilter(byte[])</code></a> or
  <a href="#setStartStopRowForPrefixScan(byte%5B%5D)"><code>setStartStopRowForPrefixScan(byte[])</code></a>.</strong> Doing so will make the scan result
  unexpected or even undefined.
  </p></div>
 <dl class="notes">
 <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>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if stopRow does not meet criteria for a row key (when length
                                   exceeds <a href="../HConstants.html#MAX_ROW_LENGTH"><code>HConstants.MAX_ROW_LENGTH</code></a>)</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setRowPrefixFilter(byte[])">
 <h3>setRowPrefixFilter</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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-436">setRowPrefixFilter</a></span><wbr><span class="parameters">(byte[]&nbsp;rowPrefix)</span></div>
 <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
 <div class="deprecation-comment">since 2.5.0, will be removed in 4.0.0. The name of this method is considered to be
              confusing as it does not use a <a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a> but uses setting the startRow and
              stopRow instead. Use <a href="#setStartStopRowForPrefixScan(byte%5B%5D)"><code>setStartStopRowForPrefixScan(byte[])</code></a> instead.</div>
 </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>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="setStartStopRowForPrefixScan(byte[])">
 <h3>setStartStopRowForPrefixScan</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-459">setStartStopRowForPrefixScan</a></span><wbr><span class="parameters">(byte[]&nbsp;rowPrefix)</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>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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-473">readAllVersions</a></span>()</div>
 <div class="block">Get all available versions.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="readVersions(int)">
 <h3>readVersions</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-482">readVersions</a></span><wbr><span class="parameters">(int&nbsp;versions)</span></div>
 <div class="block">Get up to the specified number of versions of each column.</div>
 <dl class="notes">
 <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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-496">setBatch</a></span><wbr><span class="parameters">(int&nbsp;batch)</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="#setAllowPartialResults(boolean)"><code>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>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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-509">setMaxResultsPerColumnFamily</a></span><wbr><span class="parameters">(int&nbsp;limit)</span></div>
 <div class="block">Set the maximum number of values to return per row per Column Family</div>
 <dl class="notes">
 <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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-518">setRowOffsetPerColumnFamily</a></span><wbr><span class="parameters">(int&nbsp;offset)</span></div>
 <div class="block">Set offset for the row per Column Family.</div>
 <dl class="notes">
 <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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-529">setCaching</a></span><wbr><span class="parameters">(int&nbsp;caching)</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>Parameters:</dt>
 <dd><code>caching</code> - the number of rows for caching</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getMaxResultSize()">
 <h3>getMaxResultSize</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-535">getMaxResultSize</a></span>()</div>
 <div class="block">Returns the maximum result size in bytes. See <a href="#setMaxResultSize(long)"><code>setMaxResultSize(long)</code></a></div>
 </section>
 </li>
 <li>
 <section class="detail" id="setMaxResultSize(long)">
 <h3>setMaxResultSize</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-545">setMaxResultSize</a></span><wbr><span class="parameters">(long&nbsp;maxResultSize)</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>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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-550">setFilter</a></span><wbr><span class="parameters">(<a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>&nbsp;filter)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<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="Query.html#setFilter(org.apache.hadoop.hbase.filter.Filter)">setFilter</a></code>&nbsp;in class&nbsp;<code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-560">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>&lt;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>&lt;byte[]&gt;&gt;&nbsp;familyMap)</span></div>
 <div class="block">Setting the familyMap</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>familyMap</code> - map of family to qualifier</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getFamilyMap()">
 <h3>getFamilyMap</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&lt;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>&lt;byte[]&gt;&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-568">getFamilyMap</a></span>()</div>
 <div class="block">Getting the familyMap</div>
 </section>
 </li>
 <li>
 <section class="detail" id="numFamilies()">
 <h3>numFamilies</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-573">numFamilies</a></span>()</div>
 <div class="block">Returns the number of families in familyMap</div>
 </section>
 </li>
 <li>
 <section class="detail" id="hasFamilies()">
 <h3>hasFamilies</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-581">hasFamilies</a></span>()</div>
 <div class="block">Returns true if familyMap is non empty, false otherwise</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getFamilies()">
 <h3>getFamilies</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">byte[][]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-586">getFamilies</a></span>()</div>
 <div class="block">Returns the keys of the familyMap</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getStartRow()">
 <h3>getStartRow</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-594">getStartRow</a></span>()</div>
 <div class="block">Returns the startrow</div>
 </section>
 </li>
 <li>
 <section class="detail" id="includeStartRow()">
 <h3>includeStartRow</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-599">includeStartRow</a></span>()</div>
 <div class="block">Returns if we should include start row when scan</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getStopRow()">
 <h3>getStopRow</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-604">getStopRow</a></span>()</div>
 <div class="block">Returns the stoprow</div>
 </section>
 </li>
 <li>
 <section class="detail" id="includeStopRow()">
 <h3>includeStopRow</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-609">includeStopRow</a></span>()</div>
 <div class="block">Returns if we should include stop row when scan</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getMaxVersions()">
 <h3>getMaxVersions</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-614">getMaxVersions</a></span>()</div>
 <div class="block">Returns the max number of versions to fetch</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getBatch()">
 <h3>getBatch</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-619">getBatch</a></span>()</div>
 <div class="block">Returns maximum number of values to return for a single call to next()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getMaxResultsPerColumnFamily()">
 <h3>getMaxResultsPerColumnFamily</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-624">getMaxResultsPerColumnFamily</a></span>()</div>
 <div class="block">Returns maximum number of values to return per row per CF</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getRowOffsetPerColumnFamily()">
 <h3>getRowOffsetPerColumnFamily</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-632">getRowOffsetPerColumnFamily</a></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>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>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-637">getCaching</a></span>()</div>
 <div class="block">Returns caching the number of rows fetched when calling next on a scanner</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getTimeRange()">
 <h3>getTimeRange</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-642">getTimeRange</a></span>()</div>
 <div class="block">Returns TimeRange</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getFilter()">
 <h3>getFilter</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-647">getFilter</a></span>()</div>
 <div class="block">Returns RowFilter</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="Query.html#getFilter()">getFilter</a></code>&nbsp;in class&nbsp;<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="hasFilter()">
 <h3>hasFilter</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-653">hasFilter</a></span>()</div>
 <div class="block">Returns true is a filter has been specified, false if not</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setCacheBlocks(boolean)">
 <h3>setCacheBlocks</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-664">setCacheBlocks</a></span><wbr><span class="parameters">(boolean&nbsp;cacheBlocks)</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>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="getCacheBlocks()">
 <h3>getCacheBlocks</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-673">getCacheBlocks</a></span>()</div>
 <div class="block">Get whether blocks should be cached for this Scan.</div>
 <dl class="notes">
 <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="setReversed(boolean)">
 <h3>setReversed</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-683">setReversed</a></span><wbr><span class="parameters">(boolean&nbsp;reversed)</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>Parameters:</dt>
 <dd><code>reversed</code> - if true, scan will be backward order</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="isReversed()">
 <h3>isReversed</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-692">isReversed</a></span>()</div>
 <div class="block">Get whether this scan is a reversed one.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>true if backward scan, false if forward(default) scan</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setAllowPartialResults(boolean)">
 <h3>setAllowPartialResults</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-704">setAllowPartialResults</a></span><wbr><span class="parameters">(boolean&nbsp;allowPartialResults)</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>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="Result.html#mayHaveMoreCellsInRow()"><code>Result.mayHaveMoreCellsInRow()</code></a></li>
 <li><a href="#setBatch(int)"><code>setBatch(int)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getAllowPartialResults()">
 <h3>getAllowPartialResults</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-714">getAllowPartialResults</a></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>
 </section>
 </li>
 <li>
 <section class="detail" id="setLoadColumnFamiliesOnDemand(boolean)">
 <h3>setLoadColumnFamiliesOnDemand</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-718">setLoadColumnFamiliesOnDemand</a></span><wbr><span class="parameters">(boolean&nbsp;value)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<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 =&gt; 1 }, { video =&gt; "my cat"
  } } someone puts rowKey 5 with { cat_videos =&gt; 0 }, { video =&gt; "my dog" }, concurrent
  scan filtering on "cat_videos == 1" can get { rowKey = 5, { cat_videos =&gt; 1 }, { video =&gt;
  "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="Query.html#setLoadColumnFamiliesOnDemand(boolean)">setLoadColumnFamiliesOnDemand</a></code>&nbsp;in class&nbsp;<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>&nbsp;<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>&lt;<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>&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-727">getFingerprint</a></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>Specified by:</dt>
 <dd><code><a href="Operation.html#getFingerprint()">getFingerprint</a></code>&nbsp;in class&nbsp;<code><a href="Operation.html" title="class in org.apache.hadoop.hbase.client">Operation</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>&nbsp;<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>&lt;<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>&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-749">toMap</a></span><wbr><span class="parameters">(int&nbsp;maxCols)</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>Specified by:</dt>
 <dd><code><a href="Operation.html#toMap(int)">toMap</a></code>&nbsp;in class&nbsp;<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 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="setRaw(boolean)">
 <h3>setRaw</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-837">setRaw</a></span><wbr><span class="parameters">(boolean&nbsp;raw)</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>Parameters:</dt>
 <dd><code>raw</code> - True/False to enable/disable "raw" mode.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="isRaw()">
 <h3>isRaw</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-843">isRaw</a></span>()</div>
 <div class="block">Returns True if this Scan is in "raw" mode.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setAttribute(java.lang.String,byte[])">
 <h3>setAttribute</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-848">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>&nbsp;name,
  byte[]&nbsp;value)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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#setAttribute(java.lang.String,byte%5B%5D)">setAttribute</a></code>&nbsp;in class&nbsp;<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>
 <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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-853">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>&nbsp;id)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<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="OperationWithAttributes.html#setId(java.lang.String)">setId</a></code>&nbsp;in class&nbsp;<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="setAuthorizations(org.apache.hadoop.hbase.security.visibility.Authorizations)">
 <h3>setAuthorizations</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-858">setAuthorizations</a></span><wbr><span class="parameters">(<a href="../security/visibility/Authorizations.html" title="class in org.apache.hadoop.hbase.security.visibility">Authorizations</a>&nbsp;authorizations)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<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="Query.html#setAuthorizations(org.apache.hadoop.hbase.security.visibility.Authorizations)">setAuthorizations</a></code>&nbsp;in class&nbsp;<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="setACL(java.util.Map)">
 <h3>setACL</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-863">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>&lt;<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>&gt;&nbsp;perms)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<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="Query.html#setACL(java.util.Map)">setACL</a></code>&nbsp;in class&nbsp;<code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-868">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>&nbsp;user,
  <a href="../security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a>&nbsp;perms)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<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="Query.html#setACL(java.lang.String,org.apache.hadoop.hbase.security.access.Permission)">setACL</a></code>&nbsp;in class&nbsp;<code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-873">setConsistency</a></span><wbr><span class="parameters">(<a href="Consistency.html" title="enum class in org.apache.hadoop.hbase.client">Consistency</a>&nbsp;consistency)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<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="Query.html#setConsistency(org.apache.hadoop.hbase.client.Consistency)">setConsistency</a></code>&nbsp;in class&nbsp;<code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-878">setReplicaId</a></span><wbr><span class="parameters">(int&nbsp;Id)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<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="Query.html#setReplicaId(int)">setReplicaId</a></code>&nbsp;in class&nbsp;<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="setIsolationLevel(org.apache.hadoop.hbase.client.IsolationLevel)">
 <h3>setIsolationLevel</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-883">setIsolationLevel</a></span><wbr><span class="parameters">(<a href="IsolationLevel.html" title="enum class in org.apache.hadoop.hbase.client">IsolationLevel</a>&nbsp;level)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<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="Query.html#setIsolationLevel(org.apache.hadoop.hbase.client.IsolationLevel)">setIsolationLevel</a></code>&nbsp;in class&nbsp;<code><a href="Query.html" title="class in org.apache.hadoop.hbase.client">Query</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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-888">setPriority</a></span><wbr><span class="parameters">(int&nbsp;priority)</span></div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="OperationWithAttributes.html#setPriority(int)">setPriority</a></code>&nbsp;in class&nbsp;<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="setScanMetricsEnabled(boolean)">
 <h3>setScanMetricsEnabled</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-897">setScanMetricsEnabled</a></span><wbr><span class="parameters">(boolean&nbsp;enabled)</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>Parameters:</dt>
 <dd><code>enabled</code> - Set to true to enable accumulating scan metrics</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="isScanMetricsEnabled()">
 <h3>isScanMetricsEnabled</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-903">isScanMetricsEnabled</a></span>()</div>
 <div class="block">Returns True if collection of scan metrics is enabled. For advanced users.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="isAsyncPrefetch()">
 <h3>isAsyncPrefetch</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-908">isAsyncPrefetch</a></span>()</div>
 </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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-916">setAsyncPrefetch</a></span><wbr><span class="parameters">(boolean&nbsp;asyncPrefetch)</span></div>
 <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
 <div class="deprecation-comment">Since 3.0.0, will be removed in 4.0.0. After building sync client upon async
              client, the implementation is always 'async prefetch', so this flag is useless now.</div>
 </div>
 </section>
 </li>
 <li>
 <section class="detail" id="getLimit()">
 <h3>getLimit</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-923">getLimit</a></span>()</div>
 <div class="block">Returns the limit of rows for this scan</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setLimit(int)">
 <h3>setLimit</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-934">setLimit</a></span><wbr><span class="parameters">(int&nbsp;limit)</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>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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-943">setOneRowLimit</a></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>
 </section>
 </li>
 <li>
 <section class="detail" id="getReadType()">
 <h3>getReadType</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client">Scan.ReadType</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-955">getReadType</a></span>()</div>
 <div class="block">Returns the read type for this scan</div>
 </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>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-965">setReadType</a></span><wbr><span class="parameters">(<a href="Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client">Scan.ReadType</a>&nbsp;readType)</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>
 </section>
 </li>
 <li>
 <section class="detail" id="getMvccReadPoint()">
 <h3>getMvccReadPoint</h3>
 <div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-973">getMvccReadPoint</a></span>()</div>
 <div class="block">Get the mvcc read point used to open a scanner.</div>
 </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>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-980">setMvccReadPoint</a></span><wbr><span class="parameters">(long&nbsp;mvccReadPoint)</span></div>
 <div class="block">Set the mvcc read point used to open a scanner.</div>
 </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>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-988">resetMvccReadPoint</a></span>()</div>
 <div class="block">Set the mvcc read point to -1 which means do not use it.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setNeedCursorResult(boolean)">
 <h3>setNeedCursorResult</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-1005">setNeedCursorResult</a></span><wbr><span class="parameters">(boolean&nbsp;needCursorResult)</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>
 </section>
 </li>
 <li>
 <section class="detail" id="isNeedCursorResult()">
 <h3>isNeedCursorResult</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-1010">isNeedCursorResult</a></span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="createScanFromCursor(org.apache.hadoop.hbase.client.Cursor)">
 <h3>createScanFromCursor</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line-1019">createScanFromCursor</a></span><wbr><span class="parameters">(<a href="Cursor.html" title="class in org.apache.hadoop.hbase.client">Cursor</a>&nbsp;cursor)</span></div>
 <div class="block">Create a new Scan with a cursor. It only set the position information like start row key. The
  others (like cfs, stop row, limit) should still be filled in by the user.
  <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>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>