| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ClusterMetrics (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, interface: ClusterMetrics"> |
| <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/ClusterMetrics.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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</a></div> |
| <h1 title="Interface ClusterMetrics" class="title">Interface ClusterMetrics</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="ClusterMetricsBuilder.ClusterMetricsImpl.html" title="class in org.apache.hadoop.hbase">ClusterMetricsBuilder.ClusterMetricsImpl</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Public |
| </span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-69">ClusterMetrics</a></span></div> |
| <div class="block">Metrics information on the HBase cluster. |
| <p> |
| <tt>ClusterMetrics</tt> provides clients with information such as: |
| <ul> |
| <li>The count and names of region servers in the cluster.</li> |
| <li>The count and names of dead region servers in the cluster.</li> |
| <li>The name of the active master for the cluster.</li> |
| <li>The name(s) of the backup master(s) for the cluster, if they exist.</li> |
| <li>The average cluster load.</li> |
| <li>The number of regions deployed on the cluster.</li> |
| <li>The number of requests since last report.</li> |
| <li>Detailed region server loading and resource usage information, per server and per |
| region.</li> |
| <li>Regions in transition at master</li> |
| <li>The unique cluster ID</li> |
| </ul> |
| <tt><a href="ClusterMetrics.Option.html" title="enum class in org.apache.hadoop.hbase"><code>ClusterMetrics.Option</code></a></tt> provides a way to get desired ClusterStatus information. The following |
| codes will get all the cluster information. |
| |
| <pre> |
| { |
| @code |
| // Original version still works |
| Admin admin = connection.getAdmin(); |
| ClusterMetrics metrics = admin.getClusterStatus(); |
| // or below, a new version which has the same effects |
| ClusterMetrics metrics = admin.getClusterStatus(EnumSet.allOf(Option.class)); |
| } |
| </pre> |
| |
| If information about live servers is the only wanted. then codes in the following way: |
| |
| <pre> |
| { |
| @code |
| Admin admin = connection.getAdmin(); |
| ClusterMetrics metrics = admin.getClusterStatus(EnumSet.of(Option.LIVE_SERVERS)); |
| } |
| </pre></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="caption"><span>Nested Classes</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">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="ClusterMetrics.Option.html" class="type-name-link" title="enum class in org.apache.hadoop.hbase">ClusterMetrics.Option</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Kinds of ClusterMetrics</div> |
| </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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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 double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getAverageLoad()" class="member-name-link">getAverageLoad</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns the average cluster load</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBackupMasterNames()" class="member-name-link">getBackupMasterNames</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the names of backup masters</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBalancerOn()" class="member-name-link">getBalancerOn</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getClusterId()" class="member-name-link">getClusterId</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDeadServerNames()" class="member-name-link">getDeadServerNames</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the names of region servers on the dead list</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDecommissionedServerNames()" class="member-name-link">getDecommissionedServerNames</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the names of region servers on the decommissioned list</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getHBaseVersion()" class="member-name-link">getHBaseVersion</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the HBase version string as reported by the HMaster</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getLastMajorCompactionTimestamp(byte%5B%5D)" class="member-name-link">getLastMajorCompactionTimestamp</a><wbr>(byte[] regionName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getLastMajorCompactionTimestamp(org.apache.hadoop.hbase.TableName)" class="member-name-link">getLastMajorCompactionTimestamp</a><wbr>(<a href="TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> table)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>,<wbr><a href="ServerMetrics.html" title="interface in org.apache.hadoop.hbase">ServerMetrics</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLiveServerMetrics()" class="member-name-link">getLiveServerMetrics</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the names of region servers on the live list</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMasterCoprocessorNames()" class="member-name-link">getMasterCoprocessorNames</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMasterInfoPort()" class="member-name-link">getMasterInfoPort</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMasterName()" class="member-name-link">getMasterName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns detailed information about the current master <a href="ServerName.html" title="class in org.apache.hadoop.hbase"><code>ServerName</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ServerTask.html" title="interface in org.apache.hadoop.hbase">ServerTask</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMasterTasks()" class="member-name-link">getMasterTasks</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Provide the list of master tasks</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRegionCount()" class="member-name-link">getRegionCount</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns the number of regions deployed on the cluster</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="master/RegionState.html" title="class in org.apache.hadoop.hbase.master">RegionState</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRegionStatesInTransition()" class="member-name-link">getRegionStatesInTransition</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRequestCount()" class="member-name-link">getRequestCount</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns the number of requests since last report</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getServersName()" class="member-name-link">getServersName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>,<wbr><a href="client/RegionStatesCount.html" title="class in org.apache.hadoop.hbase.client">RegionStatesCount</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTableRegionStatesCount()" class="member-name-link">getTableRegionStatesCount</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Provide region states count for given table.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getUnknownServerNames()" class="member-name-link">getUnknownServerNames</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the names of region servers on the unknown list</div> |
| </div> |
| </div> |
| </div> |
| </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="getHBaseVersion()"> |
| <h3>getHBaseVersion</h3> |
| <div class="member-signature"><span class="annotations">@Nullable |
| </span><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-73">getHBaseVersion</a></span>()</div> |
| <div class="block">Returns the HBase version string as reported by the HMaster</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDeadServerNames()"> |
| <h3>getDeadServerNames</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-77">getDeadServerNames</a></span>()</div> |
| <div class="block">Returns the names of region servers on the dead list</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnknownServerNames()"> |
| <h3>getUnknownServerNames</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-80">getUnknownServerNames</a></span>()</div> |
| <div class="block">Returns the names of region servers on the unknown list</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDecommissionedServerNames()"> |
| <h3>getDecommissionedServerNames</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-83">getDecommissionedServerNames</a></span>()</div> |
| <div class="block">Returns the names of region servers on the decommissioned list</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLiveServerMetrics()"> |
| <h3>getLiveServerMetrics</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>,<wbr><a href="ServerMetrics.html" title="interface in org.apache.hadoop.hbase">ServerMetrics</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-86">getLiveServerMetrics</a></span>()</div> |
| <div class="block">Returns the names of region servers on the live list</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionCount()"> |
| <h3>getRegionCount</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-89">getRegionCount</a></span>()</div> |
| <div class="block">Returns the number of regions deployed on the cluster</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequestCount()"> |
| <h3>getRequestCount</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-95">getRequestCount</a></span>()</div> |
| <div class="block">Returns the number of requests since last report</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMasterName()"> |
| <h3>getMasterName</h3> |
| <div class="member-signature"><span class="annotations">@Nullable |
| </span><span class="return-type"><a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-105">getMasterName</a></span>()</div> |
| <div class="block">Returns detailed information about the current master <a href="ServerName.html" title="class in org.apache.hadoop.hbase"><code>ServerName</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>current master information if it exists</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBackupMasterNames()"> |
| <h3>getBackupMasterNames</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-109">getBackupMasterNames</a></span>()</div> |
| <div class="block">Returns the names of backup masters</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionStatesInTransition()"> |
| <h3>getRegionStatesInTransition</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="master/RegionState.html" title="class in org.apache.hadoop.hbase.master">RegionState</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-111">getRegionStatesInTransition</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getClusterId()"> |
| <h3>getClusterId</h3> |
| <div class="member-signature"><span class="annotations">@Nullable |
| </span><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-114">getClusterId</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMasterCoprocessorNames()"> |
| <h3>getMasterCoprocessorNames</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-117">getMasterCoprocessorNames</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLastMajorCompactionTimestamp(org.apache.hadoop.hbase.TableName)"> |
| <h3>getLastMajorCompactionTimestamp</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-119">getLastMajorCompactionTimestamp</a></span><wbr><span class="parameters">(<a href="TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> table)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLastMajorCompactionTimestamp(byte[])"> |
| <h3>getLastMajorCompactionTimestamp</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-126">getLastMajorCompactionTimestamp</a></span><wbr><span class="parameters">(byte[] regionName)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBalancerOn()"> |
| <h3>getBalancerOn</h3> |
| <div class="member-signature"><span class="annotations">@Nullable |
| </span><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-132">getBalancerOn</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMasterInfoPort()"> |
| <h3>getMasterInfoPort</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-135">getMasterInfoPort</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServersName()"> |
| <h3>getServersName</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-137">getServersName</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAverageLoad()"> |
| <h3>getAverageLoad</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-140">getAverageLoad</a></span>()</div> |
| <div class="block">Returns the average cluster load</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableRegionStatesCount()"> |
| <h3>getTableRegionStatesCount</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>,<wbr><a href="client/RegionStatesCount.html" title="class in org.apache.hadoop.hbase.client">RegionStatesCount</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-153">getTableRegionStatesCount</a></span>()</div> |
| <div class="block">Provide region states count for given table. e.g howmany regions of give table are |
| opened/closed/rit etc</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>map of table to region states count</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMasterTasks()"> |
| <h3>getMasterTasks</h3> |
| <div class="member-signature"><span class="annotations">@Nullable |
| </span><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ServerTask.html" title="interface in org.apache.hadoop.hbase">ServerTask</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line-158">getMasterTasks</a></span>()</div> |
| <div class="block">Provide the list of master tasks</div> |
| </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> |
