http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/ScheduledChore.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/ScheduledChore.html b/1.1/apidocs/org/apache/hadoop/hbase/ScheduledChore.html new file mode 100644 index 0000000..1e72108 --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/ScheduledChore.html @@ -0,0 +1,565 @@ +<!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 (version 1.7.0_80) on Mon Nov 07 22:02:44 PST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ScheduledChore (Apache HBase 1.1.8-SNAPSHOT API)</title> +<meta name="date" content="2016-11-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ScheduledChore (Apache HBase 1.1.8-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/ScheduledChore.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/RemoteExceptionHandler.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/Server.html" title="interface in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/ScheduledChore.html" target="_top">Frames</a></li> +<li><a href="ScheduledChore.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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</div> +<h2 title="Class ScheduledChore" class="title">Class ScheduledChore</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.ScheduledChore</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true"; title="class or interface in java.lang">Runnable</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/master/balancer/BalancerChore.html" title="class in org.apache.hadoop.hbase.master.balancer">BalancerChore</a>, <a href="../../../../org/apache/hadoop/hbase/master/CatalogJanitor.html" title="class in org.apache.hadoop.hbase.master">CatalogJanitor</a>, <a href="../../../../org/apache/hadoop/hbase/master/cleaner/CleanerChore.html" title="class in org.apache.hadoop.hbase.master.cleaner">CleanerChore</a>, <a href="../../../../org/apache/hadoop/hbase/master/balancer/ClusterStatusChore.html" title="class in org.apache.hadoop.hbase.master.balancer">ClusterStatusChore</a>, <a href="../../../../org/apache/hadoop/hbase/master/ClusterStatusPublisher.html" title="class in org.apache.hadoop.hbase.master">ClusterStatusPublisher</a>, <a href="../../../../org/apache/hadoop/hbase/HealthCheckChore.html" title="class in org.apache.hadoop.hbase">HealthCheckChore</a>, <a href="../../../../org/apache/hadoop/hbase/regionserver/HRegionServer.MovedRegionsCle aner.html" title="class in org.apache.hadoop.hbase.regionserver">HRegionServer.MovedRegionsCleaner</a>, <a href="../../../../org/apache/hadoop/hbase/master/cleaner/ReplicationZKLockCleanerChore.html" title="class in org.apache.hadoop.hbase.master.cleaner">ReplicationZKLockCleanerChore</a>, <a href="../../../../org/apache/hadoop/hbase/regionserver/StorefileRefresherChore.html" title="class in org.apache.hadoop.hbase.regionserver">StorefileRefresherChore</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.Private.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.Private</a> +public abstract class <span class="strong">ScheduledChore</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true"; title="class or interface in java.lang">Runnable</a></pre> +<div class="block">ScheduledChore is a task performed on a period in hbase. ScheduledChores become active once + scheduled with a <a href="../../../../org/apache/hadoop/hbase/ChoreService.html" title="class in org.apache.hadoop.hbase"><code>ChoreService</code></a> via <a href="../../../../org/apache/hadoop/hbase/ChoreService.html#scheduleChore(org.apache.hadoop.hbase.ScheduledChore)"><code>ChoreService.scheduleChore(ScheduledChore)</code></a>. The + chore is run in a <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ScheduledThreadPoolExecutor.html?is-external=true"; title="class or interface in java.util.concurrent"><code>ScheduledThreadPoolExecutor</code></a> and competes with other ScheduledChores for + access to the threads in the core thread pool. If an unhandled exception occurs, the chore + cancellation is logged. Implementers should consider whether or not the Chore will be able to + execute within the defined period. It is bad practice to define a ScheduledChore whose execution + time exceeds its period since it will try to hog one of the threads in the <a href="../../../../org/apache/hadoop/hbase/ChoreService.html" title="class in org.apache.hadoop.hbase"><code>ChoreService</code></a>'s + thread pool. + <p> + Don't subclass ScheduledChore if the task relies on being woken up for something to do, such as + an entry being added to a queue, etc.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore()">ScheduledChore</a></strong>()</code> +<div class="block">This constructor is for test only.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore(java.lang.String,%20org.apache.hadoop.hbase.Stoppable,%20int)">ScheduledChore</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper, + int period)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore(java.lang.String,%20org.apache.hadoop.hbase.Stoppable,%20int,%20long)">ScheduledChore</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper, + int period, + long initialDelay)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore(java.lang.String,%20org.apache.hadoop.hbase.Stoppable,%20int,%20long,%20java.util.concurrent.TimeUnit)">ScheduledChore</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper, + int period, + long initialDelay, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#cancel()">cancel</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#cancel(boolean)">cancel</a></strong>(boolean mayInterruptIfRunning)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#chore()">chore</a></strong>()</code> +<div class="block">The task to execute on each scheduled execution of the Chore</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#choreForTesting()">choreForTesting</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#cleanup()">cleanup</a></strong>()</code> +<div class="block">Override to run cleanup tasks when the Chore encounters an error and must stop running</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getInitialDelay()">getInitialDelay</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getName()">getName</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getPeriod()">getPeriod</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getStopper()">getStopper</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getTimeUnit()">getTimeUnit</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#initialChore()">initialChore</a></strong>()</code> +<div class="block">Override to run a task before we start looping.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#isInitialChoreComplete()">isInitialChoreComplete</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#isScheduled()">isScheduled</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#run()">run</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#triggerNow()">triggerNow</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ScheduledChore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ScheduledChore</h4> +<pre>protected ScheduledChore()</pre> +<div class="block">This constructor is for test only. It allows us to create an object and to call chore() on it.</div> +</li> +</ul> +<a name="ScheduledChore(java.lang.String, org.apache.hadoop.hbase.Stoppable, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ScheduledChore</h4> +<pre>public ScheduledChore(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper, + int period)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name assigned to Chore. Useful for identification amongst chores of the same type</dd><dd><code>stopper</code> - When <a href="../../../../org/apache/hadoop/hbase/Stoppable.html#isStopped()"><code>Stoppable.isStopped()</code></a> is true, this chore will cancel and cleanup</dd><dd><code>period</code> - Period in millis with which this Chore repeats execution when scheduled.</dd></dl> +</li> +</ul> +<a name="ScheduledChore(java.lang.String, org.apache.hadoop.hbase.Stoppable, int, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ScheduledChore</h4> +<pre>public ScheduledChore(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper, + int period, + long initialDelay)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name assigned to Chore. Useful for identification amongst chores of the same type</dd><dd><code>stopper</code> - When <a href="../../../../org/apache/hadoop/hbase/Stoppable.html#isStopped()"><code>Stoppable.isStopped()</code></a> is true, this chore will cancel and cleanup</dd><dd><code>period</code> - Period in millis with which this Chore repeats execution when scheduled.</dd><dd><code>initialDelay</code> - Delay before this Chore begins to execute once it has been scheduled. A + value of 0 means the chore will begin to execute immediately. Negative delays are + invalid and will be corrected to a value of 0.</dd></dl> +</li> +</ul> +<a name="ScheduledChore(java.lang.String, org.apache.hadoop.hbase.Stoppable, int, long, java.util.concurrent.TimeUnit)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ScheduledChore</h4> +<pre>public ScheduledChore(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper, + int period, + long initialDelay, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name assigned to Chore. Useful for identification amongst chores of the same type</dd><dd><code>stopper</code> - When <a href="../../../../org/apache/hadoop/hbase/Stoppable.html#isStopped()"><code>Stoppable.isStopped()</code></a> is true, this chore will cancel and cleanup</dd><dd><code>period</code> - Period in Timeunit unit with which this Chore repeats execution when scheduled.</dd><dd><code>initialDelay</code> - Delay in Timeunit unit before this Chore begins to execute once it has been + scheduled. A value of 0 means the chore will begin to execute immediately. Negative + delays are invalid and will be corrected to a value of 0.</dd><dd><code>unit</code> - The unit that is used to measure period and initialDelay</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="run()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>run</h4> +<pre>public void run()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true#run()" title="class or interface in java.lang">run</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true"; title="class or interface in java.lang">Runnable</a></code></dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Thread.html?is-external=true#run()" title="class or interface in java.lang"><code>Thread.run()</code></a></dd></dl> +</li> +</ul> +<a name="triggerNow()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>triggerNow</h4> +<pre>public boolean triggerNow()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>false when the Chore is not currently scheduled with a ChoreService</dd></dl> +</li> +</ul> +<a name="cancel()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cancel</h4> +<pre>public void cancel()</pre> +</li> +</ul> +<a name="cancel(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cancel</h4> +<pre>public void cancel(boolean mayInterruptIfRunning)</pre> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getName()</pre> +</li> +</ul> +<a name="getStopper()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStopper</h4> +<pre>public <a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a> getStopper()</pre> +</li> +</ul> +<a name="getPeriod()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPeriod</h4> +<pre>public int getPeriod()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>period to execute chore in getTimeUnit() units</dd></dl> +</li> +</ul> +<a name="getInitialDelay()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitialDelay</h4> +<pre>public long getInitialDelay()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>initial delay before executing chore in getTimeUnit() units</dd></dl> +</li> +</ul> +<a name="getTimeUnit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimeUnit</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> getTimeUnit()</pre> +</li> +</ul> +<a name="isInitialChoreComplete()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isInitialChoreComplete</h4> +<pre>public boolean isInitialChoreComplete()</pre> +</li> +</ul> +<a name="isScheduled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isScheduled</h4> +<pre>public boolean isScheduled()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true when this Chore is scheduled with a ChoreService</dd></dl> +</li> +</ul> +<a name="choreForTesting()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>choreForTesting</h4> +<pre>public void choreForTesting()</pre> +</li> +</ul> +<a name="chore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>chore</h4> +<pre>protected abstract void chore()</pre> +<div class="block">The task to execute on each scheduled execution of the Chore</div> +</li> +</ul> +<a name="initialChore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialChore</h4> +<pre>protected boolean initialChore()</pre> +<div class="block">Override to run a task before we start looping.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if initial chore was successful</dd></dl> +</li> +</ul> +<a name="cleanup()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cleanup</h4> +<pre>protected void cleanup()</pre> +<div class="block">Override to run cleanup tasks when the Chore encounters an error and must stop running</div> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/ScheduledChore.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/RemoteExceptionHandler.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/Server.html" title="interface in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/ScheduledChore.html" target="_top">Frames</a></li> +<li><a href="ScheduledChore.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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-2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/Server.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/Server.html b/1.1/apidocs/org/apache/hadoop/hbase/Server.html new file mode 100644 index 0000000..960336a --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/Server.html @@ -0,0 +1,341 @@ +<!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 (version 1.7.0_80) on Mon Nov 07 22:02:44 PST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Server (Apache HBase 1.1.8-SNAPSHOT API)</title> +<meta name="date" content="2016-11-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Server (Apache HBase 1.1.8-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/Server.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/ScheduledChore.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html" title="class in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/Server.html" target="_top">Frames</a></li> +<li><a href="Server.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</div> +<h2 title="Interface Server" class="title">Interface Server</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a>, <a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/master/MasterServices.html" title="interface in org.apache.hadoop.hbase.master">MasterServices</a>, <a href="../../../../org/apache/hadoop/hbase/regionserver/OnlineRegions.html" title="interface in org.apache.hadoop.hbase.regionserver">OnlineRegions</a>, <a href="../../../../org/apache/hadoop/hbase/regionserver/RegionServerServices.html" title="interface in org.apache.hadoop.hbase.regionserver">RegionServerServices</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/master/HMaster.html" title="class in org.apache.hadoop.hbase.master">HMaster</a>, <a href="../../../../org/apache/hadoop/hbase/master/HMasterCommandLine.LocalHMaster.html" title="class in org.apache.hadoop.hbase.master">HMasterCommandLine.LocalHMaster</a>, <a href="../../../../org/apache/hadoop/hbase/regionserver/HRegionServer.html" title="class in org.apache.hadoop.hbase.regionserver">HRegionServer</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.LimitedPrivate.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.LimitedPrivate</a>(<a href="../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.LimitedPrivate.html#value()">value</a>="Coprocesssor") +<a href="../../../../org/apache/hadoop/hbase/classification/InterfaceStability.Evolving.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceStability.Evolving</a> +public interface <span class="strong">Server</span> +extends <a href="../../../../org/apache/hadoop/hbase/Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a>, <a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a></pre> +<div class="block">Defines the set of shared functions implemented by HBase servers (Masters + and RegionServers).</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/ChoreService.html" title="class in org.apache.hadoop.hbase">ChoreService</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/Server.html#getChoreService()">getChoreService</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.apache.hadoop.conf.Configuration</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/Server.html#getConfiguration()">getConfiguration</a></strong>()</code> +<div class="block">Gets the configuration object for this server.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/Server.html#getConnection()">getConnection</a></strong>()</code> +<div class="block">Returns a reference to the servers' cluster connection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/CoordinatedStateManager.html" title="interface in org.apache.hadoop.hbase">CoordinatedStateManager</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/Server.html#getCoordinatedStateManager()">getCoordinatedStateManager</a></strong>()</code> +<div class="block">Get CoordinatedStateManager instance for this server.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html" title="class in org.apache.hadoop.hbase.zookeeper">MetaTableLocator</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/Server.html#getMetaTableLocator()">getMetaTableLocator</a></strong>()</code> +<div class="block">Returns instance of <a href="../../../../org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>MetaTableLocator</code></a> + running inside this server.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/Server.html#getServerName()">getServerName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/zookeeper/ZooKeeperWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZooKeeperWatcher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/Server.html#getZooKeeper()">getZooKeeper</a></strong>()</code> +<div class="block">Gets the ZooKeeper instance for this server.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.hbase.Abortable"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/Abortable.html#abort(java.lang.String,%20java.lang.Throwable)">abort</a>, <a href="../../../../org/apache/hadoop/hbase/Abortable.html#isAborted()">isAborted</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.hbase.Stoppable"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/Stoppable.html#isStopped()">isStopped</a>, <a href="../../../../org/apache/hadoop/hbase/Stoppable.html#stop(java.lang.String)">stop</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getConfiguration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfiguration</h4> +<pre>org.apache.hadoop.conf.Configuration getConfiguration()</pre> +<div class="block">Gets the configuration object for this server.</div> +</li> +</ul> +<a name="getZooKeeper()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getZooKeeper</h4> +<pre><a href="../../../../org/apache/hadoop/hbase/zookeeper/ZooKeeperWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZooKeeperWatcher</a> getZooKeeper()</pre> +<div class="block">Gets the ZooKeeper instance for this server.</div> +</li> +</ul> +<a name="getConnection()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnection</h4> +<pre><a href="../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> getConnection()</pre> +<div class="block">Returns a reference to the servers' cluster connection. + + Important note: this method returns a reference to Connection which is managed + by Server itself, so callers must NOT attempt to close connection obtained.</div> +</li> +</ul> +<a name="getMetaTableLocator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMetaTableLocator</h4> +<pre><a href="../../../../org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html" title="class in org.apache.hadoop.hbase.zookeeper">MetaTableLocator</a> getMetaTableLocator()</pre> +<div class="block">Returns instance of <a href="../../../../org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>MetaTableLocator</code></a> + running inside this server. This MetaServerLocator is started and stopped by server, clients + shouldn't manage it's lifecycle.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>instance of <a href="../../../../org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>MetaTableLocator</code></a> associated with this server.</dd></dl> +</li> +</ul> +<a name="getServerName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getServerName</h4> +<pre><a href="../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> getServerName()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>The unique server name for this server.</dd></dl> +</li> +</ul> +<a name="getCoordinatedStateManager()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoordinatedStateManager</h4> +<pre><a href="../../../../org/apache/hadoop/hbase/CoordinatedStateManager.html" title="interface in org.apache.hadoop.hbase">CoordinatedStateManager</a> getCoordinatedStateManager()</pre> +<div class="block">Get CoordinatedStateManager instance for this server.</div> +</li> +</ul> +<a name="getChoreService()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getChoreService</h4> +<pre><a href="../../../../org/apache/hadoop/hbase/ChoreService.html" title="class in org.apache.hadoop.hbase">ChoreService</a> getChoreService()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>The <a href="../../../../org/apache/hadoop/hbase/ChoreService.html" title="class in org.apache.hadoop.hbase"><code>ChoreService</code></a> instance for this server</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Server.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/ScheduledChore.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html" title="class in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/Server.html" target="_top">Frames</a></li> +<li><a href="Server.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-2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/ServerLoad.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/ServerLoad.html b/1.1/apidocs/org/apache/hadoop/hbase/ServerLoad.html new file mode 100644 index 0000000..f906003 --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/ServerLoad.html @@ -0,0 +1,744 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ServerLoad (Apache HBase 1.1.8-SNAPSHOT API)</title> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ServerLoad (Apache HBase 1.1.8-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/ServerLoad.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/RegionTooBusyException.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/ServerLoad.html" target="_top">Frames</a></li> +<li><a href="ServerLoad.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><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="subNavList"> +<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> +<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</div> +<h2 title="Class ServerLoad" class="title">Class ServerLoad</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.ServerLoad</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@InterfaceAudience.Public +@InterfaceStability.Evolving +public class <span class="strong">ServerLoad</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">This class is used for exporting current state of load on a RegionServer.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/ServerLoad.html" title="class in org.apache.hadoop.hbase">ServerLoad</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#EMPTY_SERVERLOAD">EMPTY_SERVERLOAD</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected org.apache.hadoop.hbase.protobuf.generated.ClusterStatusProtos.ServerLoad</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#serverLoad">serverLoad</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#ServerLoad(org.apache.hadoop.hbase.protobuf.generated.ClusterStatusProtos.ServerLoad)">ServerLoad</a></strong>(org.apache.hadoop.hbase.protobuf.generated.ClusterStatusProtos.ServerLoad serverLoad)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getCurrentCompactedKVs()">getCurrentCompactedKVs</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getInfoServerPort()">getInfoServerPort</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getLoad()">getLoad</a></strong>()</code> +<div class="block">Originally, this method factored in the effect of requests going to the + server as well.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getMaxHeapMB()">getMaxHeapMB</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getMemstoreSizeInMB()">getMemstoreSizeInMB</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getNumberOfRegions()">getNumberOfRegions</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getNumberOfRequests()">getNumberOfRequests</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getReadRequestsCount()">getReadRequestsCount</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getRegionServerCoprocessors()">getRegionServerCoprocessors</a></strong>()</code> +<div class="block">Return the RegionServer-level coprocessors</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><byte[],<a href="../../../../org/apache/hadoop/hbase/RegionLoad.html" title="class in org.apache.hadoop.hbase">RegionLoad</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getRegionsLoad()">getRegionsLoad</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.apache.hadoop.hbase.replication.ReplicationLoadSink</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getReplicationLoadSink()">getReplicationLoadSink</a></strong>()</code> +<div class="block">Call directly from client such as hbase shell</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.hadoop.hbase.replication.ReplicationLoadSource></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getReplicationLoadSourceList()">getReplicationLoadSourceList</a></strong>()</code> +<div class="block">Call directly from client such as hbase shell</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getRequestsPerSecond()">getRequestsPerSecond</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getRootIndexSizeKB()">getRootIndexSizeKB</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getRsCoprocessors()">getRsCoprocessors</a></strong>()</code> +<div class="block">Return the RegionServer-level and Region-level coprocessors</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getStorefileIndexSizeInMB()">getStorefileIndexSizeInMB</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getStorefiles()">getStorefiles</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getStorefileSizeInMB()">getStorefileSizeInMB</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getStores()">getStores</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getStoreUncompressedSizeMB()">getStoreUncompressedSizeMB</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getTotalCompactingKVs()">getTotalCompactingKVs</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getTotalNumberOfRequests()">getTotalNumberOfRequests</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getTotalStaticBloomSizeKB()">getTotalStaticBloomSizeKB</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getTotalStaticIndexSizeKB()">getTotalStaticIndexSizeKB</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getUsedHeapMB()">getUsedHeapMB</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getWriteRequestsCount()">getWriteRequestsCount</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#hasMaxHeapMB()">hasMaxHeapMB</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#hasNumberOfRequests()">hasNumberOfRequests</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#hasTotalNumberOfRequests()">hasTotalNumberOfRequests</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#hasUsedHeapMB()">hasUsedHeapMB</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.apache.hadoop.hbase.protobuf.generated.ClusterStatusProtos.ServerLoad</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#obtainServerLoadPB()">obtainServerLoadPB</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="serverLoad"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serverLoad</h4> +<pre>protected org.apache.hadoop.hbase.protobuf.generated.ClusterStatusProtos.ServerLoad serverLoad</pre> +</li> +</ul> +<a name="EMPTY_SERVERLOAD"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EMPTY_SERVERLOAD</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/ServerLoad.html" title="class in org.apache.hadoop.hbase">ServerLoad</a> EMPTY_SERVERLOAD</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ServerLoad(org.apache.hadoop.hbase.protobuf.generated.ClusterStatusProtos.ServerLoad)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ServerLoad</h4> +<pre>public ServerLoad(org.apache.hadoop.hbase.protobuf.generated.ClusterStatusProtos.ServerLoad serverLoad)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="obtainServerLoadPB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>obtainServerLoadPB</h4> +<pre>public org.apache.hadoop.hbase.protobuf.generated.ClusterStatusProtos.ServerLoad obtainServerLoadPB()</pre> +</li> +</ul> +<a name="getNumberOfRequests()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumberOfRequests</h4> +<pre>public long getNumberOfRequests()</pre> +</li> +</ul> +<a name="hasNumberOfRequests()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNumberOfRequests</h4> +<pre>public boolean hasNumberOfRequests()</pre> +</li> +</ul> +<a name="getTotalNumberOfRequests()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTotalNumberOfRequests</h4> +<pre>public long getTotalNumberOfRequests()</pre> +</li> +</ul> +<a name="hasTotalNumberOfRequests()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasTotalNumberOfRequests</h4> +<pre>public boolean hasTotalNumberOfRequests()</pre> +</li> +</ul> +<a name="getUsedHeapMB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUsedHeapMB</h4> +<pre>public int getUsedHeapMB()</pre> +</li> +</ul> +<a name="hasUsedHeapMB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasUsedHeapMB</h4> +<pre>public boolean hasUsedHeapMB()</pre> +</li> +</ul> +<a name="getMaxHeapMB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxHeapMB</h4> +<pre>public int getMaxHeapMB()</pre> +</li> +</ul> +<a name="hasMaxHeapMB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasMaxHeapMB</h4> +<pre>public boolean hasMaxHeapMB()</pre> +</li> +</ul> +<a name="getStores()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStores</h4> +<pre>public int getStores()</pre> +</li> +</ul> +<a name="getStorefiles()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorefiles</h4> +<pre>public int getStorefiles()</pre> +</li> +</ul> +<a name="getStoreUncompressedSizeMB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStoreUncompressedSizeMB</h4> +<pre>public int getStoreUncompressedSizeMB()</pre> +</li> +</ul> +<a name="getStorefileSizeInMB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorefileSizeInMB</h4> +<pre>public int getStorefileSizeInMB()</pre> +</li> +</ul> +<a name="getMemstoreSizeInMB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMemstoreSizeInMB</h4> +<pre>public int getMemstoreSizeInMB()</pre> +</li> +</ul> +<a name="getStorefileIndexSizeInMB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorefileIndexSizeInMB</h4> +<pre>public int getStorefileIndexSizeInMB()</pre> +</li> +</ul> +<a name="getReadRequestsCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadRequestsCount</h4> +<pre>public long getReadRequestsCount()</pre> +</li> +</ul> +<a name="getWriteRequestsCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWriteRequestsCount</h4> +<pre>public long getWriteRequestsCount()</pre> +</li> +</ul> +<a name="getRootIndexSizeKB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRootIndexSizeKB</h4> +<pre>public int getRootIndexSizeKB()</pre> +</li> +</ul> +<a name="getTotalStaticIndexSizeKB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTotalStaticIndexSizeKB</h4> +<pre>public int getTotalStaticIndexSizeKB()</pre> +</li> +</ul> +<a name="getTotalStaticBloomSizeKB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTotalStaticBloomSizeKB</h4> +<pre>public int getTotalStaticBloomSizeKB()</pre> +</li> +</ul> +<a name="getTotalCompactingKVs()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTotalCompactingKVs</h4> +<pre>public long getTotalCompactingKVs()</pre> +</li> +</ul> +<a name="getCurrentCompactedKVs()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentCompactedKVs</h4> +<pre>public long getCurrentCompactedKVs()</pre> +</li> +</ul> +<a name="getNumberOfRegions()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumberOfRegions</h4> +<pre>public int getNumberOfRegions()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the number of regions</dd></dl> +</li> +</ul> +<a name="getInfoServerPort()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInfoServerPort</h4> +<pre>public int getInfoServerPort()</pre> +</li> +</ul> +<a name="getReplicationLoadSourceList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicationLoadSourceList</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.hadoop.hbase.replication.ReplicationLoadSource> getReplicationLoadSourceList()</pre> +<div class="block">Call directly from client such as hbase shell</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the list of ReplicationLoadSource</dd></dl> +</li> +</ul> +<a name="getReplicationLoadSink()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicationLoadSink</h4> +<pre>public org.apache.hadoop.hbase.replication.ReplicationLoadSink getReplicationLoadSink()</pre> +<div class="block">Call directly from client such as hbase shell</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>ReplicationLoadSink</dd></dl> +</li> +</ul> +<a name="getLoad()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLoad</h4> +<pre>public int getLoad()</pre> +<div class="block">Originally, this method factored in the effect of requests going to the + server as well. However, this does not interact very well with the current + region rebalancing code, which only factors number of regions. For the + interim, until we can figure out how to make rebalancing use all the info + available, we're just going to make load purely the number of regions.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>load factor for this server</dd></dl> +</li> +</ul> +<a name="getRegionsLoad()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRegionsLoad</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><byte[],<a href="../../../../org/apache/hadoop/hbase/RegionLoad.html" title="class in org.apache.hadoop.hbase">RegionLoad</a>> getRegionsLoad()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>region load metrics</dd></dl> +</li> +</ul> +<a name="getRegionServerCoprocessors()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRegionServerCoprocessors</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] getRegionServerCoprocessors()</pre> +<div class="block">Return the RegionServer-level coprocessors</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>string array of loaded RegionServer-level coprocessors</dd></dl> +</li> +</ul> +<a name="getRsCoprocessors()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRsCoprocessors</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] getRsCoprocessors()</pre> +<div class="block">Return the RegionServer-level and Region-level coprocessors</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>string array of loaded RegionServer-level and + Region-level coprocessors</dd></dl> +</li> +</ul> +<a name="getRequestsPerSecond()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRequestsPerSecond</h4> +<pre>public double getRequestsPerSecond()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>number of requests per second received since the last report</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang"><code>Object.toString()</code></a></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/ServerLoad.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/RegionTooBusyException.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/ServerLoad.html" target="_top">Frames</a></li> +<li><a href="ServerLoad.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><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="subNavList"> +<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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007–2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
