http://git-wip-us.apache.org/repos/asf/hbase-site/blob/67a6e2ec/apidocs/org/apache/hadoop/hbase/class-use/ServerName.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/class-use/ServerName.html b/apidocs/org/apache/hadoop/hbase/class-use/ServerName.html index 099a594..af6c713 100644 --- a/apidocs/org/apache/hadoop/hbase/class-use/ServerName.html +++ b/apidocs/org/apache/hadoop/hbase/class-use/ServerName.html @@ -418,8 +418,8 @@ </tr> <tr class="rowColor"> <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"><span class="typeNameLabel">AsyncAdmin.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html#coprocessorService-java.util.function.Function-org.apache.hadoop.hbase.client.RawAsyncTable.CoprocessorCallable-org.apache.hadoop.hbase.ServerName-">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, +<td class="colLast"><span class="typeNameLabel">AsyncAdmin.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html#coprocessorService-java.util.function.Function-org.apache.hadoop.hbase.client.ServiceCaller-org.apache.hadoop.hbase.ServerName-">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/ServiceCaller.html" title="interface in org.apache.hadoop.hbase.client">ServiceCaller</a><S,R> callable, <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> serverName)</code> <div class="block">Execute the given coprocessor call on the given region server.</div> </td>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/67a6e2ec/apidocs/org/apache/hadoop/hbase/class-use/TableName.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/class-use/TableName.html b/apidocs/org/apache/hadoop/hbase/class-use/TableName.html index 7286958..f3ce3d4 100644 --- a/apidocs/org/apache/hadoop/hbase/class-use/TableName.html +++ b/apidocs/org/apache/hadoop/hbase/class-use/TableName.html @@ -424,21 +424,21 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></td> -<td class="colLast"><span class="typeNameLabel">AsyncTableBase.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#getName--">getName</a></span>()</code> +<td class="colLast"><span class="typeNameLabel">RegionLocator.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionLocator.html#getName--">getName</a></span>()</code> <div class="block">Gets the fully qualified table name instance of this table.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></td> -<td class="colLast"><span class="typeNameLabel">RegionLocator.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RegionLocator.html#getName--">getName</a></span>()</code> -<div class="block">Gets the fully qualified table name instance of this table.</div> +<td class="colLast"><span class="typeNameLabel">AsyncBufferedMutator.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncBufferedMutator.html#getName--">getName</a></span>()</code> +<div class="block">Gets the fully qualified table name instance of the table that this + <code>AsyncBufferedMutator</code> writes to.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></td> -<td class="colLast"><span class="typeNameLabel">AsyncBufferedMutator.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncBufferedMutator.html#getName--">getName</a></span>()</code> -<div class="block">Gets the fully qualified table name instance of the table that this - <code>AsyncBufferedMutator</code> writes to.</div> +<td class="colLast"><span class="typeNameLabel">AsyncTable.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html#getName--">getName</a></span>()</code> +<div class="block">Gets the fully qualified table name instance of this table.</div> </td> </tr> <tr class="altColor"> @@ -795,29 +795,41 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> </td> </tr> <tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><span class="typeNameLabel">AsyncAdmin.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html#disableTableReplication-org.apache.hadoop.hbase.TableName-">disableTableReplication</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> +<div class="block">Disable a table's replication switch.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="typeNameLabel">Admin.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Admin.html#disableTableReplication-org.apache.hadoop.hbase.TableName-">disableTableReplication</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> <div class="block">Disable a table's replication switch.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> <td class="colLast"><span class="typeNameLabel">AsyncAdmin.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html#enableTable-org.apache.hadoop.hbase.TableName-">enableTable</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> <div class="block">Enable a table.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="typeNameLabel">Admin.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Admin.html#enableTable-org.apache.hadoop.hbase.TableName-">enableTable</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> <div class="block">Enable a table.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true"; title="class or interface in java.util.concurrent">Future</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> <td class="colLast"><span class="typeNameLabel">Admin.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Admin.html#enableTableAsync-org.apache.hadoop.hbase.TableName-">enableTableAsync</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> <div class="block">Enable the table but does not block and wait for it to be completely enabled.</div> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true"; title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><span class="typeNameLabel">AsyncAdmin.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncAdmin.html#enableTableReplication-org.apache.hadoop.hbase.TableName-">enableTableReplication</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> +<div class="block">Enable a table's replication switch.</div> +</td> +</tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="typeNameLabel">Admin.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Admin.html#enableTableReplication-org.apache.hadoop.hbase.TableName-">enableTableReplication</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> @@ -919,18 +931,6 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> </td> </tr> <tr 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"><span class="typeNameLabel">AsyncConnection.</span><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 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"><span class="typeNameLabel">AsyncConnection.</span><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 class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><byte[],<a href="../../../../../org/apache/hadoop/hbase/RegionLoad.html" title="class in org.apache.hadoop.hbase">RegionLoad</a>></code></td> <td class="colLast"><span class="typeNameLabel">Admin.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Admin.html#getRegionLoad-org.apache.hadoop.hbase.ServerName-org.apache.hadoop.hbase.TableName-">getRegionLoad</a></span>(<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> serverName, <a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> @@ -969,17 +969,29 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable</a><<a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client">AdvancedScanResultConsumer</a>></code></td> +<td class="colLast"><span class="typeNameLabel">AsyncConnection.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getTable-org.apache.hadoop.hbase.TableName-">getTable</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/AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a> implementation for accessing a table.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></code></td> <td class="colLast"><span class="typeNameLabel">Connection.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Connection.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 a Table implementation for accessing a table.</div> </td> </tr> -<tr 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> +<tr class="rowColor"> +<td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable</a><<a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client">ScanResultConsumer</a>></code></td> <td class="colLast"><span class="typeNameLabel">AsyncConnection.</span><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> +<div class="block">Retrieve an <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a> implementation for accessing a table.</div> +</td> +</tr> +<tr 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/AdvancedScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client">AdvancedScanResultConsumer</a>></code></td> +<td class="colLast"><span class="typeNameLabel">AsyncConnection.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html#getTableBuilder-org.apache.hadoop.hbase.TableName-">getTableBuilder</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/AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a>.</div> </td> </tr> <tr class="rowColor"> @@ -990,7 +1002,7 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> </td> </tr> <tr 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/AsyncTable.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable</a>></code></td> +<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/ScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client">ScanResultConsumer</a>></code></td> <td class="colLast"><span class="typeNameLabel">AsyncConnection.</span><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> <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/AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a>.</div> @@ -1763,6 +1775,21 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> </tbody> </table> <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../org/apache/hadoop/hbase/replication/package-summary.html">org.apache.hadoop.hbase.replication</a> with parameters of type <a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="typeNameLabel">ReplicationPeerConfig.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/replication/ReplicationPeerConfig.html#needToReplicate-org.apache.hadoop.hbase.TableName-">needToReplicate</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> table)</code> +<div class="block">Decide whether the table need replicate to the peer cluster</div> +</td> +</tr> +</tbody> +</table> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> <caption><span>Method parameters in <a href="../../../../../org/apache/hadoop/hbase/replication/package-summary.html">org.apache.hadoop.hbase.replication</a> with type arguments of type <a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/67a6e2ec/apidocs/org/apache/hadoop/hbase/client/Admin.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/Admin.html b/apidocs/org/apache/hadoop/hbase/client/Admin.html index a9c3e3b..2a49d58 100644 --- a/apidocs/org/apache/hadoop/hbase/client/Admin.html +++ b/apidocs/org/apache/hadoop/hbase/client/Admin.html @@ -50,7 +50,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li>Prev Class</li> -<li><a href="../../../../../org/apache/hadoop/hbase/client/Append.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.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/Admin.html" target="_top">Frames</a></li> @@ -6221,7 +6221,7 @@ default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.ht <div class="subNav"> <ul class="navList"> <li>Prev Class</li> -<li><a href="../../../../../org/apache/hadoop/hbase/client/Append.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.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/Admin.html" target="_top">Frames</a></li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/67a6e2ec/apidocs/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.ScanController.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.ScanController.html b/apidocs/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.ScanController.html new file mode 100644 index 0000000..fc9ec7e --- /dev/null +++ b/apidocs/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.ScanController.html @@ -0,0 +1,284 @@ +<!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>AdvancedScanResultConsumer.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="AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.ScanController.html" target="_top">Frames</a></li> +<li><a href="AdvancedScanResultConsumer.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 AdvancedScanResultConsumer.ScanController" class="title">Interface AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client">AdvancedScanResultConsumer</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.Public +public static interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html#line.68">AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.ScanController.html#suspend--"><code>suspend()</code></a> or <a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.ScanController.html#suspend--"><code>suspend()</code></a> and <a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.ScanResumer.html" title="interface in org.apache.hadoop.hbase.client">AdvancedScanResultConsumer.ScanResumer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.ScanResumer.html" title="interface in org.apache.hadoop.hbase.client">AdvancedScanResultConsumer.ScanResumer</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.ScanController.html#line.77">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/AdvancedScanResultConsumer.ScanController.html#line.85">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/AdvancedScanResultConsumer.ScanController.html#line.91">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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.ScanController.html" target="_top">Frames</a></li> +<li><a href="AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.ScanResumer.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.ScanResumer.html b/apidocs/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.ScanResumer.html new file mode 100644 index 0000000..6d17ab9 --- /dev/null +++ b/apidocs/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.ScanResumer.html @@ -0,0 +1,232 @@ +<!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>AdvancedScanResultConsumer.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="AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.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/Append.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/AdvancedScanResultConsumer.ScanResumer.html" target="_top">Frames</a></li> +<li><a href="AdvancedScanResultConsumer.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 AdvancedScanResultConsumer.ScanResumer" class="title">Interface AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client">AdvancedScanResultConsumer</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.Public +public static interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html#line.48">AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.ScanResumer.html#line.54">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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.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/Append.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/AdvancedScanResultConsumer.ScanResumer.html" target="_top">Frames</a></li> +<li><a href="AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html b/apidocs/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html new file mode 100644 index 0000000..5ead94e --- /dev/null +++ b/apidocs/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html @@ -0,0 +1,325 @@ +<!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>AdvancedScanResultConsumer (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="AdvancedScanResultConsumer (Apache HBase 3.0.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":18,"i1":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/AdvancedScanResultConsumer.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/Admin.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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.html" target="_top">Frames</a></li> +<li><a href="AdvancedScanResultConsumer.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 AdvancedScanResultConsumer" class="title">Interface AdvancedScanResultConsumer</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/ScanResultConsumerBase.html" title="interface in org.apache.hadoop.hbase.client">ScanResultConsumerBase</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.Public +public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html#line.42">AdvancedScanResultConsumer</a> +extends <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumerBase.html" title="interface in org.apache.hadoop.hbase.client">ScanResultConsumerBase</a></pre> +<div class="block">This is the low level API for asynchronous scan. + <p> + All results that match the given scan object will be passed to this class by calling + <a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.AdvancedScanResultConsumer.ScanController-"><code>onNext(Result[], ScanController)</code></a>. <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumerBase.html#onComplete--"><code>ScanResultConsumerBase.onComplete()</code></a> means the scan is finished, and + <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumerBase.html#onError-java.lang.Throwable-"><code>ScanResultConsumerBase.onError(Throwable)</code></a> means we hit an unrecoverable error and the scan is terminated. + <a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html#onHeartbeat-org.apache.hadoop.hbase.client.AdvancedScanResultConsumer.ScanController-"><code>onHeartbeat(ScanController)</code></a> means the RS is still working but we can not get a valid + result to call <a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.AdvancedScanResultConsumer.ScanController-"><code>onNext(Result[], ScanController)</code></a>. This is usually because the matched + results are too sparse, for example, a filter which almost filters out everything is specified. + <p> + Notice that, all the methods here will be called directly 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 + <a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.AdvancedScanResultConsumer.ScanController-"><code>onNext(Result[], ScanController)</code></a> call return immediately. And please do NOT do any time + consuming tasks in these methods 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/AdvancedScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.ScanResumer.html" title="interface in org.apache.hadoop.hbase.client">AdvancedScanResultConsumer.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>default void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html#onHeartbeat-org.apache.hadoop.hbase.client.AdvancedScanResultConsumer.ScanController-">onHeartbeat</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.AdvancedScanResultConsumer.ScanController-"><code>onNext(Result[], ScanController)</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/AdvancedScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">AdvancedScanResultConsumer.ScanController</a> controller)</code> +<div class="block">Indicate that we have receive some data.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.client.ScanResultConsumerBase"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumerBase.html" title="interface in org.apache.hadoop.hbase.client">ScanResultConsumerBase</a></h3> +<code><a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumerBase.html#onComplete--">onComplete</a>, <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumerBase.html#onError-java.lang.Throwable-">onError</a>, <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumerBase.html#onScanMetricsCreated-org.apache.hadoop.hbase.client.metrics.ScanMetrics-">onScanMetricsCreated</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="onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.AdvancedScanResultConsumer.ScanController-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onNext</h4> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html#line.101">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/AdvancedScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">AdvancedScanResultConsumer.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.AdvancedScanResultConsumer.ScanController-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>onHeartbeat</h4> +<pre>default void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.html#line.119">onHeartbeat</a>(<a href="../../../../../org/apache/hadoop/hbase/client/AdvancedScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.AdvancedScanResultConsumer.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> +</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/AdvancedScanResultConsumer.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/Admin.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/AdvancedScanResultConsumer.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/AdvancedScanResultConsumer.html" target="_top">Frames</a></li> +<li><a href="AdvancedScanResultConsumer.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/Append.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/Append.html b/apidocs/org/apache/hadoop/hbase/client/Append.html index e197d63..24af617 100644 --- a/apidocs/org/apache/hadoop/hbase/client/Append.html +++ b/apidocs/org/apache/hadoop/hbase/client/Append.html @@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/hadoop/hbase/client/Admin.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/AdvancedScanResultConsumer.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/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -686,7 +686,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Append.html" </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/hadoop/hbase/client/Admin.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/AdvancedScanResultConsumer.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/AsyncAdmin.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList">
