blob: cc8e28956a85fb814ada107f1b5656f55acd3ad8 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>RegionCoprocessor (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, interface: RegionCoprocessor">
<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/RegionCoprocessor.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:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.hadoop.hbase.coprocessor</a></div>
<h1 title="Interface RegionCoprocessor" class="title">Interface RegionCoprocessor</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../security/access/AccessController.html" title="class in org.apache.hadoop.hbase.security.access">AccessController</a></code>, <code><a href="../backup/BackupObserver.html" title="class in org.apache.hadoop.hbase.backup">BackupObserver</a></code>, <code><a href="example/BulkDeleteEndpoint.html" title="class in org.apache.hadoop.hbase.coprocessor.example">BulkDeleteEndpoint</a></code>, <code><a href="../constraint/ConstraintProcessor.html" title="class in org.apache.hadoop.hbase.constraint">ConstraintProcessor</a></code>, <code><a href="example/ExampleRegionObserverWithMetrics.html" title="class in org.apache.hadoop.hbase.coprocessor.example">ExampleRegionObserverWithMetrics</a></code>, <code><a href="example/ExampleRegionObserverWithMetrics.ExampleRegionObserver.html" title="class in org.apache.hadoop.hbase.coprocessor.example">ExampleRegionObserverWithMetrics.ExampleRegionObserver</a></code>, <code><a href="MetaTableMetrics.html" title="class in org.apache.hadoop.hbase.coprocessor">MetaTableMetrics</a></code>, <code><a href="MetaTableMetrics.ExampleRegionObserverMeta.html" title="class in org.apache.hadoop.hbase.coprocessor">MetaTableMetrics.ExampleRegionObserverMeta</a></code>, <code><a href="MultiRowMutationEndpoint.html" title="class in org.apache.hadoop.hbase.coprocessor">MultiRowMutationEndpoint</a></code>, <code><a href="example/RefreshHFilesEndpoint.html" title="class in org.apache.hadoop.hbase.coprocessor.example">RefreshHFilesEndpoint</a></code>, <code><a href="../replication/regionserver/ReplicationObserver.html" title="class in org.apache.hadoop.hbase.replication.regionserver">ReplicationObserver</a></code>, <code><a href="example/RowCountEndpoint.html" title="class in org.apache.hadoop.hbase.coprocessor.example">RowCountEndpoint</a></code>, <code><a href="example/ScanModifyingObserver.html" title="class in org.apache.hadoop.hbase.coprocessor.example">ScanModifyingObserver</a></code>, <code><a href="../security/token/TokenProvider.html" title="class in org.apache.hadoop.hbase.security.token">TokenProvider</a></code>, <code><a href="example/ValueRewritingObserver.html" title="class in org.apache.hadoop.hbase.coprocessor.example">ValueRewritingObserver</a></code>, <code><a href="../security/visibility/VisibilityController.html" title="class in org.apache.hadoop.hbase.security.visibility">VisibilityController</a></code>, <code><a href="example/WriteHeavyIncrementObserver.html" title="class in org.apache.hadoop.hbase.coprocessor.example">WriteHeavyIncrementObserver</a></code>, <code><a href="../tool/WriteSinkCoprocessor.html" title="class in org.apache.hadoop.hbase.tool">WriteSinkCoprocessor</a></code>, <code><a href="example/ZooKeeperScanPolicyObserver.html" title="class in org.apache.hadoop.hbase.coprocessor.example">ZooKeeperScanPolicyObserver</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations">@LimitedPrivate("Coprocesssor")
@Evolving
</span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/RegionCoprocessor.html#line-26">RegionCoprocessor</a></span><span class="extends-implements">
extends <a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></span></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.Coprocessor">Nested classes/interfaces inherited from interface&nbsp;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="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.Coprocessor">Fields inherited from interface&nbsp;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>
<!-- ========== 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-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="BulkLoadObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">BulkLoadObserver</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getBulkLoadObserver()" class="member-name-link">getBulkLoadObserver</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="EndpointObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">EndpointObserver</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getEndpointObserver()" class="member-name-link">getEndpointObserver</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="RegionObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionObserver</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRegionObserver()" class="member-name-link">getRegionObserver</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.Coprocessor">Methods inherited from interface&nbsp;org.apache.hadoop.hbase.<a href="../Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></h3>
<code><a href="../Coprocessor.html#getServices()">getServices</a>, <a href="../Coprocessor.html#start(org.apache.hadoop.hbase.CoprocessorEnvironment)">start</a>, <a href="../Coprocessor.html#stop(org.apache.hadoop.hbase.CoprocessorEnvironment)">stop</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getRegionObserver()">
<h3>getRegionObserver</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="RegionObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">RegionObserver</a>&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/RegionCoprocessor.html#line-30">getRegionObserver</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="getEndpointObserver()">
<h3>getEndpointObserver</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="EndpointObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">EndpointObserver</a>&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/RegionCoprocessor.html#line-34">getEndpointObserver</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="getBulkLoadObserver()">
<h3>getBulkLoadObserver</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="BulkLoadObserver.html" title="interface in org.apache.hadoop.hbase.coprocessor">BulkLoadObserver</a>&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/coprocessor/RegionCoprocessor.html#line-38">getBulkLoadObserver</a></span>()</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>