http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f07ee53f/apidocs/org/apache/hadoop/hbase/client/AsyncTable.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/AsyncTable.html b/apidocs/org/apache/hadoop/hbase/client/AsyncTable.html new file mode 100644 index 0000000..a02115c --- /dev/null +++ b/apidocs/org/apache/hadoop/hbase/client/AsyncTable.html @@ -0,0 +1,454 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AsyncTable (Apache HBase 2.0.0-SNAPSHOT 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="AsyncTable (Apache HBase 2.0.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AsyncTable.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/AsyncTable.html" target="_top">Frames</a></li> +<li><a href="AsyncTable.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hadoop.hbase.client</div> +<h2 title="Interface AsyncTable" class="title">Interface AsyncTable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@InterfaceAudience.Public + @InterfaceStability.Unstable +public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.39">AsyncTable</a></pre> +<div class="block">The asynchronous version of Table. Obtain an instance from a <a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncConnection</code></a>. + <p> + The implementation is NOT required to be thread safe. Do NOT access it from multiple threads + concurrently. + <p> + Usually the implementations will not throw any exception directly, you need to get the exception + from the returned <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#delete-org.apache.hadoop.hbase.client.Delete-">delete</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Delete.html" title="class in org.apache.hadoop.hbase.client">Delete</a> delete)</code> +<div class="block">Deletes the specified cells/row.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#exists-org.apache.hadoop.hbase.client.Get-">exists</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</code> +<div class="block">Test for the existence of columns in the table, as specified by the Get.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#get-org.apache.hadoop.hbase.client.Get-">get</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</code> +<div class="block">Extracts certain cells from a given row.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>org.apache.hadoop.conf.Configuration</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getConfiguration--">getConfiguration</a></span>()</code> +<div class="block">Returns the <code>Configuration</code> object used by this instance.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getName--">getName</a></span>()</code> +<div class="block">Gets the fully qualified table name instance of this table.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getOperationTimeout-java.util.concurrent.TimeUnit-">getOperationTimeout</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> +<div class="block">Get timeout of each operation in Table instance.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getReadRpcTimeout-java.util.concurrent.TimeUnit-">getReadRpcTimeout</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> +<div class="block">Get timeout of each rpc read request in this Table instance.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getWriteRpcTimeout-java.util.concurrent.TimeUnit-">getWriteRpcTimeout</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> +<div class="block">Get timeout of each rpc write request in this Table instance.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#put-org.apache.hadoop.hbase.client.Put-">put</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Put.html" title="class in org.apache.hadoop.hbase.client">Put</a> put)</code> +<div class="block">Puts some data to the table.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#setOperationTimeout-long-java.util.concurrent.TimeUnit-">setOperationTimeout</a></span>(long timeout, + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> +<div class="block">Set timeout of each operation in this Table instance, will override the value of + <code>hbase.client.operation.timeout</code> in configuration.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#setReadRpcTimeout-long-java.util.concurrent.TimeUnit-">setReadRpcTimeout</a></span>(long timeout, + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> +<div class="block">Set timeout of each rpc read request in operations of this Table instance, will override the + value of <code>hbase.rpc.read.timeout</code> in configuration.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#setWriteRpcTimeout-long-java.util.concurrent.TimeUnit-">setWriteRpcTimeout</a></span>(long timeout, + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> +<div class="block">Set timeout of each rpc write request in operations of this Table instance, will override the + value of <code>hbase.rpc.write.timeout</code> in configuration.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre><a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.44">getName</a>()</pre> +<div class="block">Gets the fully qualified table name instance of this table.</div> +</li> +</ul> +<a name="getConfiguration--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfiguration</h4> +<pre>org.apache.hadoop.conf.Configuration <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.51">getConfiguration</a>()</pre> +<div class="block">Returns the <code>Configuration</code> object used by this instance. + <p> + The reference returned is not a copy, so any change made to it will affect this instance.</div> +</li> +</ul> +<a name="setReadRpcTimeout-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReadRpcTimeout</h4> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.59">setReadRpcTimeout</a>(long timeout, + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<div class="block">Set timeout of each rpc read request in operations of this Table instance, will override the + value of <code>hbase.rpc.read.timeout</code> in configuration. If a rpc read request waiting too + long, it will stop waiting and send a new request to retry until retries exhausted or operation + timeout reached.</div> +</li> +</ul> +<a name="getReadRpcTimeout-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadRpcTimeout</h4> +<pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.64">getReadRpcTimeout</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<div class="block">Get timeout of each rpc read request in this Table instance.</div> +</li> +</ul> +<a name="setWriteRpcTimeout-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWriteRpcTimeout</h4> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.72">setWriteRpcTimeout</a>(long timeout, + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<div class="block">Set timeout of each rpc write request in operations of this Table instance, will override the + value of <code>hbase.rpc.write.timeout</code> in configuration. If a rpc write request waiting too + long, it will stop waiting and send a new request to retry until retries exhausted or operation + timeout reached.</div> +</li> +</ul> +<a name="getWriteRpcTimeout-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWriteRpcTimeout</h4> +<pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.77">getWriteRpcTimeout</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<div class="block">Get timeout of each rpc write request in this Table instance.</div> +</li> +</ul> +<a name="setOperationTimeout-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOperationTimeout</h4> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.89">setOperationTimeout</a>(long timeout, + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<div class="block">Set timeout of each operation in this Table instance, will override the value of + <code>hbase.client.operation.timeout</code> in configuration. + <p> + Operation timeout is a top-level restriction that makes sure an operation will not be blocked + more than this. In each operation, if rpc request fails because of timeout or other reason, it + will retry until success or throw a RetriesExhaustedException. But if the total time elapsed + reach the operation timeout before retries exhausted, it will break early and throw + SocketTimeoutException.</div> +</li> +</ul> +<a name="getOperationTimeout-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOperationTimeout</h4> +<pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.94">getOperationTimeout</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<div class="block">Get timeout of each operation in Table instance.</div> +</li> +</ul> +<a name="exists-org.apache.hadoop.hbase.client.Get-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.103">exists</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</pre> +<div class="block">Test for the existence of columns in the table, as specified by the Get. + <p> + This will return true if the Get matches one or more keys, false if not. + <p> + This is a server-side call so it prevents any data from being transfered to the client.</div> +</li> +</ul> +<a name="get-org.apache.hadoop.hbase.client.Get-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.113">get</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</pre> +<div class="block">Extracts certain cells from a given row. + <p> + Return the data coming from the specified row, if it exists. If the row specified doesn't + exist, the <a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a> instance returned won't contain any + <code>KeyValue</code>, as indicated by <a href="../../../../../org/apache/hadoop/hbase/client/Result.html#isEmpty--"><code>Result.isEmpty()</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>get</code> - The object that specifies what data to fetch and from which row.</dd> +</dl> +</li> +</ul> +<a name="put-org.apache.hadoop.hbase.client.Put-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.119">put</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Put.html" title="class in org.apache.hadoop.hbase.client">Put</a> put)</pre> +<div class="block">Puts some data to the table.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>put</code> - The data to put.</dd> +</dl> +</li> +</ul> +<a name="delete-org.apache.hadoop.hbase.client.Delete-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>delete</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.125">delete</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Delete.html" title="class in org.apache.hadoop.hbase.client">Delete</a> delete)</pre> +<div class="block">Deletes the specified cells/row.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>delete</code> - The object that specifies what to delete.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AsyncTable.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/AsyncTable.html" target="_top">Frames</a></li> +<li><a href="AsyncTable.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f07ee53f/apidocs/org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html b/apidocs/org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html new file mode 100644 index 0000000..f1e7ec3 --- /dev/null +++ b/apidocs/org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AsyncTableRegionLocator (Apache HBase 2.0.0-SNAPSHOT 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="AsyncTableRegionLocator (Apache HBase 2.0.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":18,"i2":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AsyncTableRegionLocator.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/Attributes.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html" target="_top">Frames</a></li> +<li><a href="AsyncTableRegionLocator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hadoop.hbase.client</div> +<h2 title="Interface AsyncTableRegionLocator" class="title">Interface AsyncTableRegionLocator</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@InterfaceAudience.Public + @InterfaceStability.Unstable +public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html#line.35">AsyncTableRegionLocator</a></pre> +<div class="block">The asynchronous version of RegionLocator. + <p> + Usually the implementations will not throw any exception directly, you need to get the exception + from the returned <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html#getName--">getName</a></span>()</code> +<div class="block">Gets the fully qualified table name instance of the table whose region we want to locate.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/HRegionLocation.html" title="class in org.apache.hadoop.hbase">HRegionLocation</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html#getRegionLocation-byte:A-">getRegionLocation</a></span>(byte[] row)</code> +<div class="block">Finds the region on which the given row is being served.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/HRegionLocation.html" title="class in org.apache.hadoop.hbase">HRegionLocation</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html#getRegionLocation-byte:A-boolean-">getRegionLocation</a></span>(byte[] row, + boolean reload)</code> +<div class="block">Finds the region on which the given row is being served.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre><a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html#line.40">getName</a>()</pre> +<div class="block">Gets the fully qualified table name instance of the table whose region we want to locate.</div> +</li> +</ul> +<a name="getRegionLocation-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRegionLocation</h4> +<pre>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/HRegionLocation.html" title="class in org.apache.hadoop.hbase">HRegionLocation</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html#line.48">getRegionLocation</a>(byte[] row)</pre> +<div class="block">Finds the region on which the given row is being served. Does not reload the cache. + <p> + Returns the location of the region to which the row belongs.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - Row to find.</dd> +</dl> +</li> +</ul> +<a name="getRegionLocation-byte:A-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getRegionLocation</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../org/apache/hadoop/hbase/HRegionLocation.html" title="class in org.apache.hadoop.hbase">HRegionLocation</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html#line.59">getRegionLocation</a>(byte[] row, + boolean reload)</pre> +<div class="block">Finds the region on which the given row is being served. + <p> + Returns the location of the region to which the row belongs.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - Row to find.</dd> +<dd><code>reload</code> - true to reload information or false to use cached information</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AsyncTableRegionLocator.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/Attributes.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html" target="_top">Frames</a></li> +<li><a href="AsyncTableRegionLocator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f07ee53f/apidocs/org/apache/hadoop/hbase/client/Attributes.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/Attributes.html b/apidocs/org/apache/hadoop/hbase/client/Attributes.html index a9d7110..e54e08d 100644 --- a/apidocs/org/apache/hadoop/hbase/client/Attributes.html +++ b/apidocs/org/apache/hadoop/hbase/client/Attributes.html @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/hadoop/hbase/client/Append.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/apache/hadoop/hbase/client/BufferedMutator.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -236,7 +236,7 @@ public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/hadoop/hbase/client/Append.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../org/apache/hadoop/hbase/client/BufferedMutator.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f07ee53f/apidocs/org/apache/hadoop/hbase/client/BufferedMutator.ExceptionListener.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/BufferedMutator.ExceptionListener.html b/apidocs/org/apache/hadoop/hbase/client/BufferedMutator.ExceptionListener.html index a04efe6..a62cfb7 100644 --- a/apidocs/org/apache/hadoop/hbase/client/BufferedMutator.ExceptionListener.html +++ b/apidocs/org/apache/hadoop/hbase/client/BufferedMutator.ExceptionListener.html @@ -107,7 +107,7 @@ var activeTableTab = "activeTableTab"; <br> <pre>@InterfaceAudience.Public @InterfaceStability.Evolving -public static interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/BufferedMutator.html#line.127">BufferedMutator.ExceptionListener</a></pre> +public static interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/BufferedMutator.html#line.137">BufferedMutator.ExceptionListener</a></pre> <div class="block">Listens for asynchronous exceptions on a <a href="../../../../../org/apache/hadoop/hbase/client/BufferedMutator.html" title="interface in org.apache.hadoop.hbase.client"><code>BufferedMutator</code></a>.</div> </li> </ul> @@ -153,7 +153,7 @@ public static interface <a href="../../../../../src-html/org/apache/hadoop/hbase <ul class="blockListLast"> <li class="blockList"> <h4>onException</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/BufferedMutator.ExceptionListener.html#line.128">onException</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RetriesExhaustedWithDetailsException.html" title="class in org.apache.hadoop.hbase.client">RetriesExhaustedWithDetailsException</a> exception, +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/BufferedMutator.ExceptionListener.html#line.138">onException</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RetriesExhaustedWithDetailsException.html" title="class in org.apache.hadoop.hbase.client">RetriesExhaustedWithDetailsException</a> exception, <a href="../../../../../org/apache/hadoop/hbase/client/BufferedMutator.html" title="interface in org.apache.hadoop.hbase.client">BufferedMutator</a> mutator) throws <a href="../../../../../org/apache/hadoop/hbase/client/RetriesExhaustedWithDetailsException.html" title="class in org.apache.hadoop.hbase.client">RetriesExhaustedWithDetailsException</a></pre> <dl> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f07ee53f/apidocs/org/apache/hadoop/hbase/client/BufferedMutator.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/BufferedMutator.html b/apidocs/org/apache/hadoop/hbase/client/BufferedMutator.html index 2c5b3c5..42188cd 100644 --- a/apidocs/org/apache/hadoop/hbase/client/BufferedMutator.html +++ b/apidocs/org/apache/hadoop/hbase/client/BufferedMutator.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6}; +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -226,6 +226,18 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html <div class="block">Sends a <a href="../../../../../org/apache/hadoop/hbase/client/Mutation.html" title="class in org.apache.hadoop.hbase.client"><code>Mutation</code></a> to the table.</div> </td> </tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/BufferedMutator.html#setOperationTimeout-int-">setOperationTimeout</a></span>(int timeout)</code> +<div class="block">Set operation timeout for this mutator instance</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/BufferedMutator.html#setRpcTimeout-int-">setRpcTimeout</a></span>(int timeout)</code> +<div class="block">Set rpc timeout for this mutator instance</div> +</td> +</tr> </table> </li> </ul> @@ -339,7 +351,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html <a name="getWriteBufferSize--"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>getWriteBufferSize</h4> <pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/BufferedMutator.html#line.120">getWriteBufferSize</a>()</pre> @@ -352,6 +364,26 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html </dl> </li> </ul> +<a name="setRpcTimeout-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRpcTimeout</h4> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/BufferedMutator.html#line.125">setRpcTimeout</a>(int timeout)</pre> +<div class="block">Set rpc timeout for this mutator instance</div> +</li> +</ul> +<a name="setOperationTimeout-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setOperationTimeout</h4> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/BufferedMutator.html#line.130">setOperationTimeout</a>(int timeout)</pre> +<div class="block">Set operation timeout for this mutator instance</div> +</li> +</ul> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f07ee53f/apidocs/org/apache/hadoop/hbase/client/ConnectionFactory.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/ConnectionFactory.html b/apidocs/org/apache/hadoop/hbase/client/ConnectionFactory.html index 2144893..b613b01 100644 --- a/apidocs/org/apache/hadoop/hbase/client/ConnectionFactory.html +++ b/apidocs/org/apache/hadoop/hbase/client/ConnectionFactory.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9}; +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -75,13 +75,13 @@ var activeTableTab = "activeTableTab"; <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#field.summary">Field</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="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> @@ -111,7 +111,7 @@ var activeTableTab = "activeTableTab"; <br> <pre>@InterfaceAudience.Public @InterfaceStability.Evolving -public class <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.58">ConnectionFactory</a> +public class <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.59">ConnectionFactory</a> extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> <div class="block">A non-instantiable class that manages creation of <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client"><code>Connection</code></a>s. Managing the lifecycle of the <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client"><code>Connection</code></a>s to the cluster is the responsibility of @@ -143,6 +143,25 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#HBASE_CLIENT_ASYNC_CONNECTION_IMPL">HBASE_CLIENT_ASYNC_CONNECTION_IMPL</a></span></code> </td> +</tr> +</table> +</li> +</ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.summary"> @@ -177,25 +196,45 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection--">createAsyncConnection</a></span>()</code> +<div class="block">Call <a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-"><code>createAsyncConnection(Configuration)</code></a> using default HBaseConfiguration.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-">createAsyncConnection</a></span>(org.apache.hadoop.conf.Configuration conf)</code> +<div class="block">Call <a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.security.User-"><code>createAsyncConnection(Configuration, User)</code></a> using the given <code>conf</code> and a + User object created by <code>UserProvider</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.security.User-">createAsyncConnection</a></span>(org.apache.hadoop.conf.Configuration conf, + <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user)</code> +<div class="block">Create a new AsyncConnection instance using the passed <code>conf</code> and <code>user</code>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createConnection--">createConnection</a></span>()</code> <div class="block">Create a new Connection instance using default HBaseConfiguration.</div> </td> </tr> -<tr id="i1" class="rowColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createConnection-org.apache.hadoop.conf.Configuration-">createConnection</a></span>(org.apache.hadoop.conf.Configuration conf)</code> <div class="block">Create a new Connection instance using the passed <code>conf</code> instance.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createConnection-org.apache.hadoop.conf.Configuration-java.util.concurrent.ExecutorService-">createConnection</a></span>(org.apache.hadoop.conf.Configuration conf, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a> pool)</code> <div class="block">Create a new Connection instance using the passed <code>conf</code> instance.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createConnection-org.apache.hadoop.conf.Configuration-java.util.concurrent.ExecutorService-org.apache.hadoop.hbase.security.User-">createConnection</a></span>(org.apache.hadoop.conf.Configuration conf, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a> pool, @@ -203,7 +242,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <div class="block">Create a new Connection instance using the passed <code>conf</code> instance.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createConnection-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.security.User-">createConnection</a></span>(org.apache.hadoop.conf.Configuration conf, <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user)</code> @@ -226,6 +265,27 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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="HBASE_CLIENT_ASYNC_CONNECTION_IMPL"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HBASE_CLIENT_ASYNC_CONNECTION_IMPL</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.61">HBASE_CLIENT_ASYNC_CONNECTION_IMPL</a></pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.ConnectionFactory.HBASE_CLIENT_ASYNC_CONNECTION_IMPL">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> @@ -238,7 +298,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>ConnectionFactory</h4> -<pre>protected <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.61">ConnectionFactory</a>()</pre> +<pre>protected <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.65">ConnectionFactory</a>()</pre> <div class="block">No public c.tors</div> </li> </ul> @@ -256,7 +316,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>createConnection</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.88">createConnection</a>() +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.92">createConnection</a>() throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block">Create a new Connection instance using default HBaseConfiguration. Connection encapsulates all housekeeping for a connection to the cluster. All tables and interfaces @@ -292,7 +352,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>createConnection</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.117">createConnection</a>(org.apache.hadoop.conf.Configuration conf) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.121">createConnection</a>(org.apache.hadoop.conf.Configuration conf) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block">Create a new Connection instance using the passed <code>conf</code> instance. Connection encapsulates all housekeeping for a connection to the cluster. All tables and interfaces @@ -330,7 +390,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>createConnection</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.147">createConnection</a>(org.apache.hadoop.conf.Configuration conf, +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.151">createConnection</a>(org.apache.hadoop.conf.Configuration conf, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a> pool) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block">Create a new Connection instance using the passed <code>conf</code> instance. Connection @@ -370,7 +430,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>createConnection</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.178">createConnection</a>(org.apache.hadoop.conf.Configuration conf, +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.182">createConnection</a>(org.apache.hadoop.conf.Configuration conf, <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block">Create a new Connection instance using the passed <code>conf</code> instance. Connection @@ -407,10 +467,10 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <a name="createConnection-org.apache.hadoop.conf.Configuration-java.util.concurrent.ExecutorService-org.apache.hadoop.hbase.security.User-"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>createConnection</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.210">createConnection</a>(org.apache.hadoop.conf.Configuration conf, +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.214">createConnection</a>(org.apache.hadoop.conf.Configuration conf, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a> pool, <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> @@ -446,6 +506,79 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? </dl> </li> </ul> +<a name="createAsyncConnection--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createAsyncConnection</h4> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.246">createAsyncConnection</a>() + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Call <a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-"><code>createAsyncConnection(Configuration)</code></a> using default HBaseConfiguration.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>AsyncConnection object</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-"><code>createAsyncConnection(Configuration)</code></a></dd> +</dl> +</li> +</ul> +<a name="createAsyncConnection-org.apache.hadoop.conf.Configuration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createAsyncConnection</h4> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.259">createAsyncConnection</a>(org.apache.hadoop.conf.Configuration conf) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Call <a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.security.User-"><code>createAsyncConnection(Configuration, User)</code></a> using the given <code>conf</code> and a + User object created by <code>UserProvider</code>. The given <code>conf</code> will also be used to + initialize the <code>UserProvider</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>conf</code> - configuration</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>AsyncConnection object</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.security.User-"><code>createAsyncConnection(Configuration, User)</code></a>, +<code>UserProvider</code></dd> +</dl> +</li> +</ul> +<a name="createAsyncConnection-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.security.User-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createAsyncConnection</h4> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ConnectionFactory.html#line.279">createAsyncConnection</a>(org.apache.hadoop.conf.Configuration conf, + <a href="../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Create a new AsyncConnection instance using the passed <code>conf</code> and <code>user</code>. + AsyncConnection encapsulates all housekeeping for a connection to the cluster. All tables and + interfaces created from returned connection share zookeeper connection, meta cache, and + connections to region servers and masters. + <p> + The caller is responsible for calling <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io"><code>Closeable.close()</code></a> on the returned + connection instance. + <p> + Usually you should only create one AsyncConnection instance in your code and use it everywhere + as it is thread safe.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>conf</code> - configuration</dd> +<dd><code>user</code> - the user the asynchronous connection is for</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>AsyncConnection object</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> </li> </ul> </li> @@ -500,13 +633,13 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#field.summary">Field</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="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul>