blob: 476242db2f602d9939b5cb60580c03b01709b727 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ScanInfo (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ScanInfo (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ScanInfo.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/regionserver/RSRpcServices.ScannerListener.html" title="class in org.apache.hadoop.hbase.regionserver"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScannerContext.html" title="class in org.apache.hadoop.hbase.regionserver"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/regionserver/ScanInfo.html" target="_top">Frames</a></li>
<li><a href="ScanInfo.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hbase.regionserver</div>
<h2 title="Class ScanInfo" class="title">Class ScanInfo</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.regionserver.ScanInfo</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@InterfaceAudience.Private
public class <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.36">ScanInfo</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Immutable information for scans over a store.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#cellsPerTimeoutCheck">cellsPerTimeoutCheck</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#comparator">comparator</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#family">family</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#FIXED_OVERHEAD">FIXED_OVERHEAD</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#keepDeletedCells">keepDeletedCells</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#maxVersions">maxVersions</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#minVersions">minVersions</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#newVersionBehavior">newVersionBehavior</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#parallelSeekEnabled">parallelSeekEnabled</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#preadMaxBytes">preadMaxBytes</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#tableMaxRowSize">tableMaxRowSize</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#timeToPurgeDeletes">timeToPurgeDeletes</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#ttl">ttl</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#usePread">usePread</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#ScanInfo-byte:A-int-int-long-org.apache.hadoop.hbase.KeepDeletedCells-long-org.apache.hadoop.hbase.CellComparator-long-boolean-long-boolean-long-boolean-">ScanInfo</a></span>(byte[]&nbsp;family,
int&nbsp;minVersions,
int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells,
long&nbsp;timeToPurgeDeletes,
<a href="../../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;comparator,
long&nbsp;tableMaxRowSize,
boolean&nbsp;usePread,
long&nbsp;cellsPerTimeoutCheck,
boolean&nbsp;parallelSeekEnabled,
long&nbsp;preadMaxBytes,
boolean&nbsp;newVersionBehavior)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#ScanInfo-org.apache.hadoop.conf.Configuration-byte:A-int-int-long-org.apache.hadoop.hbase.KeepDeletedCells-long-long-org.apache.hadoop.hbase.CellComparator-boolean-">ScanInfo</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
byte[]&nbsp;family,
int&nbsp;minVersions,
int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells,
long&nbsp;blockSize,
long&nbsp;timeToPurgeDeletes,
<a href="../../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;comparator,
boolean&nbsp;newVersionBehavior)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#ScanInfo-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.ColumnFamilyDescriptor-long-long-org.apache.hadoop.hbase.CellComparator-">ScanInfo</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="../../../../../org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client">ColumnFamilyDescriptor</a>&nbsp;family,
long&nbsp;ttl,
long&nbsp;timeToPurgeDeletes,
<a href="../../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;comparator)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>(package private) <a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html" title="class in org.apache.hadoop.hbase.regionserver">ScanInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#customize-int-long-org.apache.hadoop.hbase.KeepDeletedCells-">customize</a></span>(int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells)</code>
<div class="block">Used by CP users for customizing max versions, ttl and keepDeletedCells.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>(package private) <a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html" title="class in org.apache.hadoop.hbase.regionserver">ScanInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#customize-int-long-org.apache.hadoop.hbase.KeepDeletedCells-int-long-">customize</a></span>(int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells,
int&nbsp;minVersions,
long&nbsp;timeToPurgeDeletes)</code>
<div class="block">Used by CP users for customizing max versions, ttl, keepDeletedCells, min versions,
and time to purge deletes.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>(package private) long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#getCellsPerTimeoutCheck--">getCellsPerTimeoutCheck</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>private static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#getCellsPerTimeoutCheck-org.apache.hadoop.conf.Configuration-">getCellsPerTimeoutCheck</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#getComparator--">getComparator</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#getFamily--">getFamily</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#getKeepDeletedCells--">getKeepDeletedCells</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#getMaxVersions--">getMaxVersions</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#getMinVersions--">getMinVersions</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>(package private) long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#getPreadMaxBytes--">getPreadMaxBytes</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>(package private) long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#getTableMaxRowSize--">getTableMaxRowSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#getTimeToPurgeDeletes--">getTimeToPurgeDeletes</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#getTtl--">getTtl</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#isNewVersionBehavior--">isNewVersionBehavior</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>(package private) boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#isParallelSeekEnabled--">isParallelSeekEnabled</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>(package private) boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html#isUsePread--">isUsePread</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="family">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>family</h4>
<pre>private&nbsp;byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.37">family</a></pre>
</li>
</ul>
<a name="minVersions">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minVersions</h4>
<pre>private&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.38">minVersions</a></pre>
</li>
</ul>
<a name="maxVersions">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxVersions</h4>
<pre>private&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.39">maxVersions</a></pre>
</li>
</ul>
<a name="ttl">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ttl</h4>
<pre>private&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.40">ttl</a></pre>
</li>
</ul>
<a name="keepDeletedCells">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keepDeletedCells</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.41">keepDeletedCells</a></pre>
</li>
</ul>
<a name="timeToPurgeDeletes">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>timeToPurgeDeletes</h4>
<pre>private&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.42">timeToPurgeDeletes</a></pre>
</li>
</ul>
<a name="comparator">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>comparator</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.43">comparator</a></pre>
</li>
</ul>
<a name="tableMaxRowSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tableMaxRowSize</h4>
<pre>private&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.44">tableMaxRowSize</a></pre>
</li>
</ul>
<a name="usePread">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>usePread</h4>
<pre>private&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.45">usePread</a></pre>
</li>
</ul>
<a name="cellsPerTimeoutCheck">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cellsPerTimeoutCheck</h4>
<pre>private&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.46">cellsPerTimeoutCheck</a></pre>
</li>
</ul>
<a name="parallelSeekEnabled">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parallelSeekEnabled</h4>
<pre>private&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.47">parallelSeekEnabled</a></pre>
</li>
</ul>
<a name="preadMaxBytes">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preadMaxBytes</h4>
<pre>private final&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.48">preadMaxBytes</a></pre>
</li>
</ul>
<a name="newVersionBehavior">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newVersionBehavior</h4>
<pre>private final&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.49">newVersionBehavior</a></pre>
</li>
</ul>
<a name="FIXED_OVERHEAD">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FIXED_OVERHEAD</h4>
<pre>public static final&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.51">FIXED_OVERHEAD</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ScanInfo-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.ColumnFamilyDescriptor-long-long-org.apache.hadoop.hbase.CellComparator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ScanInfo</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.63">ScanInfo</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="../../../../../org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client">ColumnFamilyDescriptor</a>&nbsp;family,
long&nbsp;ttl,
long&nbsp;timeToPurgeDeletes,
<a href="../../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;comparator)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - </dd>
<dd><code>family</code> - <a href="../../../../../org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client"><code>ColumnFamilyDescriptor</code></a> describing the column family</dd>
<dd><code>ttl</code> - Store's TTL (in ms)</dd>
<dd><code>timeToPurgeDeletes</code> - duration in ms after which a delete marker can be purged during a
major compaction.</dd>
<dd><code>comparator</code> - The store's comparator</dd>
</dl>
</li>
</ul>
<a name="ScanInfo-org.apache.hadoop.conf.Configuration-byte:A-int-int-long-org.apache.hadoop.hbase.KeepDeletedCells-long-long-org.apache.hadoop.hbase.CellComparator-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ScanInfo</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.89">ScanInfo</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
byte[]&nbsp;family,
int&nbsp;minVersions,
int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells,
long&nbsp;blockSize,
long&nbsp;timeToPurgeDeletes,
<a href="../../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;comparator,
boolean&nbsp;newVersionBehavior)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - </dd>
<dd><code>family</code> - Name of this store's column family</dd>
<dd><code>minVersions</code> - Store's MIN_VERSIONS setting</dd>
<dd><code>maxVersions</code> - Store's VERSIONS setting</dd>
<dd><code>ttl</code> - Store's TTL (in ms)</dd>
<dd><code>blockSize</code> - Store's block size</dd>
<dd><code>timeToPurgeDeletes</code> - duration in ms after which a delete marker can
be purged during a major compaction.</dd>
<dd><code>keepDeletedCells</code> - Store's keepDeletedCells setting</dd>
<dd><code>comparator</code> - The store's comparator</dd>
</dl>
</li>
</ul>
<a name="ScanInfo-byte:A-int-int-long-org.apache.hadoop.hbase.KeepDeletedCells-long-org.apache.hadoop.hbase.CellComparator-long-boolean-long-boolean-long-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ScanInfo</h4>
<pre>private&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.99">ScanInfo</a>(byte[]&nbsp;family,
int&nbsp;minVersions,
int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells,
long&nbsp;timeToPurgeDeletes,
<a href="../../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;comparator,
long&nbsp;tableMaxRowSize,
boolean&nbsp;usePread,
long&nbsp;cellsPerTimeoutCheck,
boolean&nbsp;parallelSeekEnabled,
long&nbsp;preadMaxBytes,
boolean&nbsp;newVersionBehavior)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCellsPerTimeoutCheck-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCellsPerTimeoutCheck</h4>
<pre>private static&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.70">getCellsPerTimeoutCheck</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
</li>
</ul>
<a name="getTableMaxRowSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableMaxRowSize</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.118">getTableMaxRowSize</a>()</pre>
</li>
</ul>
<a name="isUsePread--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUsePread</h4>
<pre>boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.122">isUsePread</a>()</pre>
</li>
</ul>
<a name="getCellsPerTimeoutCheck--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCellsPerTimeoutCheck</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.126">getCellsPerTimeoutCheck</a>()</pre>
</li>
</ul>
<a name="isParallelSeekEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isParallelSeekEnabled</h4>
<pre>boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.130">isParallelSeekEnabled</a>()</pre>
</li>
</ul>
<a name="getFamily--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFamily</h4>
<pre>public&nbsp;byte[]&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.134">getFamily</a>()</pre>
</li>
</ul>
<a name="getMinVersions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinVersions</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.138">getMinVersions</a>()</pre>
</li>
</ul>
<a name="getMaxVersions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxVersions</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.142">getMaxVersions</a>()</pre>
</li>
</ul>
<a name="getTtl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTtl</h4>
<pre>public&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.146">getTtl</a>()</pre>
</li>
</ul>
<a name="getKeepDeletedCells--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeepDeletedCells</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.150">getKeepDeletedCells</a>()</pre>
</li>
</ul>
<a name="getTimeToPurgeDeletes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeToPurgeDeletes</h4>
<pre>public&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.154">getTimeToPurgeDeletes</a>()</pre>
</li>
</ul>
<a name="getComparator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComparator</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.158">getComparator</a>()</pre>
</li>
</ul>
<a name="getPreadMaxBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreadMaxBytes</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.162">getPreadMaxBytes</a>()</pre>
</li>
</ul>
<a name="isNewVersionBehavior--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNewVersionBehavior</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.166">isNewVersionBehavior</a>()</pre>
</li>
</ul>
<a name="customize-int-long-org.apache.hadoop.hbase.KeepDeletedCells-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>customize</h4>
<pre><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html" title="class in org.apache.hadoop.hbase.regionserver">ScanInfo</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.173">customize</a>(int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells)</pre>
<div class="block">Used by CP users for customizing max versions, ttl and keepDeletedCells.</div>
</li>
</ul>
<a name="customize-int-long-org.apache.hadoop.hbase.KeepDeletedCells-int-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>customize</h4>
<pre><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScanInfo.html" title="class in org.apache.hadoop.hbase.regionserver">ScanInfo</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line.181">customize</a>(int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells,
int&nbsp;minVersions,
long&nbsp;timeToPurgeDeletes)</pre>
<div class="block">Used by CP users for customizing max versions, ttl, keepDeletedCells, min versions,
and time to purge deletes.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ScanInfo.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/regionserver/RSRpcServices.ScannerListener.html" title="class in org.apache.hadoop.hbase.regionserver"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/regionserver/ScannerContext.html" title="class in org.apache.hadoop.hbase.regionserver"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/regionserver/ScanInfo.html" target="_top">Frames</a></li>
<li><a href="ScanInfo.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>