Google Git
Sign in
apache / kudu-site / 20adff6a1ba61227e1023004202e21bd713f8b5b / . / releases / 1.0.1 / apidocs / org / apache / kudu / client / AbstractKuduScannerBuilder.html
blob: 47845e1dd8d41981753efab8d05891b78f073825 [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>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>AbstractKuduScannerBuilder (Kudu 1.0.1 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractKuduScannerBuilder (Kudu 1.0.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/AbstractKuduScannerBuilder.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>Prev Class</li>
<li><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/kudu/client/AbstractKuduScannerBuilder.html" target="_top">Frames</a></li>
<li><a href="AbstractKuduScannerBuilder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.kudu.client</div>
<h2 title="Class AbstractKuduScannerBuilder" class="title">Class AbstractKuduScannerBuilder&lt;S extends AbstractKuduScannerBuilder&lt;? super S,T&gt;,T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/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.kudu.client.AbstractKuduScannerBuilder&lt;S,T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.AsyncKuduScannerBuilder.html" title="class in org.apache.kudu.client">AsyncKuduScanner.AsyncKuduScannerBuilder</a>, <a href="../../../../org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html" title="class in org.apache.kudu.client">KuduScanner.KuduScannerBuilder</a>, <a href="../../../../org/apache/kudu/client/KuduScanToken.KuduScanTokenBuilder.html" title="class in org.apache.kudu.client">KuduScanToken.KuduScanTokenBuilder</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Public
@InterfaceStability.Evolving
public abstract class <span class="strong">AbstractKuduScannerBuilder&lt;S extends AbstractKuduScannerBuilder&lt;? super S,T&gt;,T&gt;</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Abstract class to extend in order to create builders for scanners.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addColumnRangePredicate(org.apache.kudu.client.ColumnRangePredicate)">addColumnRangePredicate</a></strong>(<a href="../../../../org/apache/kudu/client/ColumnRangePredicate.html" title="class in org.apache.kudu.client">ColumnRangePredicate</a>&nbsp;predicate)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addPredicate(org.apache.kudu.client.KuduPredicate)"><code>addPredicate(KuduPredicate)</code></a></i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addColumnRangePredicatesRaw(byte[])">addColumnRangePredicatesRaw</a></strong>(byte[]&nbsp;predicateBytes)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addPredicate(org.apache.kudu.client.KuduPredicate)"><code>addPredicate(org.apache.kudu.client.KuduPredicate)</code></a></i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addPredicate(org.apache.kudu.client.KuduPredicate)">addPredicate</a></strong>(<a href="../../../../org/apache/kudu/client/KuduPredicate.html" title="class in org.apache.kudu.client">KuduPredicate</a>&nbsp;predicate)</code>
<div class="block">Adds a predicate to the scan.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#batchSizeBytes(int)">batchSizeBytes</a></strong>(int&nbsp;batchSizeBytes)</code>
<div class="block">Sets the maximum number of bytes returned by the scanner, on each batch.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">T</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#build()">build</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#cacheBlocks(boolean)">cacheBlocks</a></strong>(boolean&nbsp;cacheBlocks)</code>
<div class="block">Sets the block caching policy for the scanner.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#exclusiveUpperBound(org.apache.kudu.client.PartialRow)">exclusiveUpperBound</a></strong>(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a>&nbsp;partialRow)</code>
<div class="block">Add an upper bound (exclusive) primary key for the scan.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#exclusiveUpperBoundRaw(byte[])">exclusiveUpperBoundRaw</a></strong>(byte[]&nbsp;endPrimaryKey)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#exclusiveUpperBound(org.apache.kudu.client.PartialRow)"><code>exclusiveUpperBound(PartialRow)</code></a></i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#limit(long)">limit</a></strong>(long&nbsp;limit)</code>
<div class="block">Sets a limit on the number of rows that will be returned by the scanner.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#lowerBound(org.apache.kudu.client.PartialRow)">lowerBound</a></strong>(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a>&nbsp;partialRow)</code>
<div class="block">Add a lower bound (inclusive) primary key for the scan.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#lowerBoundRaw(byte[])">lowerBoundRaw</a></strong>(byte[]&nbsp;startPrimaryKey)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#lowerBound(org.apache.kudu.client.PartialRow)"><code>lowerBound(PartialRow)</code></a></i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#prefetching(boolean)">prefetching</a></strong>(boolean&nbsp;prefetching)</code>
<div class="block">Enables prefetching of rows for the scanner, i.e.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#readMode(org.apache.kudu.client.AsyncKuduScanner.ReadMode)">readMode</a></strong>(<a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a>&nbsp;readMode)</code>
<div class="block">Sets the read mode, the default is to read the latest values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#scanRequestTimeout(long)">scanRequestTimeout</a></strong>(long&nbsp;scanRequestTimeout)</code>
<div class="block">Sets how long each scan request to a server can last.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#setProjectedColumnIndexes(java.util.List)">setProjectedColumnIndexes</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;columnIndexes)</code>
<div class="block">Set which columns will be read by the Scanner.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#setProjectedColumnNames(java.util.List)">setProjectedColumnNames</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;columnNames)</code>
<div class="block">Set which columns will be read by the Scanner.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#snapshotTimestampMicros(long)">snapshotTimestampMicros</a></strong>(long&nbsp;timestamp)</code>
<div class="block">Sets the timestamp the scan must be executed at, in microseconds since the Unix epoch.</div>
</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="readMode(org.apache.kudu.client.AsyncKuduScanner.ReadMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readMode</h4>
<pre>public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;readMode(<a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a>&nbsp;readMode)</pre>
<div class="block">Sets the read mode, the default is to read the latest values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>readMode</code> - a read mode for the scanner</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd></dl>
</li>
</ul>
<a name="addColumnRangePredicate(org.apache.kudu.client.ColumnRangePredicate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addColumnRangePredicate</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;addColumnRangePredicate(<a href="../../../../org/apache/kudu/client/ColumnRangePredicate.html" title="class in org.apache.kudu.client">ColumnRangePredicate</a>&nbsp;predicate)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addPredicate(org.apache.kudu.client.KuduPredicate)"><code>addPredicate(KuduPredicate)</code></a></i></div>
<div class="block">Adds a predicate for a column.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>predicate</code> - predicate for a column to add</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd></dl>
</li>
</ul>
<a name="addColumnRangePredicatesRaw(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addColumnRangePredicatesRaw</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;addColumnRangePredicatesRaw(byte[]&nbsp;predicateBytes)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addPredicate(org.apache.kudu.client.KuduPredicate)"><code>addPredicate(org.apache.kudu.client.KuduPredicate)</code></a></i></div>
<div class="block">Adds a list of predicates in their raw format,
as given by <a href="../../../../org/apache/kudu/client/ColumnRangePredicate.html#toByteArray(java.util.List)"><code>ColumnRangePredicate.toByteArray(List)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>predicateBytes</code> - predicates to add</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - thrown when the passed bytes aren't valid</dd></dl>
</li>
</ul>
<a name="addPredicate(org.apache.kudu.client.KuduPredicate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPredicate</h4>
<pre>public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;addPredicate(<a href="../../../../org/apache/kudu/client/KuduPredicate.html" title="class in org.apache.kudu.client">KuduPredicate</a>&nbsp;predicate)</pre>
<div class="block">Adds a predicate to the scan.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>predicate</code> - predicate to add</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd></dl>
</li>
</ul>
<a name="setProjectedColumnNames(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProjectedColumnNames</h4>
<pre>public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;setProjectedColumnNames(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;columnNames)</pre>
<div class="block">Set which columns will be read by the Scanner.
Calling this method after <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#setProjectedColumnIndexes(java.util.List)"><code>setProjectedColumnIndexes(List)</code></a> will reset the projected
columns to those specified in <code>columnNames</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>columnNames</code> - the names of columns to read, or 'null' to read all columns
(the default)</dd></dl>
</li>
</ul>
<a name="setProjectedColumnIndexes(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProjectedColumnIndexes</h4>
<pre>public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;setProjectedColumnIndexes(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;columnIndexes)</pre>
<div class="block">Set which columns will be read by the Scanner.
Calling this method after <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#setProjectedColumnNames(java.util.List)"><code>setProjectedColumnNames(List)</code></a> will reset the projected
columns to those specified in <code>columnIndexes</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>columnIndexes</code> - the indexes of columns to read, or 'null' to read all columns
(the default)</dd></dl>
</li>
</ul>
<a name="batchSizeBytes(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>batchSizeBytes</h4>
<pre>public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;batchSizeBytes(int&nbsp;batchSizeBytes)</pre>
<div class="block">Sets the maximum number of bytes returned by the scanner, on each batch. The default is 1MB.
<p>
Kudu may actually return more than this many bytes because it will not
truncate a rowResult in the middle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>batchSizeBytes</code> - a strictly positive number of bytes</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd></dl>
</li>
</ul>
<a name="limit(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>limit</h4>
<pre>public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;limit(long&nbsp;limit)</pre>
<div class="block">Sets a limit on the number of rows that will be returned by the scanner. There's no limit
by default.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>limit</code> - a positive long</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd></dl>
</li>
</ul>
<a name="prefetching(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prefetching</h4>
<pre>public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;prefetching(boolean&nbsp;prefetching)</pre>
<div class="block">Enables prefetching of rows for the scanner, i.e. whether to send a request for more data
to the server immediately after we receive a response (instead of waiting for the user
to call <code>nextRows()</code>). Disabled by default.
NOTE: This is risky until KUDU-1260 is resolved.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefetching</code> - a boolean that indicates if the scanner should prefetch rows</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd></dl>
</li>
</ul>
<a name="cacheBlocks(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cacheBlocks</h4>
<pre>public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;cacheBlocks(boolean&nbsp;cacheBlocks)</pre>
<div class="block">Sets the block caching policy for the scanner. If true, scanned data blocks will be cached
in memory and made available for future scans. Enabled by default.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cacheBlocks</code> - a boolean that indicates if data blocks should be cached or not</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd></dl>
</li>
</ul>
<a name="snapshotTimestampMicros(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>snapshotTimestampMicros</h4>
<pre>public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;snapshotTimestampMicros(long&nbsp;timestamp)</pre>
<div class="block">Sets the timestamp the scan must be executed at, in microseconds since the Unix epoch. None is
used by default.
Requires that the ReadMode is READ_AT_SNAPSHOT.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timestamp</code> - a long representing an instant in microseconds since the unix epoch.</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - on build(), if the timestamp is less than 0 or if the
read mode was not set to READ_AT_SNAPSHOT</dd></dl>
</li>
</ul>
<a name="scanRequestTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scanRequestTimeout</h4>
<pre>public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;scanRequestTimeout(long&nbsp;scanRequestTimeout)</pre>
<div class="block">Sets how long each scan request to a server can last.
Defaults to <a href="../../../../org/apache/kudu/client/KuduClient.html#getDefaultOperationTimeoutMs()"><code>KuduClient.getDefaultOperationTimeoutMs()</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scanRequestTimeout</code> - a long representing time in milliseconds</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd></dl>
</li>
</ul>
<a name="lowerBound(org.apache.kudu.client.PartialRow)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lowerBound</h4>
<pre>public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;lowerBound(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a>&nbsp;partialRow)</pre>
<div class="block">Add a lower bound (inclusive) primary key for the scan.
If any bound is already added, this bound is intersected with that one.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>partialRow</code> - a partial row with specified key columns</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd></dl>
</li>
</ul>
<a name="lowerBoundRaw(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lowerBoundRaw</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;lowerBoundRaw(byte[]&nbsp;startPrimaryKey)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#lowerBound(org.apache.kudu.client.PartialRow)"><code>lowerBound(PartialRow)</code></a></i></div>
<div class="block">Like lowerBoundPrimaryKey() but the encoded primary key is an opaque byte array obtained elsewhere.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>startPrimaryKey</code> - bytes containing an encoded start key</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd></dl>
</li>
</ul>
<a name="exclusiveUpperBound(org.apache.kudu.client.PartialRow)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exclusiveUpperBound</h4>
<pre>public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;exclusiveUpperBound(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a>&nbsp;partialRow)</pre>
<div class="block">Add an upper bound (exclusive) primary key for the scan.
If any bound is already added, this bound is intersected with that one.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>partialRow</code> - a partial row with specified key columns</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd></dl>
</li>
</ul>
<a name="exclusiveUpperBoundRaw(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exclusiveUpperBoundRaw</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a>&nbsp;exclusiveUpperBoundRaw(byte[]&nbsp;endPrimaryKey)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#exclusiveUpperBound(org.apache.kudu.client.PartialRow)"><code>exclusiveUpperBound(PartialRow)</code></a></i></div>
<div class="block">Like exclusiveUpperBound() but the encoded primary key is an opaque byte array obtained elsewhere.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>endPrimaryKey</code> - bytes containing an encoded end key</dd>
<dt><span class="strong">Returns:</span></dt><dd>this instance</dd></dl>
</li>
</ul>
<a name="build()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre>public abstract&nbsp;<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">T</a>&nbsp;build()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/AbstractKuduScannerBuilder.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>Prev Class</li>
<li><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/kudu/client/AbstractKuduScannerBuilder.html" target="_top">Frames</a></li>
<li><a href="AbstractKuduScannerBuilder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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; 2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>