http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ca9f6925/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminBuilder.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminBuilder.html b/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminBuilder.html new file mode 100644 index 0000000..6e29bdd --- /dev/null +++ b/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminBuilder.html @@ -0,0 +1,385 @@ +<!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>AsyncAdminBuilder (Apache HBase 3.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="AsyncAdminBuilder (Apache HBase 3.0.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":18,"i3":6,"i4":6,"i5":6,"i6":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/AsyncAdminBuilder.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/AsyncAdmin.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/AsyncAdminBuilderBase.html" title="class 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/AsyncAdminBuilder.html" target="_top">Frames</a></li> +<li><a href="AsyncAdminBuilder.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 AsyncAdminBuilder" class="title">Interface AsyncAdminBuilder<T extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="class in org.apache.hadoop.hbase.client">AsyncAdminBuilderBase</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.Public.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.Public</a> +public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#line.32">AsyncAdminBuilder</a><T extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a>></pre> +<div class="block">For creating <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a>. The implementation should have default configurations set before + returning the builder to user. So users are free to only set the configs they care about to + create a new AsyncAdmin instance.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="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/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#build--">build</a></span>()</code> +<div class="block">Create a <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a> instance.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setMaxAttempts-int-">setMaxAttempts</a></span>(int maxAttempts)</code> +<div class="block">Set the max attempt times for an admin operation.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setMaxRetries-int-">setMaxRetries</a></span>(int maxRetries)</code> +<div class="block">Set the max retry times for an admin operation.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.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 for a whole admin operation.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setRetryPause-long-java.util.concurrent.TimeUnit-">setRetryPause</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 the base pause time for retrying.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setRpcTimeout-long-java.util.concurrent.TimeUnit-">setRpcTimeout</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 for each rpc request.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setStartLogErrorsCnt-int-">setStartLogErrorsCnt</a></span>(int startLogErrorsCnt)</code> +<div class="block">Set the number of retries that are allowed before we start to log.</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="setOperationTimeout-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOperationTimeout</h4> +<pre><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#line.42">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 for a whole admin operation. Operation timeout and max attempt times(or max retry + times) are both limitations for retrying, we will stop retrying when we reach any of the + limitations.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>timeout</code> - </dd> +<dd><code>unit</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this for invocation chaining</dd> +</dl> +</li> +</ul> +<a name="setRpcTimeout-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRpcTimeout</h4> +<pre><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#line.50">setRpcTimeout</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 for each rpc request.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>timeout</code> - </dd> +<dd><code>unit</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this for invocation chaining</dd> +</dl> +</li> +</ul> +<a name="setRetryPause-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRetryPause</h4> +<pre><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#line.59">setRetryPause</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 the base pause time for retrying. We use an exponential policy to generate sleep time when + retrying.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>timeout</code> - </dd> +<dd><code>unit</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this for invocation chaining</dd> +</dl> +</li> +</ul> +<a name="setMaxRetries-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxRetries</h4> +<pre>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#line.68">setMaxRetries</a>(int maxRetries)</pre> +<div class="block">Set the max retry times for an admin operation. Usually it is the max attempt times minus 1. + Operation timeout and max attempt times(or max retry times) are both limitations for retrying, + we will stop retrying when we reach any of the limitations.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maxRetries</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this for invocation chaining</dd> +</dl> +</li> +</ul> +<a name="setMaxAttempts-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxAttempts</h4> +<pre><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#line.79">setMaxAttempts</a>(int maxAttempts)</pre> +<div class="block">Set the max attempt times for an admin operation. Usually it is the max retry times plus 1. + Operation timeout and max attempt times(or max retry times) are both limitations for retrying, + we will stop retrying when we reach any of the limitations.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maxAttempts</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this for invocation chaining</dd> +</dl> +</li> +</ul> +<a name="setStartLogErrorsCnt-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStartLogErrorsCnt</h4> +<pre><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#line.86">setStartLogErrorsCnt</a>(int startLogErrorsCnt)</pre> +<div class="block">Set the number of retries that are allowed before we start to log.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>startLogErrorsCnt</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this for invocation chaining</dd> +</dl> +</li> +</ul> +<a name="build--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="type parameter in AsyncAdminBuilder">T</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#line.92">build</a>()</pre> +<div class="block">Create a <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a> instance.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a> instance</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/AsyncAdminBuilder.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/AsyncAdmin.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/AsyncAdminBuilderBase.html" title="class 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/AsyncAdminBuilder.html" target="_top">Frames</a></li> +<li><a href="AsyncAdminBuilder.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–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ca9f6925/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html b/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html new file mode 100644 index 0000000..db0de55 --- /dev/null +++ b/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html @@ -0,0 +1,487 @@ +<!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>AsyncAdminBuilderBase (Apache HBase 3.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="AsyncAdminBuilderBase (Apache HBase 3.0.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AsyncAdminBuilderBase.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/AsyncAdminBuilder.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/AsyncAdminRequestRetryingCaller.html" title="class 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/AsyncAdminBuilderBase.html" target="_top">Frames</a></li> +<li><a href="AsyncAdminBuilderBase.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</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="#constructor.detail">Constr</a> | </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="Class AsyncAdminBuilderBase" class="title">Class AsyncAdminBuilderBase<T extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.client.AsyncAdminBuilderBase<T></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><T></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.Private.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.Private</a> +abstract class <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#line.28">AsyncAdminBuilderBase</a><T extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</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> +implements <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><T></pre> +<div class="block">Base class for all asynchronous admin builders.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="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>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#maxAttempts">maxAttempts</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#operationTimeoutNs">operationTimeoutNs</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#pauseNs">pauseNs</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#rpcTimeoutNs">rpcTimeoutNs</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#startLogErrorsCnt">startLogErrorsCnt</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<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"> +<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/hadoop/hbase/client/AsyncAdminBuilderBase.html#AsyncAdminBuilderBase-org.apache.hadoop.hbase.client.AsyncConnectionConfiguration-">AsyncAdminBuilderBase</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnectionConfiguration.html" title="class in org.apache.hadoop.hbase.client">AsyncConnectionConfiguration</a> connConf)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#setMaxAttempts-int-">setMaxAttempts</a></span>(int maxAttempts)</code> +<div class="block">Set the max attempt times for an admin operation.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.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 for a whole admin operation.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#setRetryPause-long-java.util.concurrent.TimeUnit-">setRetryPause</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 the base pause time for retrying.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#setRpcTimeout-long-java.util.concurrent.TimeUnit-">setRpcTimeout</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 for each rpc request.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#setStartLogErrorsCnt-int-">setStartLogErrorsCnt</a></span>(int startLogErrorsCnt)</code> +<div class="block">Set the number of retries that are allowed before we start to log.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.client.AsyncAdminBuilder"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a></h3> +<code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#build--">build</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setMaxRetries-int-">setMaxRetries</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="rpcTimeoutNs"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>rpcTimeoutNs</h4> +<pre>protected long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#line.30">rpcTimeoutNs</a></pre> +</li> +</ul> +<a name="operationTimeoutNs"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>operationTimeoutNs</h4> +<pre>protected long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#line.32">operationTimeoutNs</a></pre> +</li> +</ul> +<a name="pauseNs"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pauseNs</h4> +<pre>protected long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#line.34">pauseNs</a></pre> +</li> +</ul> +<a name="maxAttempts"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>maxAttempts</h4> +<pre>protected int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#line.36">maxAttempts</a></pre> +</li> +</ul> +<a name="startLogErrorsCnt"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>startLogErrorsCnt</h4> +<pre>protected int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#line.38">startLogErrorsCnt</a></pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AsyncAdminBuilderBase-org.apache.hadoop.hbase.client.AsyncConnectionConfiguration-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AsyncAdminBuilderBase</h4> +<pre><a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#line.40">AsyncAdminBuilderBase</a>(<a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnectionConfiguration.html" title="class in org.apache.hadoop.hbase.client">AsyncConnectionConfiguration</a> connConf)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setOperationTimeout-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOperationTimeout</h4> +<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#line.49">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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setOperationTimeout-long-java.util.concurrent.TimeUnit-">AsyncAdminBuilder</a></code></span></div> +<div class="block">Set timeout for a whole admin operation. Operation timeout and max attempt times(or max retry + times) are both limitations for retrying, we will stop retrying when we reach any of the + limitations.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setOperationTimeout-long-java.util.concurrent.TimeUnit-">setOperationTimeout</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a> extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this for invocation chaining</dd> +</dl> +</li> +</ul> +<a name="setRpcTimeout-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRpcTimeout</h4> +<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#line.55">setRpcTimeout</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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setRpcTimeout-long-java.util.concurrent.TimeUnit-">AsyncAdminBuilder</a></code></span></div> +<div class="block">Set timeout for each rpc request.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setRpcTimeout-long-java.util.concurrent.TimeUnit-">setRpcTimeout</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a> extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this for invocation chaining</dd> +</dl> +</li> +</ul> +<a name="setRetryPause-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRetryPause</h4> +<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#line.61">setRetryPause</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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setRetryPause-long-java.util.concurrent.TimeUnit-">AsyncAdminBuilder</a></code></span></div> +<div class="block">Set the base pause time for retrying. We use an exponential policy to generate sleep time when + retrying.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setRetryPause-long-java.util.concurrent.TimeUnit-">setRetryPause</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a> extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this for invocation chaining</dd> +</dl> +</li> +</ul> +<a name="setMaxAttempts-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxAttempts</h4> +<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#line.67">setMaxAttempts</a>(int maxAttempts)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setMaxAttempts-int-">AsyncAdminBuilder</a></code></span></div> +<div class="block">Set the max attempt times for an admin operation. Usually it is the max retry times plus 1. + Operation timeout and max attempt times(or max retry times) are both limitations for retrying, + we will stop retrying when we reach any of the limitations.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setMaxAttempts-int-">setMaxAttempts</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a> extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this for invocation chaining</dd> +</dl> +</li> +</ul> +<a name="setStartLogErrorsCnt-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setStartLogErrorsCnt</h4> +<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html#line.73">setStartLogErrorsCnt</a>(int startLogErrorsCnt)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setStartLogErrorsCnt-int-">AsyncAdminBuilder</a></code></span></div> +<div class="block">Set the number of retries that are allowed before we start to log.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html#setStartLogErrorsCnt-int-">setStartLogErrorsCnt</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilderBase.html" title="type parameter in AsyncAdminBuilderBase">T</a> extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this for invocation chaining</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/AsyncAdminBuilderBase.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/AsyncAdminBuilder.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/AsyncAdminRequestRetryingCaller.html" title="class 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/AsyncAdminBuilderBase.html" target="_top">Frames</a></li> +<li><a href="AsyncAdminBuilderBase.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</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="#constructor.detail">Constr</a> | </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–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ca9f6925/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminRequestRetryingCaller.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminRequestRetryingCaller.html b/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminRequestRetryingCaller.html index 7878956..00a35cd 100644 --- a/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminRequestRetryingCaller.html +++ b/devapidocs/org/apache/hadoop/hbase/client/AsyncAdminRequestRetryingCaller.html @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.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/AsyncAdminBuilderBase.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/AsyncAdminRequestRetryingCaller.Callable.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -351,7 +351,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncRpcRetryingC </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.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/AsyncAdminBuilderBase.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/AsyncAdminRequestRetryingCaller.Callable.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/ca9f6925/devapidocs/org/apache/hadoop/hbase/client/AsyncConnection.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/client/AsyncConnection.html b/devapidocs/org/apache/hadoop/hbase/client/AsyncConnection.html index ff9ab90..c7401a3 100644 --- a/devapidocs/org/apache/hadoop/hbase/client/AsyncConnection.html +++ b/devapidocs/org/apache/hadoop/hbase/client/AsyncConnection.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":6,"i1":6,"i2":18,"i3":6,"i4":6,"i5":18,"i6":6}; +var methods = {"i0":18,"i1":18,"i2":6,"i3":6,"i4":6,"i5":18,"i6":6,"i7":6,"i8":18,"i9":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"; @@ -132,43 +132,61 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html <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/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a></code></td> +<td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getAdmin--">getAdmin</a></span>()</code> -<div class="block">Retrieve an AsyncAdmin implementation to administer an HBase cluster.</div> +<div class="block">Retrieve an <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a> implementation to administer an HBase cluster.</div> </td> </tr> <tr id="i1" class="rowColor"> +<td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getAdmin-java.util.concurrent.ExecutorService-">getAdmin</a></span>(<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">Retrieve an <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a> implementation to administer an HBase cluster.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncHBaseAdmin.html" title="class in org.apache.hadoop.hbase.client">RawAsyncHBaseAdmin</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getAdminBuilder--">getAdminBuilder</a></span>()</code> +<div class="block">Returns an <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdminBuilder</code></a> for creating <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncHBaseAdmin.html" title="class in org.apache.hadoop.hbase.client">AsyncHBaseAdmin</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getAdminBuilder-java.util.concurrent.ExecutorService-">getAdminBuilder</a></span>(<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">Returns an <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdminBuilder</code></a> for creating <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> <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/AsyncConnection.html#getConfiguration--">getConfiguration</a></span>()</code> <div class="block">Returns the <code>Configuration</code> object used by this instance.</div> </td> </tr> -<tr id="i2" class="altColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.html" title="interface in org.apache.hadoop.hbase.client">RawAsyncTable</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getRawTable-org.apache.hadoop.hbase.TableName-">getRawTable</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> <div class="block">Retrieve an <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>RawAsyncTable</code></a> implementation for accessing a table.</div> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncTableBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.html" title="interface in org.apache.hadoop.hbase.client">RawAsyncTable</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getRawTableBuilder-org.apache.hadoop.hbase.TableName-">getRawTableBuilder</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> <div class="block">Returns an <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBuilder.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTableBuilder</code></a> for creating <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>RawAsyncTable</code></a>.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableRegionLocator.html" title="interface in org.apache.hadoop.hbase.client">AsyncTableRegionLocator</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getRegionLocator-org.apache.hadoop.hbase.TableName-">getRegionLocator</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> <div class="block">Retrieve a AsyncRegionLocator implementation to inspect region information on a table.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getTable-org.apache.hadoop.hbase.TableName-java.util.concurrent.ExecutorService-">getTable</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, <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">Retrieve an AsyncTable implementation for accessing a table.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncTableBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getTableBuilder-org.apache.hadoop.hbase.TableName-java.util.concurrent.ExecutorService-">getTableBuilder</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, <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> @@ -312,17 +330,68 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html <a name="getAdmin--"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdmin</h4> +<pre>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncConnection.html#line.109">getAdmin</a>()</pre> +<div class="block">Retrieve an <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a> implementation to administer an HBase cluster. + <p> + The returned instance will use default configs. Use <a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getAdminBuilder--"><code>getAdminBuilder()</code></a> if you want to + customize some configs. + <p> + The admin operation's returned <code>CompletableFuture</code> will be finished directly in the rpc + framework's callback thread, so typically you should not do any time consuming work inside + these methods.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a> instance for cluster administration</dd> +</dl> +</li> +</ul> +<a name="getAdminBuilder--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdminBuilder</h4> +<pre><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncHBaseAdmin.html" title="class in org.apache.hadoop.hbase.client">RawAsyncHBaseAdmin</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncConnection.html#line.120">getAdminBuilder</a>()</pre> +<div class="block">Returns an <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdminBuilder</code></a> for creating <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a>. + <p> + The admin operation's returned <code>CompletableFuture</code> will be finished directly in the rpc + framework's callback thread, so typically you should not do any time consuming work inside + these methods.</div> +</li> +</ul> +<a name="getAdmin-java.util.concurrent.ExecutorService-"> +<!-- --> +</a> +<ul class="blockList"> <li class="blockList"> <h4>getAdmin</h4> -<pre><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncConnection.html#line.105">getAdmin</a>()</pre> -<div class="block">Retrieve an AsyncAdmin implementation to administer an HBase cluster. The returned AsyncAdmin - is not guaranteed to be thread-safe. A new instance should be created for each using thread. - This is a lightweight operation. Pooling or caching of the returned AsyncAdmin is not - recommended.</div> +<pre>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdmin</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncConnection.html#line.130">getAdmin</a>(<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)</pre> +<div class="block">Retrieve an <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a> implementation to administer an HBase cluster. + <p> + The returned instance will use default configs. Use <a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getAdminBuilder-java.util.concurrent.ExecutorService-"><code>getAdminBuilder(ExecutorService)</code></a> + if you want to customize some configs.</div> <dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>pool</code> - the thread pool to use for executing callback</dd> <dt><span class="returnLabel">Returns:</span></dt> -<dd>an AsyncAdmin instance for cluster administration</dd> +<dd>an <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a> instance for cluster administration</dd> +</dl> +</li> +</ul> +<a name="getAdminBuilder-java.util.concurrent.ExecutorService-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAdminBuilder</h4> +<pre><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncAdminBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncHBaseAdmin.html" title="class in org.apache.hadoop.hbase.client">AsyncHBaseAdmin</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncConnection.html#line.138">getAdminBuilder</a>(<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)</pre> +<div class="block">Returns an <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdminBuilder.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdminBuilder</code></a> for creating <a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncAdmin</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>pool</code> - the thread pool to use for executing callback</dd> </dl> </li> </ul>
