http://git-wip-us.apache.org/repos/asf/kudu/blob/ce7ab97e/releases/1.4.0/apidocs/org/apache/kudu/class-use/Type.html ---------------------------------------------------------------------- diff --git a/releases/1.4.0/apidocs/org/apache/kudu/class-use/Type.html b/releases/1.4.0/apidocs/org/apache/kudu/class-use/Type.html new file mode 100644 index 0000000..5b54ead --- /dev/null +++ b/releases/1.4.0/apidocs/org/apache/kudu/class-use/Type.html @@ -0,0 +1,248 @@ +<!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>Uses of Class org.apache.kudu.Type (Kudu 1.4.0 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="Uses of Class org.apache.kudu.Type (Kudu 1.4.0 API)"; + } + } + catch(err) { + } +//--> +</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><a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kudu/class-use/Type.html" target="_top">Frames</a></li> +<li><a href="Type.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.kudu.Type" class="title">Uses of Class<br>org.apache.kudu.Type</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.kudu">org.apache.kudu</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.kudu.client">org.apache.kudu.client</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.kudu"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a> in <a href="../../../../org/apache/kudu/package-summary.html">org.apache.kudu</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../org/apache/kudu/package-summary.html">org.apache.kudu</a> that return <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a></code></td> +<td class="colLast"><span class="typeNameLabel">ColumnSchema.</span><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/ColumnSchema.html#getType--">getType</a></span>()</code> +<div class="block">Get the column's Type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a></code></td> +<td class="colLast"><span class="typeNameLabel">Type.</span><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/Type.html#getTypeForDataType-org.apache.kudu.Common.DataType-">getTypeForDataType</a></span>(org.apache.kudu.Common.DataType type)</code> +<div class="block">Convert the pb DataType to a Type</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a></code></td> +<td class="colLast"><span class="typeNameLabel">Type.</span><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/Type.html#valueOf-java.lang.String-">valueOf</a></span>(<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> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a>[]</code></td> +<td class="colLast"><span class="typeNameLabel">Type.</span><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/Type.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.kudu.client"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a> in <a href="../../../../org/apache/kudu/client/package-summary.html">org.apache.kudu.client</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../org/apache/kudu/client/package-summary.html">org.apache.kudu.client</a> that return <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a></code></td> +<td class="colLast"><span class="typeNameLabel">RowResult.</span><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/RowResult.html#getColumnType-int-">getColumnType</a></span>(int columnIndex)</code> +<div class="block">Get the type of a column in this result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a></code></td> +<td class="colLast"><span class="typeNameLabel">RowResult.</span><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/RowResult.html#getColumnType-java.lang.String-">getColumnType</a></span>(<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> columnName)</code> +<div class="block">Get the type of a column in this result.</div> +</td> +</tr> +</tbody> +</table> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../org/apache/kudu/client/package-summary.html">org.apache.kudu.client</a> with parameters of type <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> +<td class="colLast"><span class="typeNameLabel">AlterTableOptions.</span><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#addColumn-java.lang.String-org.apache.kudu.Type-java.lang.Object-">addColumn</a></span>(<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> name, + <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a> type, + <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> defaultVal)</code> +<div class="block">Add a new column that's not nullable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> +<td class="colLast"><span class="typeNameLabel">AlterTableOptions.</span><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#addNullableColumn-java.lang.String-org.apache.kudu.Type-">addNullableColumn</a></span>(<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> name, + <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a> type)</code> +<div class="block">Add a new column that's nullable and has no default value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> +<td class="colLast"><span class="typeNameLabel">AlterTableOptions.</span><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#addNullableColumn-java.lang.String-org.apache.kudu.Type-java.lang.Object-">addNullableColumn</a></span>(<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> name, + <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a> type, + <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> defaultVal)</code> +<div class="block">Add a new column that's nullable.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/kudu/class-use/Type.html" target="_top">Frames</a></li> +<li><a href="Type.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/kudu/blob/ce7ab97e/releases/1.4.0/apidocs/org/apache/kudu/client/AbstractKuduScannerBuilder.html ---------------------------------------------------------------------- diff --git a/releases/1.4.0/apidocs/org/apache/kudu/client/AbstractKuduScannerBuilder.html b/releases/1.4.0/apidocs/org/apache/kudu/client/AbstractKuduScannerBuilder.html new file mode 100644 index 0000000..f24245c --- /dev/null +++ b/releases/1.4.0/apidocs/org/apache/kudu/client/AbstractKuduScannerBuilder.html @@ -0,0 +1,692 @@ +<!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>AbstractKuduScannerBuilder (Kudu 1.4.0 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="AbstractKuduScannerBuilder (Kudu 1.4.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":42,"i1":42,"i2":10,"i3":10,"i4":6,"i5":10,"i6":10,"i7":42,"i8":10,"i9":10,"i10":42,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/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="typeNameLink">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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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<S extends AbstractKuduScannerBuilder<? super S,T>,T></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<S,T></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="typeNameLabel">AbstractKuduScannerBuilder<S extends AbstractKuduScannerBuilder<? super S,T>,T></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="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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addColumnRangePredicate-org.apache.kudu.client.ColumnRangePredicate-">addColumnRangePredicate</a></span>(<a href="../../../../org/apache/kudu/client/ColumnRangePredicate.html" title="class in org.apache.kudu.client">ColumnRangePredicate</a> predicate)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addPredicate-org.apache.kudu.client.KuduPredicate-"><code>addPredicate(KuduPredicate)</code></a></span></div> +</div> +</td> +</tr> +<tr id="i1" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addColumnRangePredicatesRaw-byte:A-">addColumnRangePredicatesRaw</a></span>(byte[] predicateBytes)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addPredicate-org.apache.kudu.client.KuduPredicate-"><code>addPredicate(org.apache.kudu.client.KuduPredicate)</code></a></span></div> +</div> +</td> +</tr> +<tr id="i2" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addPredicate-org.apache.kudu.client.KuduPredicate-">addPredicate</a></span>(<a href="../../../../org/apache/kudu/client/KuduPredicate.html" title="class in org.apache.kudu.client">KuduPredicate</a> predicate)</code> +<div class="block">Adds a predicate to the scan.</div> +</td> +</tr> +<tr id="i3" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#batchSizeBytes-int-">batchSizeBytes</a></span>(int batchSizeBytes)</code> +<div class="block">Sets the maximum number of bytes returned by the scanner, on each batch.</div> +</td> +</tr> +<tr id="i4" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#build--">build</a></span>()</code> </td> +</tr> +<tr id="i5" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#cacheBlocks-boolean-">cacheBlocks</a></span>(boolean cacheBlocks)</code> +<div class="block">Sets the block caching policy for the scanner.</div> +</td> +</tr> +<tr id="i6" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#exclusiveUpperBound-org.apache.kudu.client.PartialRow-">exclusiveUpperBound</a></span>(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> partialRow)</code> +<div class="block">Add an upper bound (exclusive) primary key for the scan.</div> +</td> +</tr> +<tr id="i7" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#exclusiveUpperBoundRaw-byte:A-">exclusiveUpperBoundRaw</a></span>(byte[] endPrimaryKey)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#exclusiveUpperBound-org.apache.kudu.client.PartialRow-"><code>exclusiveUpperBound(PartialRow)</code></a></span></div> +</div> +</td> +</tr> +<tr id="i8" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#limit-long-">limit</a></span>(long limit)</code> +<div class="block">Sets a limit on the number of rows that will be returned by the scanner.</div> +</td> +</tr> +<tr id="i9" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#lowerBound-org.apache.kudu.client.PartialRow-">lowerBound</a></span>(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> partialRow)</code> +<div class="block">Add a lower bound (inclusive) primary key for the scan.</div> +</td> +</tr> +<tr id="i10" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#lowerBoundRaw-byte:A-">lowerBoundRaw</a></span>(byte[] startPrimaryKey)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#lowerBound-org.apache.kudu.client.PartialRow-"><code>lowerBound(PartialRow)</code></a></span></div> +</div> +</td> +</tr> +<tr id="i11" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#prefetching-boolean-">prefetching</a></span>(boolean prefetching)</code> +<div class="block">Enables prefetching of rows for the scanner, i.e.</div> +</td> +</tr> +<tr id="i12" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#readMode-org.apache.kudu.client.AsyncKuduScanner.ReadMode-">readMode</a></span>(<a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a> readMode)</code> +<div class="block">Sets the read mode, the default is to read the latest values.</div> +</td> +</tr> +<tr id="i13" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#replicaSelection-org.apache.kudu.client.ReplicaSelection-">replicaSelection</a></span>(<a href="../../../../org/apache/kudu/client/ReplicaSelection.html" title="enum in org.apache.kudu.client">ReplicaSelection</a> replicaSelection)</code> +<div class="block">Sets the replica selection mechanism for this scanner.</div> +</td> +</tr> +<tr id="i14" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#scanRequestTimeout-long-">scanRequestTimeout</a></span>(long scanRequestTimeout)</code> +<div class="block">Sets how long each scan request to a server can last.</div> +</td> +</tr> +<tr id="i15" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#setFaultTolerant-boolean-">setFaultTolerant</a></span>(boolean isFaultTolerant)</code> +<div class="block">Make scans resumable at another tablet server if current server fails if + isFaultTolerant is true.</div> +</td> +</tr> +<tr id="i16" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#setProjectedColumnIndexes-java.util.List-">setProjectedColumnIndexes</a></span>(<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><<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>> columnIndexes)</code> +<div class="block">Set which columns will be read by the Scanner.</div> +</td> +</tr> +<tr id="i17" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#setProjectedColumnNames-java.util.List-">setProjectedColumnNames</a></span>(<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><<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>> columnNames)</code> +<div class="block">Set which columns will be read by the Scanner.</div> +</td> +</tr> +<tr id="i18" 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><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#snapshotTimestampMicros-long-">snapshotTimestampMicros</a></span>(long 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 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-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"> +<!-- ============ 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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> readMode(<a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a> readMode)</pre> +<div class="block">Sets the read mode, the default is to read the latest values.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>readMode</code> - a read mode for the scanner</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this instance</dd> +</dl> +</li> +</ul> +<a name="setFaultTolerant-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFaultTolerant</h4> +<pre>public <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> setFaultTolerant(boolean isFaultTolerant)</pre> +<div class="block">Make scans resumable at another tablet server if current server fails if + isFaultTolerant is true. + <p> + Scans are by default non fault-tolerant, and scans will fail + if scanning an individual tablet fails (for example, if a tablet server + crashes in the middle of a tablet scan). If isFaultTolerant is set to true, + scans will be resumed at another tablet server in the case of failure. + + Fault-tolerant scans typically have lower throughput than non + fault-tolerant scans. Fault tolerant scans use READ_AT_SNAPSHOT read mode. + If no snapshot timestamp is provided, the server will pick one.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>isFaultTolerant</code> - a boolean that indicates if scan is fault-tolerant</dd> +<dt><span class="returnLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> addColumnRangePredicate(<a href="../../../../org/apache/kudu/client/ColumnRangePredicate.html" title="class in org.apache.kudu.client">ColumnRangePredicate</a> predicate)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addPredicate-org.apache.kudu.client.KuduPredicate-"><code>addPredicate(KuduPredicate)</code></a></span></div> +<div class="block">Adds a predicate for a column.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>predicate</code> - predicate for a column to add</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this instance</dd> +</dl> +</li> +</ul> +<a name="addColumnRangePredicatesRaw-byte:A-"> +<!-- --> +</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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> addColumnRangePredicatesRaw(byte[] predicateBytes)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addPredicate-org.apache.kudu.client.KuduPredicate-"><code>addPredicate(org.apache.kudu.client.KuduPredicate)</code></a></span></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="paramLabel">Parameters:</span></dt> +<dd><code>predicateBytes</code> - predicates to add</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this instance</dd> +<dt><span class="throwsLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> addPredicate(<a href="../../../../org/apache/kudu/client/KuduPredicate.html" title="class in org.apache.kudu.client">KuduPredicate</a> predicate)</pre> +<div class="block">Adds a predicate to the scan.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>predicate</code> - predicate to add</dd> +<dt><span class="returnLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> 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><<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>> 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="paramLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> 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><<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>> 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="paramLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> batchSizeBytes(int 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="paramLabel">Parameters:</span></dt> +<dd><code>batchSizeBytes</code> - a strictly positive number of bytes</dd> +<dt><span class="returnLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> limit(long 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="paramLabel">Parameters:</span></dt> +<dd><code>limit</code> - a positive long</dd> +<dt><span class="returnLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> prefetching(boolean 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="paramLabel">Parameters:</span></dt> +<dd><code>prefetching</code> - a boolean that indicates if the scanner should prefetch rows</dd> +<dt><span class="returnLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> cacheBlocks(boolean 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="paramLabel">Parameters:</span></dt> +<dd><code>cacheBlocks</code> - a boolean that indicates if data blocks should be cached or not</dd> +<dt><span class="returnLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> snapshotTimestampMicros(long 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="paramLabel">Parameters:</span></dt> +<dd><code>timestamp</code> - a long representing an instant in microseconds since the unix epoch.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this instance</dd> +<dt><span class="throwsLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> scanRequestTimeout(long 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="paramLabel">Parameters:</span></dt> +<dd><code>scanRequestTimeout</code> - a long representing time in milliseconds</dd> +<dt><span class="returnLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> lowerBound(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> 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="paramLabel">Parameters:</span></dt> +<dd><code>partialRow</code> - a partial row with specified key columns</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this instance</dd> +</dl> +</li> +</ul> +<a name="lowerBoundRaw-byte:A-"> +<!-- --> +</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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> lowerBoundRaw(byte[] startPrimaryKey)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#lowerBound-org.apache.kudu.client.PartialRow-"><code>lowerBound(PartialRow)</code></a></span></div> +<div class="block">Like lowerBoundPrimaryKey() but the encoded primary key is an opaque byte + array obtained elsewhere.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>startPrimaryKey</code> - bytes containing an encoded start key</dd> +<dt><span class="returnLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> exclusiveUpperBound(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> 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="paramLabel">Parameters:</span></dt> +<dd><code>partialRow</code> - a partial row with specified key columns</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this instance</dd> +</dl> +</li> +</ul> +<a name="exclusiveUpperBoundRaw-byte:A-"> +<!-- --> +</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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> exclusiveUpperBoundRaw(byte[] endPrimaryKey)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#exclusiveUpperBound-org.apache.kudu.client.PartialRow-"><code>exclusiveUpperBound(PartialRow)</code></a></span></div> +<div class="block">Like exclusiveUpperBound() but the encoded primary key is an opaque byte + array obtained elsewhere.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>endPrimaryKey</code> - bytes containing an encoded end key</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this instance</dd> +</dl> +</li> +</ul> +<a name="replicaSelection-org.apache.kudu.client.ReplicaSelection-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replicaSelection</h4> +<pre>public <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">S</a> replicaSelection(<a href="../../../../org/apache/kudu/client/ReplicaSelection.html" title="enum in org.apache.kudu.client">ReplicaSelection</a> replicaSelection)</pre> +<div class="block">Sets the replica selection mechanism for this scanner. The default is to read from the + currently known leader.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>replicaSelection</code> - replication selection mechanism to use</dd> +<dt><span class="returnLabel">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 <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="type parameter in AbstractKuduScannerBuilder">T</a> 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> +<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/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="typeNameLink">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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
