| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>MultiRowMutationEndpoint (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.coprocessor, class: MultiRowMutationEndpoint"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/MultiRowMutationEndpoint.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.coprocessor</a></div> |
| <h1 title="Class MultiRowMutationEndpoint" class="title">Class MultiRowMutationEndpoint</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService |
| <div class="inheritance">org.apache.hadoop.hbase.coprocessor.MultiRowMutationEndpoint</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code>, <code><a href="RegionCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionCoprocessor</a></code>, <code>org.apache.hbase.thirdparty.com.google.protobuf.Service</code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@LimitedPrivate("Coprocesssor") |
| @Evolving |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/MultiRowMutationEndpoint.html#line-102">MultiRowMutationEndpoint</a></span> |
| <span class="extends-implements">extends org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService |
| implements <a href="RegionCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionCoprocessor</a></span></div> |
| <div class="block">This class implements atomic multi row transactions using |
| <a href="../regionserver/HRegion.html#mutateRowsWithLocks(java.util.Collection,java.util.Collection,long,long)"><code>HRegion.mutateRowsWithLocks(Collection, Collection, long, long)</code></a> and Coprocessor |
| endpoints. We can also specify some conditions to perform conditional update. Defines a protocol |
| to perform multi row transactions. See <a href="MultiRowMutationEndpoint.html" title="class in org.apache.hadoop.hbase.coprocessor"><code>MultiRowMutationEndpoint</code></a> for the implementation. |
| <br> |
| See <a href="../regionserver/HRegion.html#mutateRowsWithLocks(java.util.Collection,java.util.Collection,long,long)"><code>HRegion.mutateRowsWithLocks(Collection, Collection, long, long)</code></a> for details and |
| limitations. <br> |
| Example: <code> |
| Put p = new Put(row1); |
| Delete d = new Delete(row2); |
| Increment i = new Increment(row3); |
| Append a = new Append(row4); |
| ... |
| Mutate m1 = ProtobufUtil.toMutate(MutateType.PUT, p); |
| Mutate m2 = ProtobufUtil.toMutate(MutateType.DELETE, d); |
| Mutate m3 = ProtobufUtil.toMutate(MutateType.INCREMENT, i); |
| Mutate m4 = ProtobufUtil.toMutate(MutateType.Append, a); |
| |
| MutateRowsRequest.Builder mrmBuilder = MutateRowsRequest.newBuilder(); |
| mrmBuilder.addMutationRequest(m1); |
| mrmBuilder.addMutationRequest(m2); |
| mrmBuilder.addMutationRequest(m3); |
| mrmBuilder.addMutationRequest(m4); |
| |
| // We can also specify conditions to preform conditional update |
| mrmBuilder.addCondition(ProtobufUtil.toCondition(row, FAMILY, QUALIFIER, |
| CompareOperator.EQUAL, value, TimeRange.allTime())); |
| |
| CoprocessorRpcChannel channel = t.coprocessorService(ROW); |
| MultiRowMutationService.BlockingInterface service = |
| MultiRowMutationService.newBlockingStub(channel); |
| MutateRowsRequest mrm = mrmBuilder.build(); |
| MutateRowsResponse response = service.mutateRows(null, mrm); |
| |
| // We can get the result of the conditional update |
| boolean processed = response.getProcessed(); |
| </code></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService">Nested classes/interfaces inherited from class org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService</h2> |
| <code>org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService.BlockingInterface, org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService.Interface, org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService.Stub</code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.hadoop.hbase.Coprocessor">Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.<a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></h2> |
| <code><a href="../Coprocessor.State.html" title="enum class in org.apache.hadoop.hbase">Coprocessor.State</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private <a href="RegionCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionCoprocessorEnvironment</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#env" class="member-name-link">env</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private static final org.slf4j.Logger</code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOGGER" class="member-name-link">LOGGER</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.Coprocessor">Fields inherited from interface org.apache.hadoop.hbase.<a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></h3> |
| <code><a href="../Coprocessor.html#PRIORITY_HIGHEST">PRIORITY_HIGHEST</a>, <a href="../Coprocessor.html#PRIORITY_LOWEST">PRIORITY_LOWEST</a>, <a href="../Coprocessor.html#PRIORITY_SYSTEM">PRIORITY_SYSTEM</a>, <a href="../Coprocessor.html#PRIORITY_USER">PRIORITY_USER</a>, <a href="../Coprocessor.html#VERSION">VERSION</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">MultiRowMutationEndpoint</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkFamily(org.apache.hadoop.hbase.regionserver.Region,byte%5B%5D)" class="member-name-link">checkFamily</a><wbr>(<a href="../regionserver/Region.html" title="interface in org.apache.hadoop.hbase.regionserver">Region</a> region, |
| byte[] family)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><org.apache.hbase.thirdparty.com.google.protobuf.Service></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getServices()" class="member-name-link">getServices</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Coprocessor endpoints providing protobuf services should override this method.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#matches(org.apache.hadoop.hbase.CompareOperator,int)" class="member-name-link">matches</a><wbr>(<a href="../CompareOperator.html" title="enum class in org.apache.hadoop.hbase">CompareOperator</a> op, |
| int compareResult)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#matches(org.apache.hadoop.hbase.regionserver.Region,org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.Condition)" class="member-name-link">matches</a><wbr>(<a href="../regionserver/Region.html" title="interface in org.apache.hadoop.hbase.regionserver">Region</a> region, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.Condition condition)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#mutateRows(org.apache.hbase.thirdparty.com.google.protobuf.RpcController,org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MutateRowsRequest,org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback)" class="member-name-link">mutateRows</a><wbr>(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MutateRowsRequest request, |
| org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MutateRowsResponse> done)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start(org.apache.hadoop.hbase.CoprocessorEnvironment)" class="member-name-link">start</a><wbr>(<a href="../CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a> env)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Stores a reference to the coprocessor environment provided by the |
| <a href="../regionserver/RegionCoprocessorHost.html" title="class in org.apache.hadoop.hbase.regionserver"><code>RegionCoprocessorHost</code></a> from the region where this |
| coprocessor is loaded.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stop(org.apache.hadoop.hbase.CoprocessorEnvironment)" class="member-name-link">stop</a><wbr>(<a href="../CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a> env)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Called by the <a href="../CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> during it's own shutdown to stop the coprocessor.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService">Methods inherited from class org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService</h3> |
| <code>callMethod, getDescriptor, getDescriptorForType, getRequestPrototype, getResponsePrototype, newBlockingStub, newReflectiveBlockingService, newReflectiveService, newStub</code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.coprocessor.RegionCoprocessor">Methods inherited from interface org.apache.hadoop.hbase.coprocessor.<a href="RegionCoprocessor.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionCoprocessor</a></h3> |
| <code><a href="RegionCoprocessor.html#getBulkLoadObserver()">getBulkLoadObserver</a>, <a href="RegionCoprocessor.html#getEndpointObserver()">getEndpointObserver</a>, <a href="RegionCoprocessor.html#getRegionObserver()">getRegionObserver</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="LOGGER"> |
| <h3>LOGGER</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/MultiRowMutationEndpoint.html#line-105">LOGGER</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="env"> |
| <h3>env</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="RegionCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionCoprocessorEnvironment</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/MultiRowMutationEndpoint.html#line-107">env</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>MultiRowMutationEndpoint</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/MultiRowMutationEndpoint.html#line-104">MultiRowMutationEndpoint</a></span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="mutateRows(org.apache.hbase.thirdparty.com.google.protobuf.RpcController,org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MutateRowsRequest,org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback)"> |
| <h3>mutateRows</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/MultiRowMutationEndpoint.html#line-109">mutateRows</a></span><wbr><span class="parameters">(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MutateRowsRequest request, |
| org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MutateRowsResponse> done)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>mutateRows</code> in class <code>org.apache.hadoop.hbase.shaded.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="matches(org.apache.hadoop.hbase.regionserver.Region,org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.Condition)"> |
| <h3>matches</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/MultiRowMutationEndpoint.html#line-187">matches</a></span><wbr><span class="parameters">(<a href="../regionserver/Region.html" title="interface in org.apache.hadoop.hbase.regionserver">Region</a> region, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.Condition condition)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkFamily(org.apache.hadoop.hbase.regionserver.Region,byte[])"> |
| <h3>checkFamily</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/MultiRowMutationEndpoint.html#line-247">checkFamily</a></span><wbr><span class="parameters">(<a href="../regionserver/Region.html" title="interface in org.apache.hadoop.hbase.regionserver">Region</a> region, |
| byte[] family)</span> |
| throws <span class="exceptions"><a href="../regionserver/NoSuchColumnFamilyException.html" title="class in org.apache.hadoop.hbase.regionserver">NoSuchColumnFamilyException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="../regionserver/NoSuchColumnFamilyException.html" title="class in org.apache.hadoop.hbase.regionserver">NoSuchColumnFamilyException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="matches(org.apache.hadoop.hbase.CompareOperator,int)"> |
| <h3>matches</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/MultiRowMutationEndpoint.html#line-254">matches</a></span><wbr><span class="parameters">(<a href="../CompareOperator.html" title="enum class in org.apache.hadoop.hbase">CompareOperator</a> op, |
| int compareResult)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServices()"> |
| <h3>getServices</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><org.apache.hbase.thirdparty.com.google.protobuf.Service></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/MultiRowMutationEndpoint.html#line-273">getServices</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Coprocessor.html#getServices()">Coprocessor</a></code></span></div> |
| <div class="block">Coprocessor endpoints providing protobuf services should override this method.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Coprocessor.html#getServices()">getServices</a></code> in interface <code><a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Iterable of <code>Service</code>s or empty collection. Implementations should never return |
| null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="start(org.apache.hadoop.hbase.CoprocessorEnvironment)"> |
| <h3>start</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/MultiRowMutationEndpoint.html#line-288">start</a></span><wbr><span class="parameters">(<a href="../CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a> env)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Stores a reference to the coprocessor environment provided by the |
| <a href="../regionserver/RegionCoprocessorHost.html" title="class in org.apache.hadoop.hbase.regionserver"><code>RegionCoprocessorHost</code></a> from the region where this |
| coprocessor is loaded. Since this is a coprocessor endpoint, it always expects to be loaded on |
| a table region, so always expects this to be an instance of |
| <a href="RegionCoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase.coprocessor"><code>RegionCoprocessorEnvironment</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Coprocessor.html#start(org.apache.hadoop.hbase.CoprocessorEnvironment)">start</a></code> in interface <code><a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>env</code> - the environment provided by the coprocessor host</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if the provided environment is not an instance of |
| <code>RegionCoprocessorEnvironment</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stop(org.apache.hadoop.hbase.CoprocessorEnvironment)"> |
| <h3>stop</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/MultiRowMutationEndpoint.html#line-297">stop</a></span><wbr><span class="parameters">(<a href="../CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a> env)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../Coprocessor.html#stop(org.apache.hadoop.hbase.CoprocessorEnvironment)">Coprocessor</a></code></span></div> |
| <div class="block">Called by the <a href="../CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase"><code>CoprocessorEnvironment</code></a> during it's own shutdown to stop the coprocessor.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Coprocessor.html#stop(org.apache.hadoop.hbase.CoprocessorEnvironment)">stop</a></code> in interface <code><a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
