Google Git
Sign in
apache / hbase-site / 0082cda45f48d1755543336c908ec6d80d4ec0a9 / . / devapidocs / org / apache / hadoop / hbase / regionserver / ScanInfo.html
blob: 9c47ff290d0f18b5d771e4728f9c3267eac0f4e4 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ScanInfo (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.regionserver, class: ScanInfo">
<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/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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<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="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.regionserver</a></div>
<h1 title="Class ScanInfo" class="title">Class ScanInfo</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.hadoop.hbase.regionserver.ScanInfo</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="annotations">@Private
</span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-35">ScanInfo</a></span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">Immutable information for scans over a store.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private long</code></div>
<div class="col-second even-row-color"><code><a href="#cellsPerTimeoutCheck" class="member-name-link">cellsPerTimeoutCheck</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>private <a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></code></div>
<div class="col-second odd-row-color"><code><a href="#comparator" class="member-name-link">comparator</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="#family" class="member-name-link">family</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final long</code></div>
<div class="col-second odd-row-color"><code><a href="#FIXED_OVERHEAD" class="member-name-link">FIXED_OVERHEAD</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>private <a href="../KeepDeletedCells.html" title="enum class in org.apache.hadoop.hbase">KeepDeletedCells</a></code></div>
<div class="col-second even-row-color"><code><a href="#keepDeletedCells" class="member-name-link">keepDeletedCells</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 int</code></div>
<div class="col-second even-row-color"><code><a href="#minVersions" class="member-name-link">minVersions</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>private final boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#newVersionBehavior" class="member-name-link">newVersionBehavior</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>private boolean</code></div>
<div class="col-second even-row-color"><code><a href="#parallelSeekEnabled" class="member-name-link">parallelSeekEnabled</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>private final long</code></div>
<div class="col-second odd-row-color"><code><a href="#preadMaxBytes" class="member-name-link">preadMaxBytes</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="#tableMaxRowSize" class="member-name-link">tableMaxRowSize</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>private long</code></div>
<div class="col-second odd-row-color"><code><a href="#timeToPurgeDeletes" class="member-name-link">timeToPurgeDeletes</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="#ttl" class="member-name-link">ttl</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="#usePread" class="member-name-link">usePread</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</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 three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(byte%5B%5D,int,int,long,org.apache.hadoop.hbase.KeepDeletedCells,long,org.apache.hadoop.hbase.CellComparator,long,boolean,long,boolean,long,boolean)" class="member-name-link">ScanInfo</a><wbr>(byte[]&nbsp;family,
int&nbsp;minVersions,
int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../KeepDeletedCells.html" title="enum class in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells,
long&nbsp;timeToPurgeDeletes,
<a href="../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></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>&nbsp;</code></div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration,byte%5B%5D,int,int,long,org.apache.hadoop.hbase.KeepDeletedCells,long,long,org.apache.hadoop.hbase.CellComparator,boolean)" class="member-name-link">ScanInfo</a><wbr>(org.apache.hadoop.conf.Configuration&nbsp;conf,
byte[]&nbsp;family,
int&nbsp;minVersions,
int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../KeepDeletedCells.html" title="enum class in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells,
long&nbsp;blockSize,
long&nbsp;timeToPurgeDeletes,
<a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;comparator,
boolean&nbsp;newVersionBehavior)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.ColumnFamilyDescriptor,long,long,org.apache.hadoop.hbase.CellComparator)" class="member-name-link">ScanInfo</a><wbr>(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="../client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client">ColumnFamilyDescriptor</a>&nbsp;family,
long&nbsp;ttl,
long&nbsp;timeToPurgeDeletes,
<a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;comparator)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="ScanInfo.html" title="class in org.apache.hadoop.hbase.regionserver">ScanInfo</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#customize(int,long,org.apache.hadoop.hbase.KeepDeletedCells)" class="member-name-link">customize</a><wbr>(int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../KeepDeletedCells.html" title="enum class in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Used by CP users for customizing max versions, ttl and keepDeletedCells.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="ScanInfo.html" title="class in org.apache.hadoop.hbase.regionserver">ScanInfo</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#customize(int,long,org.apache.hadoop.hbase.KeepDeletedCells,int,long)" class="member-name-link">customize</a><wbr>(int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../KeepDeletedCells.html" title="enum class in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells,
int&nbsp;minVersions,
long&nbsp;timeToPurgeDeletes)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Used by CP users for customizing max versions, ttl, keepDeletedCells, min versions, and time to
purge deletes.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCellsPerTimeoutCheck()" class="member-name-link">getCellsPerTimeoutCheck</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-tab1 method-summary-table-tab4"><code>private static long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCellsPerTimeoutCheck(org.apache.hadoop.conf.Configuration)" class="member-name-link">getCellsPerTimeoutCheck</a><wbr>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 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="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComparator()" class="member-name-link">getComparator</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>byte[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFamily()" class="member-name-link">getFamily</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><a href="../KeepDeletedCells.html" title="enum class in org.apache.hadoop.hbase">KeepDeletedCells</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKeepDeletedCells()" class="member-name-link">getKeepDeletedCells</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>int</code></div>
<div class="col-second odd-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 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>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinVersions()" class="member-name-link">getMinVersions</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>(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="#getPreadMaxBytes()" class="member-name-link">getPreadMaxBytes</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>(package private) long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTableMaxRowSize()" class="member-name-link">getTableMaxRowSize</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>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTimeToPurgeDeletes()" class="member-name-link">getTimeToPurgeDeletes</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>long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTtl()" class="member-name-link">getTtl</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="#isNewVersionBehavior()" class="member-name-link">isNewVersionBehavior</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>(package private) boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isParallelSeekEnabled()" class="member-name-link">isParallelSeekEnabled</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>(package private) boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isUsePread()" class="member-name-link">isUsePread</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><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</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="family">
<h3>family</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/regionserver/ScanInfo.html#line-37">family</a></span></div>
</section>
</li>
<li>
<section class="detail" id="minVersions">
<h3>minVersions</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/regionserver/ScanInfo.html#line-38">minVersions</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/regionserver/ScanInfo.html#line-39">maxVersions</a></span></div>
</section>
</li>
<li>
<section class="detail" id="ttl">
<h3>ttl</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/regionserver/ScanInfo.html#line-40">ttl</a></span></div>
</section>
</li>
<li>
<section class="detail" id="keepDeletedCells">
<h3>keepDeletedCells</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../KeepDeletedCells.html" title="enum class in org.apache.hadoop.hbase">KeepDeletedCells</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-41">keepDeletedCells</a></span></div>
</section>
</li>
<li>
<section class="detail" id="timeToPurgeDeletes">
<h3>timeToPurgeDeletes</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/regionserver/ScanInfo.html#line-42">timeToPurgeDeletes</a></span></div>
</section>
</li>
<li>
<section class="detail" id="comparator">
<h3>comparator</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-43">comparator</a></span></div>
</section>
</li>
<li>
<section class="detail" id="tableMaxRowSize">
<h3>tableMaxRowSize</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/regionserver/ScanInfo.html#line-44">tableMaxRowSize</a></span></div>
</section>
</li>
<li>
<section class="detail" id="usePread">
<h3>usePread</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/regionserver/ScanInfo.html#line-45">usePread</a></span></div>
</section>
</li>
<li>
<section class="detail" id="cellsPerTimeoutCheck">
<h3>cellsPerTimeoutCheck</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/regionserver/ScanInfo.html#line-46">cellsPerTimeoutCheck</a></span></div>
</section>
</li>
<li>
<section class="detail" id="parallelSeekEnabled">
<h3>parallelSeekEnabled</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/regionserver/ScanInfo.html#line-47">parallelSeekEnabled</a></span></div>
</section>
</li>
<li>
<section class="detail" id="preadMaxBytes">
<h3>preadMaxBytes</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-48">preadMaxBytes</a></span></div>
</section>
</li>
<li>
<section class="detail" id="newVersionBehavior">
<h3>newVersionBehavior</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-49">newVersionBehavior</a></span></div>
</section>
</li>
<li>
<section class="detail" id="FIXED_OVERHEAD">
<h3>FIXED_OVERHEAD</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-51">FIXED_OVERHEAD</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;(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.ColumnFamilyDescriptor,long,long,org.apache.hadoop.hbase.CellComparator)">
<h3>ScanInfo</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-62">ScanInfo</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration&nbsp;conf,
<a href="../client/ColumnFamilyDescriptor.html" title="interface in org.apache.hadoop.hbase.client">ColumnFamilyDescriptor</a>&nbsp;family,
long&nbsp;ttl,
long&nbsp;timeToPurgeDeletes,
<a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;comparator)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>family</code> - <a href="../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>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.apache.hadoop.conf.Configuration,byte[],int,int,long,org.apache.hadoop.hbase.KeepDeletedCells,long,long,org.apache.hadoop.hbase.CellComparator,boolean)">
<h3>ScanInfo</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-88">ScanInfo</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration&nbsp;conf,
byte[]&nbsp;family,
int&nbsp;minVersions,
int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../KeepDeletedCells.html" title="enum class in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells,
long&nbsp;blockSize,
long&nbsp;timeToPurgeDeletes,
<a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;comparator,
boolean&nbsp;newVersionBehavior)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<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>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(byte[],int,int,long,org.apache.hadoop.hbase.KeepDeletedCells,long,org.apache.hadoop.hbase.CellComparator,long,boolean,long,boolean,long,boolean)">
<h3>ScanInfo</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-98">ScanInfo</a></span><wbr><span class="parameters">(byte[]&nbsp;family,
int&nbsp;minVersions,
int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../KeepDeletedCells.html" title="enum class in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells,
long&nbsp;timeToPurgeDeletes,
<a href="../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)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getCellsPerTimeoutCheck(org.apache.hadoop.conf.Configuration)">
<h3>getCellsPerTimeoutCheck</h3>
<div class="member-signature"><span class="modifiers">private static</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-69">getCellsPerTimeoutCheck</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration&nbsp;conf)</span></div>
</section>
</li>
<li>
<section class="detail" id="getTableMaxRowSize()">
<h3>getTableMaxRowSize</h3>
<div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-117">getTableMaxRowSize</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="isUsePread()">
<h3>isUsePread</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-121">isUsePread</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="getCellsPerTimeoutCheck()">
<h3>getCellsPerTimeoutCheck</h3>
<div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-125">getCellsPerTimeoutCheck</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="isParallelSeekEnabled()">
<h3>isParallelSeekEnabled</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-129">isParallelSeekEnabled</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="getFamily()">
<h3>getFamily</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/regionserver/ScanInfo.html#line-133">getFamily</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="getMinVersions()">
<h3>getMinVersions</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/regionserver/ScanInfo.html#line-137">getMinVersions</a></span>()</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/regionserver/ScanInfo.html#line-141">getMaxVersions</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="getTtl()">
<h3>getTtl</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/regionserver/ScanInfo.html#line-145">getTtl</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="getKeepDeletedCells()">
<h3>getKeepDeletedCells</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../KeepDeletedCells.html" title="enum class in org.apache.hadoop.hbase">KeepDeletedCells</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-149">getKeepDeletedCells</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="getTimeToPurgeDeletes()">
<h3>getTimeToPurgeDeletes</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/regionserver/ScanInfo.html#line-153">getTimeToPurgeDeletes</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="getComparator()">
<h3>getComparator</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-157">getComparator</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="getPreadMaxBytes()">
<h3>getPreadMaxBytes</h3>
<div class="member-signature"><span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-161">getPreadMaxBytes</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="isNewVersionBehavior()">
<h3>isNewVersionBehavior</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/regionserver/ScanInfo.html#line-165">isNewVersionBehavior</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="customize(int,long,org.apache.hadoop.hbase.KeepDeletedCells)">
<h3>customize</h3>
<div class="member-signature"><span class="return-type"><a href="ScanInfo.html" title="class in org.apache.hadoop.hbase.regionserver">ScanInfo</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-172">customize</a></span><wbr><span class="parameters">(int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../KeepDeletedCells.html" title="enum class in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells)</span></div>
<div class="block">Used by CP users for customizing max versions, ttl and keepDeletedCells.</div>
</section>
</li>
<li>
<section class="detail" id="customize(int,long,org.apache.hadoop.hbase.KeepDeletedCells,int,long)">
<h3>customize</h3>
<div class="member-signature"><span class="return-type"><a href="ScanInfo.html" title="class in org.apache.hadoop.hbase.regionserver">ScanInfo</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScanInfo.html#line-180">customize</a></span><wbr><span class="parameters">(int&nbsp;maxVersions,
long&nbsp;ttl,
<a href="../KeepDeletedCells.html" title="enum class in org.apache.hadoop.hbase">KeepDeletedCells</a>&nbsp;keepDeletedCells,
int&nbsp;minVersions,
long&nbsp;timeToPurgeDeletes)</span></div>
<div class="block">Used by CP users for customizing max versions, ttl, keepDeletedCells, min versions, and time to
purge deletes.</div>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</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/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/regionserver/ScanInfo.html#line-187">toString</a></span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</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>