http://git-wip-us.apache.org/repos/asf/hbase-site/blob/67a6e2ec/apidocs/org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html b/apidocs/org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html deleted file mode 100644 index 9b22932..0000000 --- a/apidocs/org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html +++ /dev/null @@ -1,334 +0,0 @@ -<!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>RawAsyncTable.CoprocessorCallback (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="RawAsyncTable.CoprocessorCallback (Apache HBase 3.0.0-SNAPSHOT API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":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/RawAsyncTable.CoprocessorCallback.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/RawAsyncTable.CoprocessorCallable.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/RawScanResultConsumer.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/RawAsyncTable.CoprocessorCallback.html" target="_top">Frames</a></li> -<li><a href="RawAsyncTable.CoprocessorCallback.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 RawAsyncTable.CoprocessorCallback" class="title">Interface RawAsyncTable.CoprocessorCallback<R></h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>Enclosing interface:</dt> -<dd><a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.html" title="interface in org.apache.hadoop.hbase.client">RawAsyncTable</a></dd> -</dl> -<hr> -<br> -<pre>@InterfaceAudience.Public -public static interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawAsyncTable.html#line.170">RawAsyncTable.CoprocessorCallback</a><R></pre> -<div class="block">The callback when we want to execute a coprocessor call on a range of regions. - <p> - As the locating itself also takes some time, the implementation may want to send rpc calls on - the fly, which means we do not know how many regions we have when we get the return value of - the rpc calls, so we need an <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onComplete--"><code>onComplete()</code></a> which is used to tell you that we have - passed all the return values to you(through the <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onRegionComplete-org.apache.hadoop.hbase.client.RegionInfo-R-"><code>onRegionComplete(RegionInfo, Object)</code></a> - or <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onRegionError-org.apache.hadoop.hbase.client.RegionInfo-java.lang.Throwable-"><code>onRegionError(RegionInfo, Throwable)</code></a> calls), i.e, there will be no - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onRegionComplete-org.apache.hadoop.hbase.client.RegionInfo-R-"><code>onRegionComplete(RegionInfo, Object)</code></a> or <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onRegionError-org.apache.hadoop.hbase.client.RegionInfo-java.lang.Throwable-"><code>onRegionError(RegionInfo, Throwable)</code></a> - calls in the future. - <p> - Here is a pseudo code to describe a typical implementation of a range coprocessor service - method to help you better understand how the <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html" title="interface in org.apache.hadoop.hbase.client"><code>RawAsyncTable.CoprocessorCallback</code></a> will be called. The - <code>callback</code> in the pseudo code is our <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html" title="interface in org.apache.hadoop.hbase.client"><code>RawAsyncTable.CoprocessorCallback</code></a>. And notice that the - <code>whenComplete</code> is <code>CompletableFuture.whenComplete</code>. - - <pre> - locateThenCall(byte[] row) { - locate(row).whenComplete((location, locateError) -> { - if (locateError != null) { - callback.onError(locateError); - return; - } - incPendingCall(); - region = location.getRegion(); - if (region.getEndKey() > endKey) { - locateEnd = true; - } else { - locateThenCall(region.getEndKey()); - } - sendCall().whenComplete((resp, error) -> { - if (error != null) { - callback.onRegionError(region, error); - } else { - callback.onRegionComplete(region, resp); - } - if (locateEnd && decPendingCallAndGet() == 0) { - callback.onComplete(); - } - }); - }); - } - </pre></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>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onComplete--">onComplete</a></span>()</code> -<div class="block">Indicate that all responses of the regions have been notified by calling - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onRegionComplete-org.apache.hadoop.hbase.client.RegionInfo-R-"><code>onRegionComplete(RegionInfo, Object)</code></a> or - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onRegionError-org.apache.hadoop.hbase.client.RegionInfo-java.lang.Throwable-"><code>onRegionError(RegionInfo, Throwable)</code></a>.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onError-java.lang.Throwable-">onError</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> error)</code> -<div class="block">Indicate that we got an error which does not belong to any regions.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onRegionComplete-org.apache.hadoop.hbase.client.RegionInfo-R-">onRegionComplete</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region, - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html" title="type parameter in RawAsyncTable.CoprocessorCallback">R</a> resp)</code> </td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onRegionError-org.apache.hadoop.hbase.client.RegionInfo-java.lang.Throwable-">onRegionError</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> error)</code> </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="onRegionComplete-org.apache.hadoop.hbase.client.RegionInfo-java.lang.Object-"> -<!-- --> -</a><a name="onRegionComplete-org.apache.hadoop.hbase.client.RegionInfo-R-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>onRegionComplete</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#line.176">onRegionComplete</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region, - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html" title="type parameter in RawAsyncTable.CoprocessorCallback">R</a> resp)</pre> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>region</code> - the region that the response belongs to</dd> -<dd><code>resp</code> - the response of the coprocessor call</dd> -</dl> -</li> -</ul> -<a name="onRegionError-org.apache.hadoop.hbase.client.RegionInfo-java.lang.Throwable-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>onRegionError</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#line.182">onRegionError</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> error)</pre> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>region</code> - the region that the error belongs to</dd> -<dd><code>error</code> - the response error of the coprocessor call</dd> -</dl> -</li> -</ul> -<a name="onComplete--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>onComplete</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#line.189">onComplete</a>()</pre> -<div class="block">Indicate that all responses of the regions have been notified by calling - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onRegionComplete-org.apache.hadoop.hbase.client.RegionInfo-R-"><code>onRegionComplete(RegionInfo, Object)</code></a> or - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#onRegionError-org.apache.hadoop.hbase.client.RegionInfo-java.lang.Throwable-"><code>onRegionError(RegionInfo, Throwable)</code></a>.</div> -</li> -</ul> -<a name="onError-java.lang.Throwable-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>onError</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html#line.194">onError</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> error)</pre> -<div class="block">Indicate that we got an error which does not belong to any regions. Usually a locating error.</div> -</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/RawAsyncTable.CoprocessorCallback.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/RawAsyncTable.CoprocessorCallable.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/RawScanResultConsumer.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/RawAsyncTable.CoprocessorCallback.html" target="_top">Frames</a></li> -<li><a href="RawAsyncTable.CoprocessorCallback.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/67a6e2ec/apidocs/org/apache/hadoop/hbase/client/RawAsyncTable.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/RawAsyncTable.html b/apidocs/org/apache/hadoop/hbase/client/RawAsyncTable.html deleted file mode 100644 index 48f4725..0000000 --- a/apidocs/org/apache/hadoop/hbase/client/RawAsyncTable.html +++ /dev/null @@ -1,381 +0,0 @@ -<!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>RawAsyncTable (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="RawAsyncTable (Apache HBase 3.0.0-SNAPSHOT API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":6,"i1":6,"i2":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/RawAsyncTable.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/Query.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/RawAsyncTable.CoprocessorCallable.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/RawAsyncTable.html" target="_top">Frames</a></li> -<li><a href="RawAsyncTable.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li><a href="#nested.class.summary">Nested</a> | </li> -<li>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 RawAsyncTable" class="title">Interface RawAsyncTable</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Superinterfaces:</dt> -<dd><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html" title="interface in org.apache.hadoop.hbase.client">AsyncTableBase</a></dd> -</dl> -<hr> -<br> -<pre>@InterfaceAudience.Public -public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawAsyncTable.html#line.44">RawAsyncTable</a> -extends <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html" title="interface in org.apache.hadoop.hbase.client">AsyncTableBase</a></pre> -<div class="block">A low level asynchronous table. - <p> - The implementation is required to be thread safe. - <p> - The 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, otherwise - you will be likely to block at least one connection to RS(even more if the rpc framework uses - NIO). - <p> - So, only experts that want to build high performance service should use this interface directly, - especially for the <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.html#scan-org.apache.hadoop.hbase.client.Scan-org.apache.hadoop.hbase.client.RawScanResultConsumer-"><code>scan(Scan, RawScanResultConsumer)</code></a> below.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.0.0</dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== NESTED CLASS SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="nested.class.summary"> -<!-- --> -</a> -<h3>Nested Class Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> -<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Interface and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>static interface </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallable.html" title="interface in org.apache.hadoop.hbase.client">RawAsyncTable.CoprocessorCallable</a><<a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallable.html" title="type parameter in RawAsyncTable.CoprocessorCallable">S</a>,<a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallable.html" title="type parameter in RawAsyncTable.CoprocessorCallable">R</a>></span></code> -<div class="block">Delegate to a protobuf rpc call.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>static interface </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html" title="interface in org.apache.hadoop.hbase.client">RawAsyncTable.CoprocessorCallback</a><<a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html" title="type parameter in RawAsyncTable.CoprocessorCallback">R</a>></span></code> -<div class="block">The callback when we want to execute a coprocessor call on a range of regions.</div> -</td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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><S,R> <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><R></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.html#coprocessorService-java.util.function.Function-org.apache.hadoop.hbase.client.RawAsyncTable.CoprocessorCallable-byte:A-">coprocessorService</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true"; title="class or interface in java.util.function">Function</a><com.google.protobuf.RpcChannel,S> stubMaker, - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallable.html" title="interface in org.apache.hadoop.hbase.client">RawAsyncTable.CoprocessorCallable</a><S,R> callable, - byte[] row)</code> -<div class="block">Execute the given coprocessor call on the region which contains the given <code>row</code>.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code><S,R> org.apache.hadoop.hbase.client.RawAsyncTable.CoprocessorServiceBuilder<S,R></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.html#coprocessorService-java.util.function.Function-org.apache.hadoop.hbase.client.RawAsyncTable.CoprocessorCallable-org.apache.hadoop.hbase.client.RawAsyncTable.CoprocessorCallback-">coprocessorService</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true"; title="class or interface in java.util.function">Function</a><com.google.protobuf.RpcChannel,S> stubMaker, - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallable.html" title="interface in org.apache.hadoop.hbase.client">RawAsyncTable.CoprocessorCallable</a><S,R> callable, - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html" title="interface in org.apache.hadoop.hbase.client">RawAsyncTable.CoprocessorCallback</a><R> callback)</code> -<div class="block">Execute a coprocessor call on the regions which are covered by a range.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.html#scan-org.apache.hadoop.hbase.client.Scan-org.apache.hadoop.hbase.client.RawScanResultConsumer-">scan</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan, - <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer</a> consumer)</code> -<div class="block">The basic scan API uses the observer pattern.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.client.AsyncTableBase"> -<!-- --> -</a> -<h3>Methods inherited from interface org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html" title="interface in org.apache.hadoop.hbase.client">AsyncTableBase</a></h3> -<code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#append-org.apache.hadoop.hbase.client.Append-">append</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#batch-java.util.List-">batch</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#batchAll-java.util.List-">batchAll</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#checkAndMutate-byte:A-byte:A-">checkAndMutate</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#delete-org.apache.hadoop.hbase.client.Delete-">delete</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#delete-java.util.List-">delete</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#deleteAll-java.util.List-">deleteAll</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#exists-org.apache.hadoop.hbase.client.Get-">exists</a>, <a href="../.. /../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#exists-java.util.List-">exists</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#existsAll-java.util.List-">existsAll</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#get-org.apache.hadoop.hbase.client.Get-">get</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#get-java.util.List-">get</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getAll-java.util.List-">getAll</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getConfiguration--">getConfiguration</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getName--">getName</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getOperationTimeout-java.util.concurrent.TimeUnit-">getOperationTimeout</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html #getReadRpcTimeout-java.util.concurrent.TimeUnit-">getReadRpcTimeout</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getRpcTimeout-java.util.concurrent.TimeUnit-">getRpcTimeout</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getScanTimeout-java.util.concurrent.TimeUnit-">getScanTimeout</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getWriteRpcTimeout-java.util.concurrent.TimeUnit-">getWriteRpcTimeout</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#increment-org.apache.hadoop.hbase.client.Increment-">increment</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#incrementColumnValue-byte:A-byte:A-byte:A-long-">incrementColumnValue</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#incrementColumnValue-byte:A-byte:A-byte:A-long-org.apache.hadoop.hbase.client.Durability-">incrementColumnValue</a>, <a hre f="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#mutateRow-org.apache.hadoop.hbase.client.RowMutations-">mutateRow</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#put-java.util.List-">put</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#put-org.apache.hadoop.hbase.client.Put-">put</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#putAll-java.util.List-">putAll</a>, <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#scanAll-org.apache.hadoop.hbase.client.Scan-">scanAll</a></code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="scan-org.apache.hadoop.hbase.client.Scan-org.apache.hadoop.hbase.client.RawScanResultConsumer-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>scan</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawAsyncTable.html#line.63">scan</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan, - <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer</a> consumer)</pre> -<div class="block">The basic scan API uses the observer pattern. All results that match the given scan object will - be passed to the given <code>consumer</code> by calling <code>RawScanResultConsumer.onNext</code>. - <code>RawScanResultConsumer.onComplete</code> means the scan is finished, and - <code>RawScanResultConsumer.onError</code> means we hit an unrecoverable error and the scan is - terminated. <code>RawScanResultConsumer.onHeartbeat</code> means the RS is still working but we can - not get a valid result to call <code>RawScanResultConsumer.onNext</code>. This is usually because - the matched results are too sparse, for example, a filter which almost filters out everything - is specified. - <p> - Notice that, the methods of the given <code>consumer</code> will be called directly in the rpc - framework's callback thread, so typically you should not do any time consuming work inside - these methods, otherwise you will be likely to block at least one connection to RS(even more if - the rpc framework uses NIO).</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>scan</code> - A configured <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> object.</dd> -<dd><code>consumer</code> - the consumer used to receive results.</dd> -</dl> -</li> -</ul> -<a name="coprocessorService-java.util.function.Function-org.apache.hadoop.hbase.client.RawAsyncTable.CoprocessorCallable-byte:A-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>coprocessorService</h4> -<pre><S,R> <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><R> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawAsyncTable.html#line.122">coprocessorService</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true"; title="class or interface in java.util.function">Function</a><com.google.protobuf.RpcChannel,S> stubMaker, - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallable.html" title="interface in org.apache.hadoop.hbase.client">RawAsyncTable.CoprocessorCallable</a><S,R> callable, - byte[] row)</pre> -<div class="block">Execute the given coprocessor call on the region which contains the given <code>row</code>. - <p> - The <code>stubMaker</code> is just a delegation to the <code>newStub</code> call. Usually it is only a - one line lambda expression, like: - - <pre> - <code> - channel -> xxxService.newStub(channel) - </code> - </pre></div> -<dl> -<dt><span class="paramLabel">Type Parameters:</span></dt> -<dd><code>S</code> - the type of the asynchronous stub</dd> -<dd><code>R</code> - the type of the return value</dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>stubMaker</code> - a delegation to the actual <code>newStub</code> call.</dd> -<dd><code>callable</code> - a delegation to the actual protobuf rpc call. See the comment of - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallable.html" title="interface in org.apache.hadoop.hbase.client"><code>RawAsyncTable.CoprocessorCallable</code></a> for more details.</dd> -<dd><code>row</code> - The row key used to identify the remote region location</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the return value of the protobuf rpc call, wrapped by a <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>.</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallable.html" title="interface in org.apache.hadoop.hbase.client"><code>RawAsyncTable.CoprocessorCallable</code></a></dd> -</dl> -</li> -</ul> -<a name="coprocessorService-java.util.function.Function-org.apache.hadoop.hbase.client.RawAsyncTable.CoprocessorCallable-org.apache.hadoop.hbase.client.RawAsyncTable.CoprocessorCallback-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>coprocessorService</h4> -<pre><S,R> org.apache.hadoop.hbase.client.RawAsyncTable.CoprocessorServiceBuilder<S,R> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawAsyncTable.html#line.261">coprocessorService</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true"; title="class or interface in java.util.function">Function</a><com.google.protobuf.RpcChannel,S> stubMaker, - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallable.html" title="interface in org.apache.hadoop.hbase.client">RawAsyncTable.CoprocessorCallable</a><S,R> callable, - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html" title="interface in org.apache.hadoop.hbase.client">RawAsyncTable.CoprocessorCallback</a><R> callback)</pre> -<div class="block">Execute a coprocessor call on the regions which are covered by a range. - <p> - Use the returned <code>RawAsyncTable.CoprocessorServiceBuilder</code> construct your request and then execute it. - <p> - The <code>stubMaker</code> is just a delegation to the <code>xxxService.newStub</code> call. Usually it - is only a one line lambda expression, like: - - <pre> - <code> - channel -> xxxService.newStub(channel) - </code> - </pre></div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>stubMaker</code> - a delegation to the actual <code>newStub</code> call.</dd> -<dd><code>callable</code> - a delegation to the actual protobuf rpc call. See the comment of - <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallable.html" title="interface in org.apache.hadoop.hbase.client"><code>RawAsyncTable.CoprocessorCallable</code></a> for more details.</dd> -<dd><code>callback</code> - callback to get the response. See the comment of <a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTable.CoprocessorCallback.html" title="interface in org.apache.hadoop.hbase.client"><code>RawAsyncTable.CoprocessorCallback</code></a> - for more details.</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/RawAsyncTable.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/Query.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/RawAsyncTable.CoprocessorCallable.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/RawAsyncTable.html" target="_top">Frames</a></li> -<li><a href="RawAsyncTable.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li><a href="#nested.class.summary">Nested</a> | </li> -<li>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/67a6e2ec/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html b/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html deleted file mode 100644 index 0d6b634..0000000 --- a/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html +++ /dev/null @@ -1,284 +0,0 @@ -<!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>RawScanResultConsumer.ScanController (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="RawScanResultConsumer.ScanController (Apache HBase 3.0.0-SNAPSHOT API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":6,"i1":6,"i2":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/RawScanResultConsumer.ScanController.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/RawScanResultConsumer.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/RawScanResultConsumer.ScanResumer.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/RawScanResultConsumer.ScanController.html" target="_top">Frames</a></li> -<li><a href="RawScanResultConsumer.ScanController.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 RawScanResultConsumer.ScanController" class="title">Interface RawScanResultConsumer.ScanController</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>Enclosing interface:</dt> -<dd><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer</a></dd> -</dl> -<hr> -<br> -<pre>@InterfaceAudience.Public -public static interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.63">RawScanResultConsumer.ScanController</a></pre> -<div class="block">Used to suspend or stop a scan, or get a scan cursor if available. - <p> - Notice that, you should only call the <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html#suspend--"><code>suspend()</code></a> or <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html#terminate--"><code>terminate()</code></a> inside onNext - or onHeartbeat method. A IllegalStateException will be thrown if you call them at other places. - <p> - You can only call one of the <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html#suspend--"><code>suspend()</code></a> and <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html#terminate--"><code>terminate()</code></a> methods(of course you - are free to not call them both), and the methods are not reentrant. An IllegalStateException - will be thrown if you have already called one of the methods.</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/Optional.html?is-external=true"; title="class or interface in java.util">Optional</a><<a href="../../../../../org/apache/hadoop/hbase/client/Cursor.html" title="class in org.apache.hadoop.hbase.client">Cursor</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html#cursor--">cursor</a></span>()</code> -<div class="block">Get the scan cursor if available.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer.ScanResumer</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html#suspend--">suspend</a></span>()</code> -<div class="block">Suspend the scan.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html#terminate--">terminate</a></span>()</code> -<div class="block">Terminate the scan.</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="suspend--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>suspend</h4> -<pre><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer.ScanResumer</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html#line.72">suspend</a>()</pre> -<div class="block">Suspend the scan. - <p> - This means we will stop fetching data in background, i.e., will not call onNext any more - before you resume the scan.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>A resumer used to resume the scan later.</dd> -</dl> -</li> -</ul> -<a name="terminate--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>terminate</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html#line.80">terminate</a>()</pre> -<div class="block">Terminate the scan. - <p> - This is useful when you have got enough results and want to stop the scan in onNext method, - or you want to stop the scan in onHeartbeat method because it has spent too many time.</div> -</li> -</ul> -<a name="cursor--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>cursor</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true"; title="class or interface in java.util">Optional</a><<a href="../../../../../org/apache/hadoop/hbase/client/Cursor.html" title="class in org.apache.hadoop.hbase.client">Cursor</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html#line.86">cursor</a>()</pre> -<div class="block">Get the scan cursor if available.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The scan cursor.</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/RawScanResultConsumer.ScanController.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/RawScanResultConsumer.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/RawScanResultConsumer.ScanResumer.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/RawScanResultConsumer.ScanController.html" target="_top">Frames</a></li> -<li><a href="RawScanResultConsumer.ScanController.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/67a6e2ec/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html b/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html deleted file mode 100644 index 828c5fe..0000000 --- a/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html +++ /dev/null @@ -1,232 +0,0 @@ -<!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>RawScanResultConsumer.ScanResumer (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="RawScanResultConsumer.ScanResumer (Apache HBase 3.0.0-SNAPSHOT API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":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/RawScanResultConsumer.ScanResumer.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/RawScanResultConsumer.ScanController.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/RegionInfo.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/RawScanResultConsumer.ScanResumer.html" target="_top">Frames</a></li> -<li><a href="RawScanResultConsumer.ScanResumer.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 RawScanResultConsumer.ScanResumer" class="title">Interface RawScanResultConsumer.ScanResumer</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>Enclosing interface:</dt> -<dd><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer</a></dd> -</dl> -<hr> -<br> -<pre>@InterfaceAudience.Public -public static interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.43">RawScanResultConsumer.ScanResumer</a></pre> -<div class="block">Used to resume a scan.</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>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html#resume--">resume</a></span>()</code> -<div class="block">Resume the scan.</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="resume--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>resume</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html#line.49">resume</a>()</pre> -<div class="block">Resume the scan. You are free to call it multiple time but only the first call will take - effect.</div> -</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/RawScanResultConsumer.ScanResumer.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/RawScanResultConsumer.ScanController.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/RegionInfo.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/RawScanResultConsumer.ScanResumer.html" target="_top">Frames</a></li> -<li><a href="RawScanResultConsumer.ScanResumer.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/67a6e2ec/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.html b/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.html deleted file mode 100644 index 2a3cedc..0000000 --- a/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.html +++ /dev/null @@ -1,361 +0,0 @@ -<!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>RawScanResultConsumer (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="RawScanResultConsumer (Apache HBase 3.0.0-SNAPSHOT API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":6,"i1":6,"i2":18,"i3":6,"i4":18}; -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/RawScanResultConsumer.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/RawAsyncTable.CoprocessorCallback.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/RawScanResultConsumer.ScanController.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/RawScanResultConsumer.html" target="_top">Frames</a></li> -<li><a href="RawScanResultConsumer.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li><a href="#nested.class.summary">Nested</a> | </li> -<li>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 RawScanResultConsumer" class="title">Interface RawScanResultConsumer</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>@InterfaceAudience.Public -public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.37">RawScanResultConsumer</a></pre> -<div class="block">Receives <a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a> for an asynchronous scan. - <p> - Notice that, the <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-"><code>onNext(Result[], ScanController)</code></a> method will be called in the thread - which we send request to HBase service. So if you want the asynchronous scanner fetch data from - HBase in background while you process the returned data, you need to move the processing work to - another thread to make the <code>onNext</code> call return immediately. And please do NOT do any time - consuming tasks in all methods below unless you know what you are doing.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.0.0</dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== NESTED CLASS SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="nested.class.summary"> -<!-- --> -</a> -<h3>Nested Class Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> -<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Interface and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>static interface </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer.ScanController</a></span></code> -<div class="block">Used to suspend or stop a scan, or get a scan cursor if available.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>static interface </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer.ScanResumer</a></span></code> -<div class="block">Used to resume a scan.</div> -</td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onComplete--">onComplete</a></span>()</code> -<div class="block">Indicate that the scan operation is completed normally.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onError-java.lang.Throwable-">onError</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> error)</code> -<div class="block">Indicate that we hit an unrecoverable error and the scan operation is terminated.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>default void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onHeartbeat-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-">onHeartbeat</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer.ScanController</a> controller)</code> -<div class="block">Indicate that there is a heartbeat message but we have not cumulated enough cells to call - <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-"><code>onNext(Result[], ScanController)</code></a>.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-">onNext</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>[] results, - <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer.ScanController</a> controller)</code> -<div class="block">Indicate that we have receive some data.</div> -</td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>default void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onScanMetricsCreated-org.apache.hadoop.hbase.client.metrics.ScanMetrics-">onScanMetricsCreated</a></span>(org.apache.hadoop.hbase.client.metrics.ScanMetrics scanMetrics)</code> -<div class="block">If <code>scan.isScanMetricsEnabled()</code> returns true, then this method will be called prior to - all other methods in this interface to give you the <code>ScanMetrics</code> instance for this scan - operation.</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="onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>onNext</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.96">onNext</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>[] results, - <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer.ScanController</a> controller)</pre> -<div class="block">Indicate that we have receive some data.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>results</code> - the data fetched from HBase service.</dd> -<dd><code>controller</code> - used to suspend or terminate the scan. Notice that the <code>controller</code> - instance is only valid within scope of onNext method. You can only call its method in - onNext, do NOT store it and call it later outside onNext.</dd> -</dl> -</li> -</ul> -<a name="onHeartbeat-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>onHeartbeat</h4> -<pre>default void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.114">onHeartbeat</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer.ScanController</a> controller)</pre> -<div class="block">Indicate that there is a heartbeat message but we have not cumulated enough cells to call - <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-"><code>onNext(Result[], ScanController)</code></a>. - <p> - Note that this method will always be called when RS returns something to us but we do not have - enough cells to call <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-"><code>onNext(Result[], ScanController)</code></a>. Sometimes it may not be a - 'heartbeat' message for RS, for example, we have a large row with many cells and size limit is - exceeded before sending all the cells for this row. For RS it does send some data to us and the - time limit has not been reached, but we can not return the data to client so here we call this - method to tell client we have already received something. - <p> - This method give you a chance to terminate a slow scan operation.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>controller</code> - used to suspend or terminate the scan. Notice that the <code>controller</code> - instance is only valid within the scope of onHeartbeat method. You can only call its - method in onHeartbeat, do NOT store it and call it later outside onHeartbeat.</dd> -</dl> -</li> -</ul> -<a name="onError-java.lang.Throwable-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>onError</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.122">onError</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> error)</pre> -<div class="block">Indicate that we hit an unrecoverable error and the scan operation is terminated. - <p> - We will not call <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onComplete--"><code>onComplete()</code></a> after calling <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onError-java.lang.Throwable-"><code>onError(Throwable)</code></a>.</div> -</li> -</ul> -<a name="onComplete--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>onComplete</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.127">onComplete</a>()</pre> -<div class="block">Indicate that the scan operation is completed normally.</div> -</li> -</ul> -<a name="onScanMetricsCreated-org.apache.hadoop.hbase.client.metrics.ScanMetrics-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>onScanMetricsCreated</h4> -<pre>default void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.135">onScanMetricsCreated</a>(org.apache.hadoop.hbase.client.metrics.ScanMetrics scanMetrics)</pre> -<div class="block">If <code>scan.isScanMetricsEnabled()</code> returns true, then this method will be called prior to - all other methods in this interface to give you the <code>ScanMetrics</code> instance for this scan - operation. The <code>ScanMetrics</code> instance will be updated on-the-fly during the scan, you can - store it somewhere to get the metrics at any time if you want.</div> -</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/RawScanResultConsumer.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/RawAsyncTable.CoprocessorCallback.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/RawScanResultConsumer.ScanController.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/RawScanResultConsumer.html" target="_top">Frames</a></li> -<li><a href="RawScanResultConsumer.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li><a href="#nested.class.summary">Nested</a> | </li> -<li>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/67a6e2ec/apidocs/org/apache/hadoop/hbase/client/RegionInfo.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/RegionInfo.html b/apidocs/org/apache/hadoop/hbase/client/RegionInfo.html index b4b4220..fabed42 100644 --- a/apidocs/org/apache/hadoop/hbase/client/RegionInfo.html +++ b/apidocs/org/apache/hadoop/hbase/client/RegionInfo.html @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.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/Query.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/RegionLoadStats.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -912,7 +912,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/RawScanResultConsumer.ScanResumer.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/Query.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/RegionLoadStats.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList">
