| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AsyncTable.CoprocessorServiceBuilder (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AsyncTable.CoprocessorServiceBuilder (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":18,"i2":6,"i3":18,"i4":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/AsyncTable.CoprocessorServiceBuilder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.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/AsyncTableBuilder.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" target="_top">Frames</a></li> |
| <li><a href="AsyncTable.CoprocessorServiceBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.hbase.client</div> |
| <h2 title="Interface AsyncTable.CoprocessorServiceBuilder" class="title">Interface AsyncTable.CoprocessorServiceBuilder<S,R></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - the type of the protobuf Service you want to call.</dd> |
| <dd><code>R</code> - the type of the return value.</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/client/RawAsyncTableImpl.CoprocessorServiceBuilderImpl.html" title="class in org.apache.hadoop.hbase.client">RawAsyncTableImpl.CoprocessorServiceBuilderImpl</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><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/AsyncTable.html" title="type parameter in AsyncTable">C</a> extends <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumerBase.html" title="interface in org.apache.hadoop.hbase.client">ScanResultConsumerBase</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.html#line.673">AsyncTable.CoprocessorServiceBuilder</a><S,R></pre> |
| <div class="block">Helper class for sending coprocessorService request that executes a coprocessor call on regions |
| which are covered by a range. |
| <p> |
| If <code>fromRow</code> is not specified the selection will start with the first table region. If |
| <code>toRow</code> is not specified the selection will continue through the last table region.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html#execute--">execute</a></span>()</code> |
| <div class="block">Execute the coprocessorService request.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable.CoprocessorServiceBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">S</a>,<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">R</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html#fromRow-byte:A-">fromRow</a></span>(byte[] startKey)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable.CoprocessorServiceBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">S</a>,<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">R</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html#fromRow-byte:A-boolean-">fromRow</a></span>(byte[] startKey, |
| boolean inclusive)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable.CoprocessorServiceBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">S</a>,<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">R</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html#toRow-byte:A-">toRow</a></span>(byte[] endKey)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable.CoprocessorServiceBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">S</a>,<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">R</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html#toRow-byte:A-boolean-">toRow</a></span>(byte[] endKey, |
| boolean inclusive)</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="fromRow-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromRow</h4> |
| <pre>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable.CoprocessorServiceBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">S</a>,<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">R</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html#line.678">fromRow</a>(byte[] startKey)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startKey</code> - start region selection with region containing this row, inclusive.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fromRow-byte:A-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromRow</h4> |
| <pre><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable.CoprocessorServiceBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">S</a>,<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">R</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html#line.686">fromRow</a>(byte[] startKey, |
| boolean inclusive)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startKey</code> - start region selection with region containing this row</dd> |
| <dd><code>inclusive</code> - whether to include the startKey</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toRow-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toRow</h4> |
| <pre>default <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable.CoprocessorServiceBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">S</a>,<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">R</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html#line.691">toRow</a>(byte[] endKey)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endKey</code> - select regions up to and including the region containing this row, exclusive.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toRow-byte:A-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toRow</h4> |
| <pre><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="interface in org.apache.hadoop.hbase.client">AsyncTable.CoprocessorServiceBuilder</a><<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">S</a>,<a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" title="type parameter in AsyncTable.CoprocessorServiceBuilder">R</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html#line.699">toRow</a>(byte[] endKey, |
| boolean inclusive)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endKey</code> - select regions up to and including the region containing this row</dd> |
| <dd><code>inclusive</code> - whether to include the endKey</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html#line.705">execute</a>()</pre> |
| <div class="block">Execute the coprocessorService request. You can get the response through the |
| <a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.CoprocessorCallback.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable.CoprocessorCallback</code></a>.</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/AsyncTable.CoprocessorServiceBuilder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/client/AsyncTable.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/AsyncTableBuilder.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/AsyncTable.CoprocessorServiceBuilder.html" target="_top">Frames</a></li> |
| <li><a href="AsyncTable.CoprocessorServiceBuilder.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–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
