| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>AsyncKuduClient (Kudu 0.8.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AsyncKuduClient (Kudu 0.8.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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/kududb/client/AlterTableResponse.html" title="class in org.kududb.client"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/kududb/client/AsyncKuduScanner.html" title="class in org.kududb.client"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/kududb/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>Nested | </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.kududb.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.kududb.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="strong">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"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" 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><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#DEFAULT_OPERATION_TIMEOUT_MS">DEFAULT_OPERATION_TIMEOUT_MS</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#DEFAULT_SOCKET_READ_TIMEOUT_MS">DEFAULT_SOCKET_READ_TIMEOUT_MS</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#EMPTY_ARRAY">EMPTY_ARRAY</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#LOG">LOG</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#NO_TIMESTAMP">NO_TIMESTAMP</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#SLEEP_TIME">SLEEP_TIME</a></strong></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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</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> |
| <tr class="altColor"> |
| <td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../org/kududb/client/AlterTableResponse.html" title="class in org.kududb.client">AlterTableResponse</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#alterTable(java.lang.String,%20org.kududb.client.AlterTableOptions)">alterTable</a></strong>(<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/kududb/client/AlterTableOptions.html" title="class in org.kududb.client">AlterTableOptions</a> ato)</code> |
| <div class="block">Alter a table on the cluster as specified by the builder.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#close()">close</a></strong>()</code> |
| <div class="block">Invokes <a href="../../../org/kududb/client/AsyncKuduClient.html#shutdown()"><code>shutdown()</code></a> and waits for the configured admin timeout.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#createTable(java.lang.String,%20org.kududb.Schema)">createTable</a></strong>(<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/kududb/Schema.html" title="class in org.kududb">Schema</a> schema)</code> |
| <div class="block">Create a table on the cluster with the specified name and schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#createTable(java.lang.String,%20org.kududb.Schema,%20org.kududb.client.CreateTableOptions)">createTable</a></strong>(<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/kududb/Schema.html" title="class in org.kududb">Schema</a> schema, |
| <a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.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 class="altColor"> |
| <td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../org/kududb/client/DeleteTableResponse.html" title="class in org.kududb.client">DeleteTableResponse</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#deleteTable(java.lang.String)">deleteTable</a></strong>(<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 class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#getDefaultAdminOperationTimeoutMs()">getDefaultAdminOperationTimeoutMs</a></strong>()</code> |
| <div class="block">Get the timeout used for admin operations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#getDefaultOperationTimeoutMs()">getDefaultOperationTimeoutMs</a></strong>()</code> |
| <div class="block">Get the timeout used for operations on sessions and scanners.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#getDefaultSocketReadTimeoutMs()">getDefaultSocketReadTimeoutMs</a></strong>()</code> |
| <div class="block">Get the timeout used when waiting to read data from a socket.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#getLastPropagatedTimestamp()">getLastPropagatedTimestamp</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../org/kududb/client/ListTablesResponse.html" title="class in org.kududb.client">ListTablesResponse</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#getTablesList()">getTablesList</a></strong>()</code> |
| <div class="block">Get the list of all the tables.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../org/kududb/client/ListTablesResponse.html" title="class in org.kududb.client">ListTablesResponse</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#getTablesList(java.lang.String)">getTablesList</a></strong>(<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 class="rowColor"> |
| <td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../org/kududb/client/IsAlterTableDoneResponse.html" title="class in org.kududb.client">IsAlterTableDoneResponse</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#isAlterTableDone(java.lang.String)">isAlterTableDone</a></strong>(<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 class="altColor"> |
| <td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../org/kududb/client/ListTabletServersResponse.html" title="class in org.kududb.client">ListTabletServersResponse</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#listTabletServers()">listTabletServers</a></strong>()</code> |
| <div class="block">Get the list of running tablet servers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>org.kududb.client.AsyncKuduScanner.AsyncKuduScannerBuilder</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#newScannerBuilder(org.kududb.client.KuduTable)">newScannerBuilder</a></strong>(<a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a> table)</code> |
| <div class="block">Creates a new <code>AsyncKuduScanner.AsyncKuduScannerBuilder</code> for a particular table.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/AsyncKuduSession.html" title="class in org.kududb.client">AsyncKuduSession</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#newSession()">newSession</a></strong>()</code> |
| <div class="block">Create a new session for interacting with the cluster.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>com.stumbleupon.async.Deferred<<a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#openTable(java.lang.String)">openTable</a></strong>(<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 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><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#shutdown()">shutdown</a></strong>()</code> |
| <div class="block">Performs a graceful shutdown of this instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#tableExists(java.lang.String)">tableExists</a></strong>(<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 class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/AsyncKuduClient.html#updateLastPropagatedTimestamp(long)">updateLastPropagatedTimestamp</a></strong>(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,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ 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="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.kududb.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="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.kududb.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="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.kududb.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="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.kududb.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. This is only publicly visible so that it can be set |
| on tests, users should generally disregard this method.</div> |
| <dl><dt><span class="strong">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> |
| </li> |
| </ul> |
| <a name="createTable(java.lang.String, org.kududb.Schema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre>public com.stumbleupon.async.Deferred<<a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.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/kududb/Schema.html" title="class in org.kududb">Schema</a> schema)</pre> |
| <div class="block">Create a table on the cluster with the specified name and schema. Default table |
| configurations are used, mainly the table will have one tablet.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the table's name</dd><dd><code>schema</code> - the table's schema</dd> |
| <dt><span class="strong">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="createTable(java.lang.String, org.kududb.Schema, org.kududb.client.CreateTableOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre>public com.stumbleupon.async.Deferred<<a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.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/kududb/Schema.html" title="class in org.kududb">Schema</a> schema, |
| <a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a> builder)</pre> |
| <div class="block">Create a table on the cluster with the specified name, schema, and table configurations.</div> |
| <dl><dt><span class="strong">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="strong">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/kududb/client/DeleteTableResponse.html" title="class in org.kududb.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="strong">Parameters:</span></dt><dd><code>name</code> - the table's name</dd> |
| <dt><span class="strong">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.kududb.client.AlterTableOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>alterTable</h4> |
| <pre>public com.stumbleupon.async.Deferred<<a href="../../../org/kududb/client/AlterTableResponse.html" title="class in org.kududb.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/kududb/client/AlterTableOptions.html" title="class in org.kududb.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/kududb/client/AsyncKuduClient.html#isAlterTableDone(java.lang.String)"><code>isAlterTableDone(String)</code></a> to know when the alter finishes.</div> |
| <dl><dt><span class="strong">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="strong">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/kududb/client/IsAlterTableDoneResponse.html" title="class in org.kududb.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) |
| 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">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="strong">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="strong">Returns:</span></dt><dd>a deferred object to track the progress of the isAlterTableDone command</dd> |
| <dt><span class="strong">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></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/kududb/client/ListTabletServersResponse.html" title="class in org.kududb.client">ListTabletServersResponse</a>> listTabletServers()</pre> |
| <div class="block">Get the list of running tablet servers.</div> |
| <dl><dt><span class="strong">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/kududb/client/ListTablesResponse.html" title="class in org.kududb.client">ListTablesResponse</a>> getTablesList()</pre> |
| <div class="block">Get the list of all the tables.</div> |
| <dl><dt><span class="strong">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/kududb/client/ListTablesResponse.html" title="class in org.kududb.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="strong">Parameters:</span></dt><dd><code>nameFilter</code> - an optional table name filter</dd> |
| <dt><span class="strong">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="strong">Parameters:</span></dt><dd><code>name</code> - a non-null table name</dd> |
| <dt><span class="strong">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/kududb/client/KuduTable.html" title="class in org.kududb.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.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - table to open</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a KuduTable if the table exists, else a MasterErrorException</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="strong">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="strong">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="strong">Returns:</span></dt><dd>a timeout in milliseconds</dd></dl> |
| </li> |
| </ul> |
| <a name="newScannerBuilder(org.kududb.client.KuduTable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newScannerBuilder</h4> |
| <pre>public org.kududb.client.AsyncKuduScanner.AsyncKuduScannerBuilder newScannerBuilder(<a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a> table)</pre> |
| <div class="block">Creates a new <code>AsyncKuduScanner.AsyncKuduScannerBuilder</code> for a particular table.</div> |
| <dl><dt><span class="strong">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="strong">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/kududb/client/AsyncKuduSession.html" title="class in org.kududb.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="strong">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/kududb/client/AsyncKuduClient.html#shutdown()"><code>shutdown()</code></a> and waits for the configured admin timeout. This method returns |
| void, so consider invoking shutdown directly if there's a need to handle dangling RPCs.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></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="strong">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/kududb/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="strong">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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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/kududb/client/AlterTableResponse.html" title="class in org.kududb.client"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/kududb/client/AsyncKuduScanner.html" title="class in org.kududb.client"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/kududb/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>Nested | </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 © 2016. All rights reserved.</small></p> |
| </body> |
| </html> |