http://git-wip-us.apache.org/repos/asf/kudu/blob/76a99b4c/apidocs/org/apache/kudu/client/KuduClient.KuduClientBuilder.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/kudu/client/KuduClient.KuduClientBuilder.html b/apidocs/org/apache/kudu/client/KuduClient.KuduClientBuilder.html index f68520a..03339b4 100644 --- a/apidocs/org/apache/kudu/client/KuduClient.KuduClientBuilder.html +++ b/apidocs/org/apache/kudu/client/KuduClient.KuduClientBuilder.html @@ -2,38 +2,24 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>KuduClient.KuduClientBuilder (Kudu 1.0.0 API)</title> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>KuduClient.KuduClientBuilder (Kudu 1.0.1 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="KuduClient.KuduClientBuilder (Kudu 1.0.0 API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="KuduClient.KuduClientBuilder (Kudu 1.0.1 API)"; } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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"> +<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><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -49,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/kudu/client/KuduClient.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduClient.html" title="class in org.apache.kudu.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/kudu/client/KuduClient.KuduClientBuilder.html" target="_top">Frames</a></li> -<li><a href="KuduClient.KuduClientBuilder.html" target="_top">No Frames</a></li> +<li><a href="KuduClient.KuduClientBuilder.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -76,17 +62,17 @@ var activeTableTab = "activeTableTab"; <li>Summary: </li> <li>Nested | </li> <li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -114,8 +100,8 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>@InterfaceAudience.Public - @InterfaceStability.Evolving -public static final class <span class="typeNameLabel">KuduClient.KuduClientBuilder</span> [email protected] +public static final class <span class="strong">KuduClient.KuduClientBuilder</span> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> <div class="block">Builder class to use in order to connect to Kudu. All the parameters beyond those in the constructors are optional.</div> @@ -127,22 +113,22 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> +<li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#KuduClientBuilder-java.util.List-">KuduClientBuilder</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> masterAddresses)</code> +<td class="colOne"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#KuduClient.KuduClientBuilder(java.util.List)">KuduClient.KuduClientBuilder</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<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>> masterAddresses)</code> <div class="block">Creates a new builder for a client that will connect to the specified masters.</div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#KuduClientBuilder-java.lang.String-">KuduClientBuilder</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> masterAddresses)</code> +<td class="colOne"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#KuduClient.KuduClientBuilder(java.lang.String)">KuduClient.KuduClientBuilder</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> masterAddresses)</code> <div class="block">Creates a new builder for a client that will connect to the specified masters.</div> </td> </tr> @@ -151,72 +137,72 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<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> +<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 id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client">KuduClient.KuduClientBuilder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#bossCount-int-">bossCount</a></span>(int bossCount)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#bossCount(int)">bossCount</a></strong>(int bossCount)</code> <div class="block">Set the maximum number of boss threads.</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr 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/KuduClient.KuduClientBuilder.html#build--">build</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#build()">build</a></strong>()</code> <div class="block">Creates a new client that connects to the masters.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client">KuduClient.KuduClientBuilder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#defaultAdminOperationTimeoutMs-long-">defaultAdminOperationTimeoutMs</a></span>(long timeoutMs)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#defaultAdminOperationTimeoutMs(long)">defaultAdminOperationTimeoutMs</a></strong>(long timeoutMs)</code> <div class="block">Sets the default timeout used for administrative operations (e.g.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client">KuduClient.KuduClientBuilder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#defaultOperationTimeoutMs-long-">defaultOperationTimeoutMs</a></span>(long timeoutMs)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#defaultOperationTimeoutMs(long)">defaultOperationTimeoutMs</a></strong>(long timeoutMs)</code> <div class="block">Sets the default timeout used for user operations (using sessions and scanners).</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client">KuduClient.KuduClientBuilder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#defaultSocketReadTimeoutMs-long-">defaultSocketReadTimeoutMs</a></span>(long timeoutMs)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#defaultSocketReadTimeoutMs(long)">defaultSocketReadTimeoutMs</a></strong>(long timeoutMs)</code> <div class="block">Sets the default timeout to use when waiting on data from a socket.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client">KuduClient.KuduClientBuilder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#disableStatistics--">disableStatistics</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#disableStatistics()">disableStatistics</a></strong>()</code> <div class="block">Disable this client's collection of statistics.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client">KuduClient.KuduClientBuilder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#nioExecutors-java.util.concurrent.Executor-java.util.concurrent.Executor-">nioExecutors</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Executor.html?is-external=true"; title="class or interface in java.util.concurrent">Executor</a> bossExecutor, +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#nioExecutors(java.util.concurrent.Executor,%20java.util.concurrent.Executor)">nioExecutors</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Executor.html?is-external=true"; title="class or interface in java.util.concurrent">Executor</a> bossExecutor, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Executor.html?is-external=true"; title="class or interface in java.util.concurrent">Executor</a> workerExecutor)</code> <div class="block">Set the executors which will be used for the embedded Netty boss and workers.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client">KuduClient.KuduClientBuilder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#workerCount-int-">workerCount</a></span>(int workerCount)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#workerCount(int)">workerCount</a></strong>(int workerCount)</code> <div class="block">Set the maximum number of worker threads.</div> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<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> +<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> @@ -228,31 +214,28 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> +<li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> -<a name="KuduClientBuilder-java.lang.String-"> +<a name="KuduClient.KuduClientBuilder(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>KuduClientBuilder</h4> -<pre>public KuduClientBuilder(<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> masterAddresses)</pre> +<h4>KuduClient.KuduClientBuilder</h4> +<pre>public KuduClient.KuduClientBuilder(<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> masterAddresses)</pre> <div class="block">Creates a new builder for a client that will connect to the specified masters.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>masterAddresses</code> - comma-separated list of "host:port" pairs of the masters</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>masterAddresses</code> - comma-separated list of "host:port" pairs of the masters</dd></dl> </li> </ul> -<a name="KuduClientBuilder-java.util.List-"> +<a name="KuduClient.KuduClientBuilder(java.util.List)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> -<h4>KuduClientBuilder</h4> -<pre>public KuduClientBuilder(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> masterAddresses)</pre> +<h4>KuduClient.KuduClientBuilder</h4> +<pre>public KuduClient.KuduClientBuilder(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> masterAddresses)</pre> <div class="block">Creates a new builder for a client that will connect to the specified masters. <p>Here are some examples of recognized formats: @@ -265,21 +248,18 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li>[2001:db8::1]:80 <li>2001:db8::1 </ul></div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>masterAddresses</code> - list of master addresses</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>masterAddresses</code> - list of master addresses</dd></dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="defaultAdminOperationTimeoutMs-long-"> +<a name="defaultAdminOperationTimeoutMs(long)"> <!-- --> </a> <ul class="blockList"> @@ -291,15 +271,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? Optional. If not provided, defaults to 30s. A value of 0 disables the timeout.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>timeoutMs</code> - a timeout in milliseconds</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>this builder</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeoutMs</code> - a timeout in milliseconds</dd> +<dt><span class="strong">Returns:</span></dt><dd>this builder</dd></dl> </li> </ul> -<a name="defaultOperationTimeoutMs-long-"> +<a name="defaultOperationTimeoutMs(long)"> <!-- --> </a> <ul class="blockList"> @@ -310,15 +286,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? Optional. If not provided, defaults to 30s. A value of 0 disables the timeout.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>timeoutMs</code> - a timeout in milliseconds</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>this builder</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeoutMs</code> - a timeout in milliseconds</dd> +<dt><span class="strong">Returns:</span></dt><dd>this builder</dd></dl> </li> </ul> -<a name="defaultSocketReadTimeoutMs-long-"> +<a name="defaultSocketReadTimeoutMs(long)"> <!-- --> </a> <ul class="blockList"> @@ -329,15 +301,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? Optional. If not provided, defaults to 10s. A value of 0 disables the timeout.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>timeoutMs</code> - a timeout in milliseconds</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>this builder</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeoutMs</code> - a timeout in milliseconds</dd> +<dt><span class="strong">Returns:</span></dt><dd>this builder</dd></dl> </li> </ul> -<a name="disableStatistics--"> +<a name="disableStatistics()"> <!-- --> </a> <ul class="blockList"> @@ -346,20 +314,17 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <pre>public <a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client">KuduClient.KuduClientBuilder</a> disableStatistics()</pre> <div class="block">Disable this client's collection of statistics. Statistics are enabled by default.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>this builder</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>this builder</dd></dl> </li> </ul> -<a name="nioExecutors-java.util.concurrent.Executor-java.util.concurrent.Executor-"> +<a name="nioExecutors(java.util.concurrent.Executor, java.util.concurrent.Executor)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>nioExecutors</h4> <pre>public <a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client">KuduClient.KuduClientBuilder</a> nioExecutors(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Executor.html?is-external=true"; title="class or interface in java.util.concurrent">Executor</a> bossExecutor, - <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Executor.html?is-external=true"; title="class or interface in java.util.concurrent">Executor</a> workerExecutor)</pre> + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Executor.html?is-external=true"; title="class or interface in java.util.concurrent">Executor</a> workerExecutor)</pre> <div class="block">Set the executors which will be used for the embedded Netty boss and workers. Optional. If not provided, uses a simple cached threadpool. If either argument is null, @@ -369,7 +334,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? If not sure, please just use CachedThreadPool.</div> </li> </ul> -<a name="bossCount-int-"> +<a name="bossCount(int)"> <!-- --> </a> <ul class="blockList"> @@ -381,7 +346,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? If not provided, 1 is used.</div> </li> </ul> -<a name="workerCount-int-"> +<a name="workerCount(int)"> <!-- --> </a> <ul class="blockList"> @@ -393,7 +358,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? If not provided, (2 * the number of available processors) is used.</div> </li> </ul> -<a name="build--"> +<a name="build()"> <!-- --> </a> <ul class="blockListLast"> @@ -402,10 +367,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <pre>public <a href="../../../../org/apache/kudu/client/KuduClient.html" title="class in org.apache.kudu.client">KuduClient</a> build()</pre> <div class="block">Creates a new client that connects to the masters. Doesn't block and won't throw an exception if the masters don't exist.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a new asynchronous Kudu client</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>a new asynchronous Kudu client</dd></dl> </li> </ul> </li> @@ -416,11 +378,9 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -436,15 +396,15 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/kudu/client/KuduClient.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduClient.html" title="class in org.apache.kudu.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/kudu/client/KuduClient.KuduClientBuilder.html" target="_top">Frames</a></li> -<li><a href="KuduClient.KuduClientBuilder.html" target="_top">No Frames</a></li> +<li><a href="KuduClient.KuduClientBuilder.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -463,17 +423,17 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li>Summary: </li> <li>Nested | </li> <li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
http://git-wip-us.apache.org/repos/asf/kudu/blob/76a99b4c/apidocs/org/apache/kudu/client/KuduClient.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/kudu/client/KuduClient.html b/apidocs/org/apache/kudu/client/KuduClient.html index 8b727f9..82e7b88 100644 --- a/apidocs/org/apache/kudu/client/KuduClient.html +++ b/apidocs/org/apache/kudu/client/KuduClient.html @@ -2,38 +2,24 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>KuduClient (Kudu 1.0.0 API)</title> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>KuduClient (Kudu 1.0.1 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="KuduClient (Kudu 1.0.0 API)"; - } - } - catch(err) { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="KuduClient (Kudu 1.0.1 API)"; } //--> -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}; -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"> +<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><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -49,15 +35,15 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/kudu/client/IsAlterTableDoneResponse.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/IsAlterTableDoneResponse.html" title="class in org.apache.kudu.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/kudu/client/KuduClient.html" target="_top">Frames</a></li> -<li><a href="KuduClient.html" target="_top">No Frames</a></li> +<li><a href="KuduClient.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -74,19 +60,19 @@ var activeTableTab = "activeTableTab"; <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><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> +<li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> -<li><a href="#field.detail">Field</a> | </li> +<li><a href="#field_detail">Field</a> | </li> <li>Constr | </li> -<li><a href="#method.detail">Method</a></li> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.top"> +<a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> @@ -114,15 +100,15 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>@InterfaceAudience.Public - @InterfaceStability.Evolving -public class <span class="typeNameLabel">KuduClient</span> [email protected] +public class <span class="strong">KuduClient</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 synchronous and thread-safe client for Kudu. <p> This class acts as a wrapper around <a href="../../../../org/apache/kudu/client/AsyncKuduClient.html" title="class in org.apache.kudu.client"><code>AsyncKuduClient</code></a>. The <code>Deferred</code> objects are joined against using the default admin operation timeout - (see <a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#defaultAdminOperationTimeoutMs-long-"><code>KuduClient.KuduClientBuilder.defaultAdminOperationTimeoutMs(long)</code></a> (long)}).</div> + (see <a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html#defaultAdminOperationTimeoutMs(long)"><code>KuduClient.KuduClientBuilder.defaultAdminOperationTimeoutMs(long)</code></a> (long)}).</div> </li> </ul> </div> @@ -131,11 +117,11 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> -<li class="blockList"><a name="nested.class.summary"> +<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"> +<table class="overviewSummary" 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> @@ -143,7 +129,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose </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/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client">KuduClient.KuduClientBuilder</a></span></code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client">KuduClient.KuduClientBuilder</a></strong></code> <div class="block">Builder class to use in order to connect to Kudu.</div> </td> </tr> @@ -152,11 +138,11 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose </ul> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="field.summary"> +<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"> +<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> @@ -164,141 +150,141 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose </tr> <tr class="altColor"> <td class="colFirst"><code>static org.slf4j.Logger</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.html#LOG">LOG</a></span></code> </td> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#LOG">LOG</a></strong></code> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> -<li class="blockList"><a name="method.summary"> +<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> +<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 id="i0" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><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/KuduClient.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, +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#alterTable(java.lang.String,%20org.apache.kudu.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/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"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.html#close--">close</a></span>()</code> -<div class="block">Analogous to <a href="../../../../org/apache/kudu/client/KuduClient.html#shutdown--"><code>shutdown()</code></a>.</div> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#close()">close</a></strong>()</code> +<div class="block">Analogous to <a href="../../../../org/apache/kudu/client/KuduClient.html#shutdown()"><code>shutdown()</code></a>.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><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/KuduClient.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, +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#createTable(java.lang.String,%20org.apache.kudu.Schema,%20org.apache.kudu.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/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"> +<tr class="rowColor"> <td class="colFirst"><code><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/KuduClient.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> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.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 id="i4" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.html#getDefaultAdminOperationTimeoutMs--">getDefaultAdminOperationTimeoutMs</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#getDefaultAdminOperationTimeoutMs()">getDefaultAdminOperationTimeoutMs</a></strong>()</code> <div class="block">Get the timeout used for admin operations.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.html#getDefaultOperationTimeoutMs--">getDefaultOperationTimeoutMs</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#getDefaultOperationTimeoutMs()">getDefaultOperationTimeoutMs</a></strong>()</code> <div class="block">Get the timeout used for operations on sessions and scanners.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr 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/KuduClient.html#getStatistics--">getStatistics</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#getStatistics()">getStatistics</a></strong>()</code> <div class="block">Get the statistics object of this client.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><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/KuduClient.html#getTablesList--">getTablesList</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#getTablesList()">getTablesList</a></strong>()</code> <div class="block">Get the list of all the tables.</div> </td> </tr> -<tr id="i8" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><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/KuduClient.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> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.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 id="i9" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.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> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.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 id="i10" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.html#isStatisticsEnabled--">isStatisticsEnabled</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#isStatisticsEnabled()">isStatisticsEnabled</a></strong>()</code> <div class="block">Check if statistics collection is enabled for this client.</div> </td> </tr> -<tr id="i11" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><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/KuduClient.html#listTabletServers--">listTabletServers</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#listTabletServers()">listTabletServers</a></strong>()</code> <div class="block">Get the list of running tablet servers.</div> </td> </tr> -<tr id="i12" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html" title="class in org.apache.kudu.client">KuduScanner.KuduScannerBuilder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.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> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#newScannerBuilder(org.apache.kudu.client.KuduTable)">newScannerBuilder</a></strong>(<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/KuduScanner.KuduScannerBuilder.html" title="class in org.apache.kudu.client"><code>KuduScanner.KuduScannerBuilder</code></a> for a particular table.</div> </td> </tr> -<tr id="i13" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/KuduScanToken.KuduScanTokenBuilder.html" title="class in org.apache.kudu.client">KuduScanToken.KuduScanTokenBuilder</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.html#newScanTokenBuilder-org.apache.kudu.client.KuduTable-">newScanTokenBuilder</a></span>(<a href="../../../../org/apache/kudu/client/KuduTable.html" title="class in org.apache.kudu.client">KuduTable</a> table)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#newScanTokenBuilder(org.apache.kudu.client.KuduTable)">newScanTokenBuilder</a></strong>(<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/KuduScanToken.KuduScanTokenBuilder.html" title="class in org.apache.kudu.client"><code>KuduScanToken.KuduScanTokenBuilder</code></a> for a particular table.</div> </td> </tr> -<tr id="i14" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/KuduSession.html" title="class in org.apache.kudu.client">KuduSession</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.html#newSession--">newSession</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#newSession()">newSession</a></strong>()</code> <div class="block">Create a new session for interacting with the cluster.</div> </td> </tr> -<tr id="i15" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code><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/KuduClient.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> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.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 id="i16" class="altColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.html#shutdown--">shutdown</a></span>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.html#shutdown()">shutdown</a></strong>()</code> <div class="block">Performs a graceful shutdown of this instance.</div> </td> </tr> -<tr id="i17" class="rowColor"> +<tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/KuduClient.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> +<td class="colLast"><code><strong><a href="../../../../org/apache/kudu/client/KuduClient.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> </table> <ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<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> +<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> @@ -310,7 +296,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> -<li class="blockList"><a name="field.detail"> +<li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> @@ -327,34 +313,28 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> -<li class="blockList"><a name="method.detail"> +<li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> -<a name="createTable-java.lang.String-org.apache.kudu.Schema-org.apache.kudu.client.CreateTableOptions-"> +<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 <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) + <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) throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> <div class="block">Create a table on the cluster with the specified name, schema, and table configurations.</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>an object to communicate with the created table</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<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>an object to communicate with the created table</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="deleteTable-java.lang.String-"> +<a name="deleteTable(java.lang.String)"> <!-- --> </a> <ul class="blockList"> @@ -363,41 +343,32 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <pre>public <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) throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></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>an rpc response object</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<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>an rpc response object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="alterTable-java.lang.String-org.apache.kudu.client.AlterTableOptions-"> +<a name="alterTable(java.lang.String, org.apache.kudu.client.AlterTableOptions)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>alterTable</h4> <pre>public <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) + <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> ato) throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> <div class="block">Alter a table on the cluster as specified by the builder. When the method returns it only indicates that the master accepted the alter - command, use <a href="../../../../org/apache/kudu/client/KuduClient.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>an rpc response object</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> + command, use <a href="../../../../org/apache/kudu/client/KuduClient.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>an rpc response object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="isAlterTableDone-java.lang.String-"> +<a name="isAlterTableDone(java.lang.String)"> <!-- --> </a> <ul class="blockList"> @@ -407,17 +378,13 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</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 timeout is reached.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>name</code> - 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 boolean indicating if the table is done being altered</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - for any error returned by sending RPCs to the master</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - 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 boolean indicating if the table is done being altered</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - for any error returned by sending RPCs to the master</dd></dl> </li> </ul> -<a name="listTabletServers--"> +<a name="listTabletServers()"> <!-- --> </a> <ul class="blockList"> @@ -426,15 +393,12 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <pre>public <a href="../../../../org/apache/kudu/client/ListTabletServersResponse.html" title="class in org.apache.kudu.client">ListTabletServersResponse</a> listTabletServers() throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> <div class="block">Get the list of running tablet servers.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a list of tablet servers</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>a list of tablet servers</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="getTablesList--"> +<a name="getTablesList()"> <!-- --> </a> <ul class="blockList"> @@ -443,15 +407,12 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <pre>public <a href="../../../../org/apache/kudu/client/ListTablesResponse.html" title="class in org.apache.kudu.client">ListTablesResponse</a> getTablesList() throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> <div class="block">Get the list of all the tables.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a list of all the tables</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>a list of all the tables</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="getTablesList-java.lang.String-"> +<a name="getTablesList(java.lang.String)"> <!-- --> </a> <ul class="blockList"> @@ -461,17 +422,13 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></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 contains the list of table names</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<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 contains the list of table names</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="tableExists-java.lang.String-"> +<a name="tableExists(java.lang.String)"> <!-- --> </a> <ul class="blockList"> @@ -480,17 +437,13 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <pre>public boolean 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) throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></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> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<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> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="openTable-java.lang.String-"> +<a name="openTable(java.lang.String)"> <!-- --> </a> <ul class="blockList"> @@ -500,17 +453,13 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> <div class="block">Open the table with the given name. If the table was just created, this method will block until all its tablets have also been created.</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</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<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</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="newSession--"> +<a name="newSession()"> <!-- --> </a> <ul class="blockList"> @@ -520,13 +469,10 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <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 synchronous wrapper around KuduSession.</dd> -</dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>a synchronous wrapper around KuduSession.</dd></dl> </li> </ul> -<a name="isStatisticsEnabled--"> +<a name="isStatisticsEnabled()"> <!-- --> </a> <ul class="blockList"> @@ -534,13 +480,10 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <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> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if it is enabled, else false</dd></dl> </li> </ul> -<a name="getStatistics--"> +<a name="getStatistics()"> <!-- --> </a> <ul class="blockList"> @@ -548,15 +491,12 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <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> +<dl><dt><span class="strong">Returns:</span></dt><dd>this client's Statistics object</dd> +<dt><span class="strong">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 name="newScannerBuilder(org.apache.kudu.client.KuduTable)"> <!-- --> </a> <ul class="blockList"> @@ -564,16 +504,12 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <h4>newScannerBuilder</h4> <pre>public <a href="../../../../org/apache/kudu/client/KuduScanner.KuduScannerBuilder.html" title="class in org.apache.kudu.client">KuduScanner.KuduScannerBuilder</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/KuduScanner.KuduScannerBuilder.html" title="class in org.apache.kudu.client"><code>KuduScanner.KuduScannerBuilder</code></a> for a particular table.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>table</code> - the table you intend to scan. +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>table</code> - 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 the table</dd> -</dl> +<dt><span class="strong">Returns:</span></dt><dd>a new scanner builder for the table</dd></dl> </li> </ul> -<a name="newScanTokenBuilder-org.apache.kudu.client.KuduTable-"> +<a name="newScanTokenBuilder(org.apache.kudu.client.KuduTable)"> <!-- --> </a> <ul class="blockList"> @@ -582,15 +518,11 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <pre>public <a href="../../../../org/apache/kudu/client/KuduScanToken.KuduScanTokenBuilder.html" title="class in org.apache.kudu.client">KuduScanToken.KuduScanTokenBuilder</a> newScanTokenBuilder(<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/KuduScanToken.KuduScanTokenBuilder.html" title="class in org.apache.kudu.client"><code>KuduScanToken.KuduScanTokenBuilder</code></a> for a particular table. Used for integrations with compute frameworks.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>table</code> - the table you intend to scan</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a new scan token builder for the table</dd> -</dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>table</code> - the table you intend to scan</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new scan token builder for the table</dd></dl> </li> </ul> -<a name="close--"> +<a name="close()"> <!-- --> </a> <ul class="blockList"> @@ -598,16 +530,15 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <h4>close</h4> <pre>public void close() throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> -<div class="block">Analogous to <a href="../../../../org/apache/kudu/client/KuduClient.html#shutdown--"><code>shutdown()</code></a>.</div> +<div class="block">Analogous to <a href="../../../../org/apache/kudu/client/KuduClient.html#shutdown()"><code>shutdown()</code></a>.</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="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if an error happens while closing the connections</dd> -</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="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if an error happens while closing the connections</dd></dl> </li> </ul> -<a name="shutdown--"> +<a name="shutdown()"> <!-- --> </a> <ul class="blockList"> @@ -616,13 +547,11 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <pre>public void shutdown() throws <a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></pre> <div class="block">Performs a graceful shutdown of this instance.</div> -<dl> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd> -</dl> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/kudu/client/KuduException.html" title="class in org.apache.kudu.client">KuduException</a></code> - if anything went wrong</dd></dl> </li> </ul> -<a name="getDefaultOperationTimeoutMs--"> +<a name="getDefaultOperationTimeoutMs()"> <!-- --> </a> <ul class="blockList"> @@ -630,13 +559,10 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <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> +<dl><dt><span class="strong">Returns:</span></dt><dd>a timeout in milliseconds</dd></dl> </li> </ul> -<a name="getDefaultAdminOperationTimeoutMs--"> +<a name="getDefaultAdminOperationTimeoutMs()"> <!-- --> </a> <ul class="blockListLast"> @@ -644,10 +570,7 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <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> +<dl><dt><span class="strong">Returns:</span></dt><dd>a timeout in milliseconds</dd></dl> </li> </ul> </li> @@ -658,11 +581,9 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> +<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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> @@ -678,15 +599,15 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/kudu/client/IsAlterTableDoneResponse.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/IsAlterTableDoneResponse.html" title="class in org.apache.kudu.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/kudu/client/KuduClient.KuduClientBuilder.html" title="class in org.apache.kudu.client"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/kudu/client/KuduClient.html" target="_top">Frames</a></li> -<li><a href="KuduClient.html" target="_top">No Frames</a></li> +<li><a href="KuduClient.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> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- @@ -703,19 +624,19 @@ implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoClose <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><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> +<li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> -<li><a href="#field.detail">Field</a> | </li> +<li><a href="#field_detail">Field</a> | </li> <li>Constr | </li> -<li><a href="#method.detail">Method</a></li> +<li><a href="#method_detail">Method</a></li> </ul> </div> -<a name="skip.navbar.bottom"> +<a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= -->
