http://git-wip-us.apache.org/repos/asf/kudu/blob/ce7ab97e/releases/1.4.0/apidocs/org/apache/kudu/client/AsyncKuduClient.html ---------------------------------------------------------------------- diff --git a/releases/1.4.0/apidocs/org/apache/kudu/client/AsyncKuduClient.html b/releases/1.4.0/apidocs/org/apache/kudu/client/AsyncKuduClient.html new file mode 100644 index 0000000..8d4d334 --- /dev/null +++ b/releases/1.4.0/apidocs/org/apache/kudu/client/AsyncKuduClient.html @@ -0,0 +1,957 @@ +<!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>AsyncKuduClient (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="AsyncKuduClient (Kudu 1.4.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AsyncKuduClient.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kudu/client/AlterTableResponse.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/AsyncKuduClient.AsyncKuduClientBuilder.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/AsyncKuduClient.html" target="_top">Frames</a></li> +<li><a href="AsyncKuduClient.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><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </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 AsyncKuduClient" class="title">Class AsyncKuduClient</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.AsyncKuduClient</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.Public + @InterfaceStability.Unstable +public class <span class="typeNameLabel">AsyncKuduClient</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> +implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></pre> +<div class="block">A fully asynchronous and thread-safe client for Kudu. + <p> + This client should be + instantiated only once. You can use it with any number of tables at the + same time. The only case where you should have multiple instances is when + you want to use multiple different clusters at the same time. + <p> + If you play by the rules, this client is completely + thread-safe. Read the documentation carefully to know what the requirements + are for this guarantee to apply. + <p> + This client is fully non-blocking, any blocking operation will return a + <code>Deferred</code> instance to which you can attach a <code>Callback</code> chain + that will execute when the asynchronous operation completes. + + <h1>Note regarding <code>KuduRpc</code> instances passed to this class</h1> + Every <code>KuduRpc</code> passed to a method of this class should not be + changed or re-used until the <code>Deferred</code> returned by that method + calls you back. <strong>Changing or re-using any <code>KuduRpc</code> for + an RPC in flight will lead to <em>unpredictable</em> results and voids + your warranty</strong>. + + <h1><code>throws</code> clauses</h1> + None of the asynchronous methods in this API are expected to throw an + exception. But the <code>Deferred</code> object they return to you can carry an + exception that you should handle (using "errbacks", see the javadoc of + <code>Deferred</code>). In order to be able to do proper asynchronous error + handling, you need to know what types of exceptions you're expected to face + in your errbacks. In order to document that, the methods of this API use + javadoc's <code>@throws</code> to spell out the exception types you should + handle in your errback. Asynchronous exceptions will be indicated as such + in the javadoc with "(deferred)".</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.AsyncKuduClientBuilder.html" title="class in org.apache.kudu.client">AsyncKuduClient.AsyncKuduClientBuilder</a></span></code> +<div class="block">Builder class to use in order to connect to Kudu.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#DEFAULT_OPERATION_TIMEOUT_MS">DEFAULT_OPERATION_TIMEOUT_MS</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#DEFAULT_SOCKET_READ_TIMEOUT_MS">DEFAULT_SOCKET_READ_TIMEOUT_MS</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#EMPTY_ARRAY">EMPTY_ARRAY</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static org.slf4j.Logger</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#LOG">LOG</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#NO_TIMESTAMP">NO_TIMESTAMP</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#SLEEP_TIME">SLEEP_TIME</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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></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>com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/AlterTableResponse.html" title="class in org.apache.kudu.client">AlterTableResponse</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#alterTable-java.lang.String-org.apache.kudu.client.AlterTableOptions-">alterTable</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/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> ato)</code> +<div class="block">Alter a table on the cluster as specified by the builder.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#close--">close</a></span>()</code> +<div class="block">Invokes <a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#shutdown--"><code>shutdown()</code></a> and waits.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/KuduTable.html" title="class in org.apache.kudu.client">KuduTable</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#createTable-java.lang.String-org.apache.kudu.Schema-org.apache.kudu.client.CreateTableOptions-">createTable</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/Schema.html" title="class in org.apache.kudu">Schema</a> schema, + <a href="../../../../org/apache/kudu/client/CreateTableOptions.html" title="class in org.apache.kudu.client">CreateTableOptions</a> builder)</code> +<div class="block">Create a table on the cluster with the specified name, schema, and table configurations.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/DeleteTableResponse.html" title="class in org.apache.kudu.client">DeleteTableResponse</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#deleteTable-java.lang.String-">deleteTable</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">Delete a table on the cluster with the specified name.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>com.stumbleupon.async.Deferred<byte[]></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#exportAuthenticationCredentials--">exportAuthenticationCredentials</a></span>()</code> +<div class="block">Export serialized authentication data that may be passed to a different + client instance and imported to provide that client the ability to connect + to the cluster.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#getDefaultAdminOperationTimeoutMs--">getDefaultAdminOperationTimeoutMs</a></span>()</code> +<div class="block">Get the timeout used for admin operations.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#getDefaultOperationTimeoutMs--">getDefaultOperationTimeoutMs</a></span>()</code> +<div class="block">Get the timeout used for operations on sessions and scanners.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#getDefaultSocketReadTimeoutMs--">getDefaultSocketReadTimeoutMs</a></span>()</code> +<div class="block">Get the timeout used when waiting to read data from a socket.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#getLastPropagatedTimestamp--">getLastPropagatedTimestamp</a></span>()</code> +<div class="block">Returns the last timestamp received from a server.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#getMasterAddressesAsString--">getMasterAddressesAsString</a></span>()</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/Statistics.html" title="class in org.apache.kudu.client">Statistics</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#getStatistics--">getStatistics</a></span>()</code> +<div class="block">Get the statistics object of this client.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/ListTablesResponse.html" title="class in org.apache.kudu.client">ListTablesResponse</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#getTablesList--">getTablesList</a></span>()</code> +<div class="block">Get the list of all the tables.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/ListTablesResponse.html" title="class in org.apache.kudu.client">ListTablesResponse</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#getTablesList-java.lang.String-">getTablesList</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> nameFilter)</code> +<div class="block">Get a list of table names.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#importAuthenticationCredentials-byte:A-">importAuthenticationCredentials</a></span>(byte[] authnData)</code> +<div class="block">Import data allowing this client to authenticate to the cluster.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/IsAlterTableDoneResponse.html" title="class in org.apache.kudu.client">IsAlterTableDoneResponse</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#isAlterTableDone-java.lang.String-">isAlterTableDone</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">Helper method that checks and waits until the completion of an alter command.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#isStatisticsEnabled--">isStatisticsEnabled</a></span>()</code> +<div class="block">Check if statistics collection is enabled for this client.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/ListTabletServersResponse.html" title="class in org.apache.kudu.client">ListTabletServersResponse</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#listTabletServers--">listTabletServers</a></span>()</code> +<div class="block">Get the list of running tablet servers.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.AsyncKuduScannerBuilder.html" title="class in org.apache.kudu.client">AsyncKuduScanner.AsyncKuduScannerBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#newScannerBuilder-org.apache.kudu.client.KuduTable-">newScannerBuilder</a></span>(<a href="../../../../org/apache/kudu/client/KuduTable.html" title="class in org.apache.kudu.client">KuduTable</a> table)</code> +<div class="block">Creates a new <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.AsyncKuduScannerBuilder.html" title="class in org.apache.kudu.client"><code>AsyncKuduScanner.AsyncKuduScannerBuilder</code></a> for a particular table.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AsyncKuduSession.html" title="class in org.apache.kudu.client">AsyncKuduSession</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#newSession--">newSession</a></span>()</code> +<div class="block">Create a new session for interacting with the cluster.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/KuduTable.html" title="class in org.apache.kudu.client">KuduTable</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#openTable-java.lang.String-">openTable</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">Open the table with the given name.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true"; title="class or interface in java.util">ArrayList</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#shutdown--">shutdown</a></span>()</code> +<div class="block">Performs a graceful shutdown of this instance.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/kudu/client/KuduClient.html" title="class in org.apache.kudu.client">KuduClient</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#syncClient--">syncClient</a></span>()</code> +<div class="block">Returns a synchronous <a href="../../../../org/apache/kudu/client/KuduClient.html" title="class in org.apache.kudu.client"><code>KuduClient</code></a> which wraps this asynchronous client.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#tableExists-java.lang.String-">tableExists</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">Test if a table exists.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#updateLastPropagatedTimestamp-long-">updateLastPropagatedTimestamp</a></span>(long lastPropagatedTimestamp)</code> +<div class="block">Updates the last timestamp received from a server.</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="LOG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOG</h4> +<pre>public static final org.slf4j.Logger LOG</pre> +</li> +</ul> +<a name="SLEEP_TIME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SLEEP_TIME</h4> +<pre>public static final int SLEEP_TIME</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.kudu.client.AsyncKuduClient.SLEEP_TIME">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="EMPTY_ARRAY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EMPTY_ARRAY</h4> +<pre>public static final byte[] EMPTY_ARRAY</pre> +</li> +</ul> +<a name="NO_TIMESTAMP"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NO_TIMESTAMP</h4> +<pre>public static final long NO_TIMESTAMP</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.kudu.client.AsyncKuduClient.NO_TIMESTAMP">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_OPERATION_TIMEOUT_MS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_OPERATION_TIMEOUT_MS</h4> +<pre>public static final long DEFAULT_OPERATION_TIMEOUT_MS</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.kudu.client.AsyncKuduClient.DEFAULT_OPERATION_TIMEOUT_MS">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_SOCKET_READ_TIMEOUT_MS"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DEFAULT_SOCKET_READ_TIMEOUT_MS</h4> +<pre>public static final long DEFAULT_SOCKET_READ_TIMEOUT_MS</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.kudu.client.AsyncKuduClient.DEFAULT_SOCKET_READ_TIMEOUT_MS">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="updateLastPropagatedTimestamp-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>updateLastPropagatedTimestamp</h4> +<pre>public void updateLastPropagatedTimestamp(long lastPropagatedTimestamp)</pre> +<div class="block">Updates the last timestamp received from a server. Used for CLIENT_PROPAGATED + external consistency.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>lastPropagatedTimestamp</code> - the last timestamp received from a server</dd> +</dl> +</li> +</ul> +<a name="getLastPropagatedTimestamp--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastPropagatedTimestamp</h4> +<pre>public long getLastPropagatedTimestamp()</pre> +<div class="block">Returns the last timestamp received from a server. Used for CLIENT_PROPAGATED + external consistency. Note that the returned timestamp is encoded and cannot be + interpreted as a raw timestamp.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a long indicating the specially-encoded last timestamp received from a server</dd> +</dl> +</li> +</ul> +<a name="syncClient--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>syncClient</h4> +<pre>public <a href="../../../../org/apache/kudu/client/KuduClient.html" title="class in org.apache.kudu.client">KuduClient</a> syncClient()</pre> +<div class="block">Returns a synchronous <a href="../../../../org/apache/kudu/client/KuduClient.html" title="class in org.apache.kudu.client"><code>KuduClient</code></a> which wraps this asynchronous client. + Calling <a href="../../../../org/apache/kudu/client/KuduClient.html#close--"><code>KuduClient.close()</code></a> on the returned client will close this client. + If this asynchronous client should outlive the returned synchronous client, + then do not close the synchronous client.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new synchronous <code>KuduClient</code></dd> +</dl> +</li> +</ul> +<a name="createTable-java.lang.String-org.apache.kudu.Schema-org.apache.kudu.client.CreateTableOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createTable</h4> +<pre>public com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/KuduTable.html" title="class in org.apache.kudu.client">KuduTable</a>> createTable(<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/Schema.html" title="class in org.apache.kudu">Schema</a> schema, + <a href="../../../../org/apache/kudu/client/CreateTableOptions.html" title="class in org.apache.kudu.client">CreateTableOptions</a> builder)</pre> +<div class="block">Create a table on the cluster with the specified name, schema, and table configurations. + If the primary key columns of the table schema aren't specified first, the deferred result + will be a <code>NonRecoverableException</code></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the table's name</dd> +<dd><code>schema</code> - the table's schema</dd> +<dd><code>builder</code> - a builder containing the table's configurations</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a deferred object to track the progress of the createTable command that gives + an object to communicate with the created table</dd> +</dl> +</li> +</ul> +<a name="deleteTable-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteTable</h4> +<pre>public com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/DeleteTableResponse.html" title="class in org.apache.kudu.client">DeleteTableResponse</a>> deleteTable(<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)</pre> +<div class="block">Delete a table on the cluster with the specified name.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the table's name</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a deferred object to track the progress of the deleteTable command</dd> +</dl> +</li> +</ul> +<a name="alterTable-java.lang.String-org.apache.kudu.client.AlterTableOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>alterTable</h4> +<pre>public com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/AlterTableResponse.html" title="class in org.apache.kudu.client">AlterTableResponse</a>> alterTable(<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/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> ato)</pre> +<div class="block">Alter a table on the cluster as specified by the builder. + + When the returned deferred completes it only indicates that the master accepted the alter + command, use <a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#isAlterTableDone-java.lang.String-"><code>isAlterTableDone(String)</code></a> to know when the alter finishes.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the table's name, if this is a table rename then the old table name must be passed</dd> +<dd><code>ato</code> - the alter table builder</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a deferred object to track the progress of the alter command</dd> +</dl> +</li> +</ul> +<a name="isAlterTableDone-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAlterTableDone</h4> +<pre>public com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/IsAlterTableDoneResponse.html" title="class in org.apache.kudu.client">IsAlterTableDoneResponse</a>> isAlterTableDone(<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)</pre> +<div class="block">Helper method that checks and waits until the completion of an alter command. + It will block until the alter command is done or the deadline is reached.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the table's name, if the table was renamed then that name must be checked against</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a deferred object to track the progress of the isAlterTableDone command</dd> +</dl> +</li> +</ul> +<a name="listTabletServers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listTabletServers</h4> +<pre>public com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/ListTabletServersResponse.html" title="class in org.apache.kudu.client">ListTabletServersResponse</a>> listTabletServers()</pre> +<div class="block">Get the list of running tablet servers.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a deferred object that yields a list of tablet servers</dd> +</dl> +</li> +</ul> +<a name="getTablesList--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTablesList</h4> +<pre>public com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/ListTablesResponse.html" title="class in org.apache.kudu.client">ListTablesResponse</a>> getTablesList()</pre> +<div class="block">Get the list of all the tables.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a deferred object that yields a list of all the tables</dd> +</dl> +</li> +</ul> +<a name="getTablesList-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTablesList</h4> +<pre>public com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/ListTablesResponse.html" title="class in org.apache.kudu.client">ListTablesResponse</a>> getTablesList(<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> nameFilter)</pre> +<div class="block">Get a list of table names. Passing a null filter returns all the tables. When a filter is + specified, it only returns tables that satisfy a substring match.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>nameFilter</code> - an optional table name filter</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a deferred that yields the list of table names</dd> +</dl> +</li> +</ul> +<a name="tableExists-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tableExists</h4> +<pre>public com.stumbleupon.async.Deferred<<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a>> tableExists(<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)</pre> +<div class="block">Test if a table exists.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - a non-null table name</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the table exists, else false</dd> +</dl> +</li> +</ul> +<a name="openTable-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openTable</h4> +<pre>public com.stumbleupon.async.Deferred<<a href="../../../../org/apache/kudu/client/KuduTable.html" title="class in org.apache.kudu.client">KuduTable</a>> openTable(<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)</pre> +<div class="block">Open the table with the given name. If the table was just created, the + Deferred will only get called back when all the tablets have been + successfully created. + + New range partitions created by other clients will immediately be available + after opening the table.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - table to open</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a KuduTable if the table exists, else a MasterErrorException</dd> +</dl> +</li> +</ul> +<a name="exportAuthenticationCredentials--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exportAuthenticationCredentials</h4> +<pre>@InterfaceStability.Unstable +public com.stumbleupon.async.Deferred<byte[]> exportAuthenticationCredentials()</pre> +<div class="block">Export serialized authentication data that may be passed to a different + client instance and imported to provide that client the ability to connect + to the cluster.</div> +</li> +</ul> +<a name="importAuthenticationCredentials-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>importAuthenticationCredentials</h4> +<pre>@InterfaceStability.Unstable +public void importAuthenticationCredentials(byte[] authnData)</pre> +<div class="block">Import data allowing this client to authenticate to the cluster. + This will typically be used before making any connections to servers + in the cluster. + + Note that, if this client has already been used by one user, this + method cannot be used to switch authenticated users. Attempts to + do so have undefined results, and may throw an exception.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>authnData</code> - then authentication data provided by a prior call to + <a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#exportAuthenticationCredentials--"><code>exportAuthenticationCredentials()</code></a></dd> +</dl> +</li> +</ul> +<a name="getDefaultOperationTimeoutMs--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultOperationTimeoutMs</h4> +<pre>public long getDefaultOperationTimeoutMs()</pre> +<div class="block">Get the timeout used for operations on sessions and scanners.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a timeout in milliseconds</dd> +</dl> +</li> +</ul> +<a name="getDefaultAdminOperationTimeoutMs--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultAdminOperationTimeoutMs</h4> +<pre>public long getDefaultAdminOperationTimeoutMs()</pre> +<div class="block">Get the timeout used for admin operations.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a timeout in milliseconds</dd> +</dl> +</li> +</ul> +<a name="getDefaultSocketReadTimeoutMs--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultSocketReadTimeoutMs</h4> +<pre>public long getDefaultSocketReadTimeoutMs()</pre> +<div class="block">Get the timeout used when waiting to read data from a socket. Will be triggered when nothing + has been read on a socket connected to a tablet server for <code>timeout</code> milliseconds.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a timeout in milliseconds</dd> +</dl> +</li> +</ul> +<a name="getMasterAddressesAsString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMasterAddressesAsString</h4> +<pre>public <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> getMasterAddressesAsString()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the list of master addresses, stringified using commas to separate + them</dd> +</dl> +</li> +</ul> +<a name="isStatisticsEnabled--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isStatisticsEnabled</h4> +<pre>public boolean isStatisticsEnabled()</pre> +<div class="block">Check if statistics collection is enabled for this client.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if it is enabled, else false</dd> +</dl> +</li> +</ul> +<a name="getStatistics--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStatistics</h4> +<pre>public <a href="../../../../org/apache/kudu/client/Statistics.html" title="class in org.apache.kudu.client">Statistics</a> getStatistics()</pre> +<div class="block">Get the statistics object of this client.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this client's Statistics object</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - thrown if statistics collection has been disabled</dd> +</dl> +</li> +</ul> +<a name="newScannerBuilder-org.apache.kudu.client.KuduTable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newScannerBuilder</h4> +<pre>public <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.AsyncKuduScannerBuilder.html" title="class in org.apache.kudu.client">AsyncKuduScanner.AsyncKuduScannerBuilder</a> newScannerBuilder(<a href="../../../../org/apache/kudu/client/KuduTable.html" title="class in org.apache.kudu.client">KuduTable</a> table)</pre> +<div class="block">Creates a new <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.AsyncKuduScannerBuilder.html" title="class in org.apache.kudu.client"><code>AsyncKuduScanner.AsyncKuduScannerBuilder</code></a> for a particular table.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>table</code> - the name of the table you intend to scan. + The string is assumed to use the platform's default charset.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new scanner builder for this table</dd> +</dl> +</li> +</ul> +<a name="newSession--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newSession</h4> +<pre>public <a href="../../../../org/apache/kudu/client/AsyncKuduSession.html" title="class in org.apache.kudu.client">AsyncKuduSession</a> newSession()</pre> +<div class="block">Create a new session for interacting with the cluster. + User is responsible for destroying the session object. + This is a fully local operation (no RPCs or blocking).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new AsyncKuduSession</dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Invokes <a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#shutdown--"><code>shutdown()</code></a> and waits. This method returns + void, so consider invoking shutdown directly if there's a need to handle dangling RPCs.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--"; title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - if an error happens while closing the connections</dd> +</dl> +</li> +</ul> +<a name="shutdown--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>shutdown</h4> +<pre>public com.stumbleupon.async.Deferred<<a href="http://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true"; title="class or interface in java.util">ArrayList</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>>> shutdown()</pre> +<div class="block">Performs a graceful shutdown of this instance. + <p> + <ul> + <li><a href="../../../../org/apache/kudu/client/AsyncKuduSession.html#flush--"><code>Flushes</code></a> all buffered edits.</li> + <li>Cancels all the other requests.</li> + <li>Terminates all connections.</li> + <li>Releases all other resources.</li> + </ul> + <strong>Not calling this method before losing the last reference to this + instance may result in data loss and other unwanted side effects</strong></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A <code>Deferred</code>, whose callback chain will be invoked once all + of the above have been done. If this callback chain doesn't fail, then + the clean shutdown will be successful, and all the data will be safe on + the Kudu side. In case of a failure (the "errback" is invoked) you will have + to open a new AsyncKuduClient if you want to retry those operations. + The Deferred doesn't actually hold any content.</dd> +</dl> +</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/AsyncKuduClient.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kudu/client/AlterTableResponse.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/AsyncKuduClient.AsyncKuduClientBuilder.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/AsyncKuduClient.html" target="_top">Frames</a></li> +<li><a href="AsyncKuduClient.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><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </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>
http://git-wip-us.apache.org/repos/asf/kudu/blob/ce7ab97e/releases/1.4.0/apidocs/org/apache/kudu/client/AsyncKuduScanner.AsyncKuduScannerBuilder.html ---------------------------------------------------------------------- diff --git a/releases/1.4.0/apidocs/org/apache/kudu/client/AsyncKuduScanner.AsyncKuduScannerBuilder.html b/releases/1.4.0/apidocs/org/apache/kudu/client/AsyncKuduScanner.AsyncKuduScannerBuilder.html new file mode 100644 index 0000000..98b9488 --- /dev/null +++ b/releases/1.4.0/apidocs/org/apache/kudu/client/AsyncKuduScanner.AsyncKuduScannerBuilder.html @@ -0,0 +1,267 @@ +<!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>AsyncKuduScanner.AsyncKuduScannerBuilder (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="AsyncKuduScanner.AsyncKuduScannerBuilder (Kudu 1.4.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AsyncKuduScanner.AsyncKuduScannerBuilder.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum 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/AsyncKuduScanner.AsyncKuduScannerBuilder.html" target="_top">Frames</a></li> +<li><a href="AsyncKuduScanner.AsyncKuduScannerBuilder.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 AsyncKuduScanner.AsyncKuduScannerBuilder" class="title">Class AsyncKuduScanner.AsyncKuduScannerBuilder</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><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="class in org.apache.kudu.client">org.apache.kudu.client.AbstractKuduScannerBuilder</a><<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/AsyncKuduScanner.html" title="class in org.apache.kudu.client">AsyncKuduScanner</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.kudu.client.AsyncKuduScanner.AsyncKuduScannerBuilder</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.html" title="class in org.apache.kudu.client">AsyncKuduScanner</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.Public + @InterfaceStability.Evolving +public static class <span class="typeNameLabel">AsyncKuduScanner.AsyncKuduScannerBuilder</span> +extends <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="class in org.apache.kudu.client">AbstractKuduScannerBuilder</a><<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/AsyncKuduScanner.html" title="class in org.apache.kudu.client">AsyncKuduScanner</a>></pre> +<div class="block">A Builder class to build <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.html" title="class in org.apache.kudu.client"><code>AsyncKuduScanner</code></a>. + Use <a href="../../../../org/apache/kudu/client/AsyncKuduClient.html#newScannerBuilder-org.apache.kudu.client.KuduTable-"><code>AsyncKuduClient.newScannerBuilder(org.apache.kudu.client.KuduTable)</code></a> in order to get a builder instance.</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/AsyncKuduScanner.html" title="class in org.apache.kudu.client">AsyncKuduScanner</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.AsyncKuduScannerBuilder.html#build--">build</a></span>()</code> +<div class="block">Builds an <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.html" title="class in org.apache.kudu.client"><code>AsyncKuduScanner</code></a> using the passed configurations.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.kudu.client.AbstractKuduScannerBuilder"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.kudu.client.<a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="class in org.apache.kudu.client">AbstractKuduScannerBuilder</a></h3> +<code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addColumnRangePredicate-org.apache.kudu.client.ColumnRangePredicate-">addColumnRangePredicate</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addColumnRangePredicatesRaw-byte:A-">addColumnRangePredicatesRaw</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#addPredicate-org.apache.kudu.client.KuduPredicate-">addPredicate</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#batchSizeBytes-int-">batchSizeBytes</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#cacheBlocks-boolean-">cacheBlocks</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#exclusiveUpperBound-org.apache.kudu.client.PartialRow-">exclusiveUpperBound</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#exclusiveUpperBoundRaw-byte:A-">exclusiveUpperBoundRaw</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#limit-long-">limit</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#lowerBound-org.apache.kudu.client.PartialRow-">lowerBound</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#lowerBoundRaw-byte:A-">lowerBoundRaw</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#prefetching-boolean-">prefetching</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#readMode-org.apache.kudu.client.AsyncKuduScanner.ReadMode-">readMode</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#replicaSelection-org.apache.kudu.client.ReplicaSelection-">replicaSelection</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#scanRequestTimeout-long-">scanRequestTimeout</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#setFaultToleran t-boolean-">setFaultTolerant</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#setProjectedColumnIndexes-java.util.List-">setProjectedColumnIndexes</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#setProjectedColumnNames-java.util.List-">setProjectedColumnNames</a>, <a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#snapshotTimestampMicros-long-">snapshotTimestampMicros</a></code></li> +</ul> +<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="build--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.html" title="class in org.apache.kudu.client">AsyncKuduScanner</a> build()</pre> +<div class="block">Builds an <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.html" title="class in org.apache.kudu.client"><code>AsyncKuduScanner</code></a> using the passed configurations.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html#build--">build</a></code> in class <code><a href="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="class in org.apache.kudu.client">AbstractKuduScannerBuilder</a><<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/AsyncKuduScanner.html" title="class in org.apache.kudu.client">AsyncKuduScanner</a>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.html" title="class in org.apache.kudu.client"><code>AsyncKuduScanner</code></a></dd> +</dl> +</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/AsyncKuduScanner.AsyncKuduScannerBuilder.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum 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/AsyncKuduScanner.AsyncKuduScannerBuilder.html" target="_top">Frames</a></li> +<li><a href="AsyncKuduScanner.AsyncKuduScannerBuilder.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> http://git-wip-us.apache.org/repos/asf/kudu/blob/ce7ab97e/releases/1.4.0/apidocs/org/apache/kudu/client/AsyncKuduScanner.ReadMode.html ---------------------------------------------------------------------- diff --git a/releases/1.4.0/apidocs/org/apache/kudu/client/AsyncKuduScanner.ReadMode.html b/releases/1.4.0/apidocs/org/apache/kudu/client/AsyncKuduScanner.ReadMode.html new file mode 100644 index 0000000..16b8c1d --- /dev/null +++ b/releases/1.4.0/apidocs/org/apache/kudu/client/AsyncKuduScanner.ReadMode.html @@ -0,0 +1,377 @@ +<!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>AsyncKuduScanner.ReadMode (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="AsyncKuduScanner.ReadMode (Kudu 1.4.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AsyncKuduScanner.ReadMode.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.AsyncKuduScannerBuilder.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/AsyncKuduSession.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/AsyncKuduScanner.ReadMode.html" target="_top">Frames</a></li> +<li><a href="AsyncKuduScanner.ReadMode.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><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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="Enum AsyncKuduScanner.ReadMode" class="title">Enum AsyncKuduScanner.ReadMode</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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.kudu.client.AsyncKuduScanner.ReadMode</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.html" title="class in org.apache.kudu.client">AsyncKuduScanner</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.Public + @InterfaceStability.Evolving +public static enum <span class="typeNameLabel">AsyncKuduScanner.ReadMode</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a>></pre> +<div class="block">The possible read modes for scanners.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html#READ_AT_SNAPSHOT">READ_AT_SNAPSHOT</a></span></code> +<div class="block">When READ_AT_SNAPSHOT is specified the server will attempt to perform a read + at the provided timestamp.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html#READ_LATEST">READ_LATEST</a></span></code> +<div class="block">When READ_LATEST is specified the server will always return committed writes at + the time the request was received.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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></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>static <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.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 id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.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> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#compareTo-E-"; title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.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/Enum.html?is-external=true#getDeclaringClass--"; title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal--"; title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-"; title="class or interface in java.lang">valueOf</a></code></li> +</ul> +<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#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#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#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"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="READ_LATEST"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>READ_LATEST</h4> +<pre>public static final <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a> READ_LATEST</pre> +<div class="block">When READ_LATEST is specified the server will always return committed writes at + the time the request was received. This type of read does not return a snapshot + timestamp and is not repeatable. + + In ACID terms this corresponds to Isolation mode: "Read Committed" + + This is the default mode.</div> +</li> +</ul> +<a name="READ_AT_SNAPSHOT"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>READ_AT_SNAPSHOT</h4> +<pre>public static final <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a> READ_AT_SNAPSHOT</pre> +<div class="block">When READ_AT_SNAPSHOT is specified the server will attempt to perform a read + at the provided timestamp. If no timestamp is provided the server will take the + current time as the snapshot timestamp. In this mode reads are repeatable, i.e. + all future reads at the same timestamp will yield the same data. This is + performed at the expense of waiting for in-flight transactions whose timestamp + is lower than the snapshot's timestamp to complete, so it might incur a latency + penalty. + + In ACID terms this, by itself, corresponds to Isolation mode "Repeatable + Read". If all writes to the scanned tablet are made externally consistent, + then this corresponds to Isolation mode "Strict-Serializable". + + Note: there currently "holes", which happen in rare edge conditions, by which writes + are sometimes not externally consistent even when action was taken to make them so. + In these cases Isolation may degenerate to mode "Read Committed". See KUDU-430.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (AsyncKuduScanner.ReadMode c : AsyncKuduScanner.ReadMode.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../org/apache/kudu/client/AsyncKuduScanner.ReadMode.html" title="enum in org.apache.kudu.client">AsyncKuduScanner.ReadMode</a> valueOf(<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)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</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> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true"; title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd> +</dl> +</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/AsyncKuduScanner.ReadMode.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/kudu/client/AsyncKuduScanner.AsyncKuduScannerBuilder.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/AsyncKuduSession.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/AsyncKuduScanner.ReadMode.html" target="_top">Frames</a></li> +<li><a href="AsyncKuduScanner.ReadMode.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><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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>
