http://git-wip-us.apache.org/repos/asf/hbase-site/blob/e57d1b63/apidocs/org/apache/hadoop/hbase/ScheduledChore.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/ScheduledChore.html b/apidocs/org/apache/hadoop/hbase/ScheduledChore.html deleted file mode 100644 index c54efc1..0000000 --- a/apidocs/org/apache/hadoop/hbase/ScheduledChore.html +++ /dev/null @@ -1,581 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>ScheduledChore (Apache HBase 2.0.0-SNAPSHOT API)</title> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ScheduledChore (Apache HBase 2.0.0-SNAPSHOT API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/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/RetryImmediatelyException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">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/8/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/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></dd> -</dl> -<hr> -<br> -<pre>@InterfaceAudience.Public -public abstract class <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.44">ScheduledChore</a> -extends <a href="http://docs.oracle.com/javase/8/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/8/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/8/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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore--">ScheduledChore</a></span>()</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><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore-java.lang.String-org.apache.hadoop.hbase.Stoppable-int-">ScheduledChore</a></span>(<a href="http://docs.oracle.com/javase/8/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><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore-java.lang.String-org.apache.hadoop.hbase.Stoppable-int-long-">ScheduledChore</a></span>(<a href="http://docs.oracle.com/javase/8/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><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#ScheduledChore-java.lang.String-org.apache.hadoop.hbase.Stoppable-int-long-java.util.concurrent.TimeUnit-">ScheduledChore</a></span>(<a href="http://docs.oracle.com/javase/8/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/8/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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#cancel--">cancel</a></span>()</code> </td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#cancel-boolean-">cancel</a></span>(boolean mayInterruptIfRunning)</code> </td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>protected abstract void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#chore--">chore</a></span>()</code> -<div class="block">The task to execute on each scheduled execution of the Chore</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#cleanup--">cleanup</a></span>()</code> -<div class="block">Override to run cleanup tasks when the Chore encounters an error and must stop running</div> -</td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getInitialDelay--">getInitialDelay</a></span>()</code> </td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getName--">getName</a></span>()</code> </td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getPeriod--">getPeriod</a></span>()</code> </td> -</tr> -<tr id="i7" class="rowColor"> -<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><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getStopper--">getStopper</a></span>()</code> </td> -</tr> -<tr id="i8" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/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><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#getTimeUnit--">getTimeUnit</a></span>()</code> </td> -</tr> -<tr id="i9" class="rowColor"> -<td class="colFirst"><code>protected boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#initialChore--">initialChore</a></span>()</code> -<div class="block">Override to run a task before we start looping.</div> -</td> -</tr> -<tr id="i10" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#isInitialChoreComplete--">isInitialChoreComplete</a></span>()</code> </td> -</tr> -<tr id="i11" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#isScheduled--">isScheduled</a></span>()</code> </td> -</tr> -<tr id="i12" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#run--">run</a></span>()</code> </td> -</tr> -<tr id="i13" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html#triggerNow--">triggerNow</a></span>()</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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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>@InterfaceAudience.Private -protected <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.121">ScheduledChore</a>()</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 <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.134">ScheduledChore</a>(<a href="http://docs.oracle.com/javase/8/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="paramLabel">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 <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.146">ScheduledChore</a>(<a href="http://docs.oracle.com/javase/8/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="paramLabel">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 <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.160">ScheduledChore</a>(<a href="http://docs.oracle.com/javase/8/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/8/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="paramLabel">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 <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.173">run</a>()</pre> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true#run--" title="class or interface in java.lang"><code>Runnable.run()</code></a></dd> -</dl> -</li> -</ul> -<a name="triggerNow--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>triggerNow</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.252">triggerNow</a>()</pre> -<dl> -<dt><span class="returnLabel">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 <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.270">cancel</a>()</pre> -</li> -</ul> -<a name="cancel-boolean-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>cancel</h4> -<pre>public void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.274">cancel</a>(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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.280">getName</a>()</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> <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.284">getStopper</a>()</pre> -</li> -</ul> -<a name="getPeriod--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getPeriod</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.291">getPeriod</a>()</pre> -<dl> -<dt><span class="returnLabel">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 <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.298">getInitialDelay</a>()</pre> -<dl> -<dt><span class="returnLabel">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/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.302">getTimeUnit</a>()</pre> -</li> -</ul> -<a name="isInitialChoreComplete--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isInitialChoreComplete</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.306">isInitialChoreComplete</a>()</pre> -</li> -</ul> -<a name="isScheduled--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isScheduled</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.328">isScheduled</a>()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true when this Chore is scheduled with a ChoreService</dd> -</dl> -</li> -</ul> -<a name="chore--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>chore</h4> -<pre>protected abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.341">chore</a>()</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 <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.347">initialChore</a>()</pre> -<div class="block">Override to run a task before we start looping.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if initial chore was successful</dd> -</dl> -</li> -</ul> -<a name="cleanup--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>cleanup</h4> -<pre>protected void <a href="../../../../src-html/org/apache/hadoop/hbase/ScheduledChore.html#line.355">cleanup</a>()</pre> -<div class="block">Override to run cleanup tasks when the Chore encounters an error and must stop running</div> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/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/RetryImmediatelyException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">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–2017 <a href="https://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/e57d1b63/apidocs/org/apache/hadoop/hbase/ServerLoad.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/ServerLoad.html b/apidocs/org/apache/hadoop/hbase/ServerLoad.html deleted file mode 100644 index e286565..0000000 --- a/apidocs/org/apache/hadoop/hbase/ServerLoad.html +++ /dev/null @@ -1,786 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>ServerLoad (Apache HBase 2.0.0-SNAPSHOT API)</title> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="ServerLoad (Apache HBase 2.0.0-SNAPSHOT API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/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/ScheduledChore.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">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/8/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 -public class <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.42">ServerLoad</a> -extends <a href="http://docs.oracle.com/javase/8/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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#EMPTY_SERVERLOAD">EMPTY_SERVERLOAD</a></span></code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>protected org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.ServerLoad</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#serverLoad">serverLoad</a></span></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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#ServerLoad-org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.ServerLoad-">ServerLoad</a></span>(org.apache.hadoop.hbase.shaded.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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getCurrentCompactedKVs--">getCurrentCompactedKVs</a></span>()</code> </td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getFilteredReadRequestsCount--">getFilteredReadRequestsCount</a></span>()</code> </td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getInfoServerPort--">getInfoServerPort</a></span>()</code> </td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getLoad--">getLoad</a></span>()</code> -<div class="block">Originally, this method factored in the effect of requests going to the - server as well.</div> -</td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getMaxHeapMB--">getMaxHeapMB</a></span>()</code> </td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getMemstoreSizeInMB--">getMemstoreSizeInMB</a></span>()</code> </td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getNumberOfRegions--">getNumberOfRegions</a></span>()</code> </td> -</tr> -<tr id="i7" class="rowColor"> -<td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getNumberOfRequests--">getNumberOfRequests</a></span>()</code> </td> -</tr> -<tr id="i8" class="altColor"> -<td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getReadRequestsCount--">getReadRequestsCount</a></span>()</code> </td> -</tr> -<tr id="i9" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getRegionServerCoprocessors--">getRegionServerCoprocessors</a></span>()</code> -<div class="block">Return the RegionServer-level coprocessors</div> -</td> -</tr> -<tr id="i10" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/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><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getRegionsLoad--">getRegionsLoad</a></span>()</code> </td> -</tr> -<tr id="i11" class="rowColor"> -<td class="colFirst"><code>org.apache.hadoop.hbase.replication.ReplicationLoadSink</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getReplicationLoadSink--">getReplicationLoadSink</a></span>()</code> -<div class="block">Call directly from client such as hbase shell</div> -</td> -</tr> -<tr id="i12" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/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><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getReplicationLoadSourceList--">getReplicationLoadSourceList</a></span>()</code> -<div class="block">Call directly from client such as hbase shell</div> -</td> -</tr> -<tr id="i13" class="rowColor"> -<td class="colFirst"><code>double</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getRequestsPerSecond--">getRequestsPerSecond</a></span>()</code> </td> -</tr> -<tr id="i14" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getRootIndexSizeKB--">getRootIndexSizeKB</a></span>()</code> </td> -</tr> -<tr id="i15" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getRsCoprocessors--">getRsCoprocessors</a></span>()</code> -<div class="block">Return the RegionServer-level and Region-level coprocessors</div> -</td> -</tr> -<tr id="i16" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getStorefileIndexSizeInMB--">getStorefileIndexSizeInMB</a></span>()</code> </td> -</tr> -<tr id="i17" class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getStorefiles--">getStorefiles</a></span>()</code> </td> -</tr> -<tr id="i18" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getStorefileSizeInMB--">getStorefileSizeInMB</a></span>()</code> </td> -</tr> -<tr id="i19" class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getStores--">getStores</a></span>()</code> </td> -</tr> -<tr id="i20" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getStoreUncompressedSizeMB--">getStoreUncompressedSizeMB</a></span>()</code> </td> -</tr> -<tr id="i21" class="rowColor"> -<td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getTotalCompactingKVs--">getTotalCompactingKVs</a></span>()</code> </td> -</tr> -<tr id="i22" class="altColor"> -<td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getTotalNumberOfRequests--">getTotalNumberOfRequests</a></span>()</code> </td> -</tr> -<tr id="i23" class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getTotalStaticBloomSizeKB--">getTotalStaticBloomSizeKB</a></span>()</code> </td> -</tr> -<tr id="i24" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getTotalStaticIndexSizeKB--">getTotalStaticIndexSizeKB</a></span>()</code> </td> -</tr> -<tr id="i25" class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getUsedHeapMB--">getUsedHeapMB</a></span>()</code> </td> -</tr> -<tr id="i26" class="altColor"> -<td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#getWriteRequestsCount--">getWriteRequestsCount</a></span>()</code> </td> -</tr> -<tr id="i27" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#hasMaxHeapMB--">hasMaxHeapMB</a></span>()</code> </td> -</tr> -<tr id="i28" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#hasNumberOfRequests--">hasNumberOfRequests</a></span>()</code> </td> -</tr> -<tr id="i29" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#hasTotalNumberOfRequests--">hasTotalNumberOfRequests</a></span>()</code> </td> -</tr> -<tr id="i30" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#hasUsedHeapMB--">hasUsedHeapMB</a></span>()</code> </td> -</tr> -<tr id="i31" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ServerLoad.html#toString--">toString</a></span>()</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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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.shaded.protobuf.generated.ClusterStatusProtos.ServerLoad <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.88">serverLoad</a></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> <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.332">EMPTY_SERVERLOAD</a></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.shaded.protobuf.generated.ClusterStatusProtos.ServerLoad-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>ServerLoad</h4> -<pre>@InterfaceAudience.Private -public <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.59">ServerLoad</a>(org.apache.hadoop.hbase.shaded.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="getNumberOfRequests--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getNumberOfRequests</h4> -<pre>public long <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.91">getNumberOfRequests</a>()</pre> -</li> -</ul> -<a name="hasNumberOfRequests--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>hasNumberOfRequests</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.94">hasNumberOfRequests</a>()</pre> -</li> -</ul> -<a name="getTotalNumberOfRequests--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getTotalNumberOfRequests</h4> -<pre>public long <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.99">getTotalNumberOfRequests</a>()</pre> -</li> -</ul> -<a name="hasTotalNumberOfRequests--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>hasTotalNumberOfRequests</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.102">hasTotalNumberOfRequests</a>()</pre> -</li> -</ul> -<a name="getUsedHeapMB--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getUsedHeapMB</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.107">getUsedHeapMB</a>()</pre> -</li> -</ul> -<a name="hasUsedHeapMB--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>hasUsedHeapMB</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.110">hasUsedHeapMB</a>()</pre> -</li> -</ul> -<a name="getMaxHeapMB--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMaxHeapMB</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.115">getMaxHeapMB</a>()</pre> -</li> -</ul> -<a name="hasMaxHeapMB--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>hasMaxHeapMB</h4> -<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.118">hasMaxHeapMB</a>()</pre> -</li> -</ul> -<a name="getStores--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getStores</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.122">getStores</a>()</pre> -</li> -</ul> -<a name="getStorefiles--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getStorefiles</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.126">getStorefiles</a>()</pre> -</li> -</ul> -<a name="getStoreUncompressedSizeMB--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getStoreUncompressedSizeMB</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.130">getStoreUncompressedSizeMB</a>()</pre> -</li> -</ul> -<a name="getStorefileSizeInMB--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getStorefileSizeInMB</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.134">getStorefileSizeInMB</a>()</pre> -</li> -</ul> -<a name="getMemstoreSizeInMB--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMemstoreSizeInMB</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.138">getMemstoreSizeInMB</a>()</pre> -</li> -</ul> -<a name="getStorefileIndexSizeInMB--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getStorefileIndexSizeInMB</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.142">getStorefileIndexSizeInMB</a>()</pre> -</li> -</ul> -<a name="getReadRequestsCount--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getReadRequestsCount</h4> -<pre>public long <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.146">getReadRequestsCount</a>()</pre> -</li> -</ul> -<a name="getFilteredReadRequestsCount--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getFilteredReadRequestsCount</h4> -<pre>public long <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.150">getFilteredReadRequestsCount</a>()</pre> -</li> -</ul> -<a name="getWriteRequestsCount--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getWriteRequestsCount</h4> -<pre>public long <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.154">getWriteRequestsCount</a>()</pre> -</li> -</ul> -<a name="getRootIndexSizeKB--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getRootIndexSizeKB</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.158">getRootIndexSizeKB</a>()</pre> -</li> -</ul> -<a name="getTotalStaticIndexSizeKB--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getTotalStaticIndexSizeKB</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.162">getTotalStaticIndexSizeKB</a>()</pre> -</li> -</ul> -<a name="getTotalStaticBloomSizeKB--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getTotalStaticBloomSizeKB</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.166">getTotalStaticBloomSizeKB</a>()</pre> -</li> -</ul> -<a name="getTotalCompactingKVs--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getTotalCompactingKVs</h4> -<pre>public long <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.170">getTotalCompactingKVs</a>()</pre> -</li> -</ul> -<a name="getCurrentCompactedKVs--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getCurrentCompactedKVs</h4> -<pre>public long <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.174">getCurrentCompactedKVs</a>()</pre> -</li> -</ul> -<a name="getNumberOfRegions--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getNumberOfRegions</h4> -<pre>public int <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.181">getNumberOfRegions</a>()</pre> -<dl> -<dt><span class="returnLabel">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 <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.185">getInfoServerPort</a>()</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/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.hbase.replication.ReplicationLoadSource> <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.193">getReplicationLoadSourceList</a>()</pre> -<div class="block">Call directly from client such as hbase shell</div> -<dl> -<dt><span class="returnLabel">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 <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.201">getReplicationLoadSink</a>()</pre> -<div class="block">Call directly from client such as hbase shell</div> -<dl> -<dt><span class="returnLabel">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 <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.218">getLoad</a>()</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="returnLabel">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/8/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>> <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.229">getRegionsLoad</a>()</pre> -<dl> -<dt><span class="returnLabel">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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.243">getRegionServerCoprocessors</a>()</pre> -<div class="block">Return the RegionServer-level coprocessors</div> -<dl> -<dt><span class="returnLabel">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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.259">getRsCoprocessors</a>()</pre> -<div class="block">Return the RegionServer-level and Region-level coprocessors</div> -<dl> -<dt><span class="returnLabel">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 <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.272">getRequestsPerSecond</a>()</pre> -<dl> -<dt><span class="returnLabel">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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ServerLoad.html#line.280">toString</a>()</pre> -<dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/8/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/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="http://docs.oracle.com/javase/8/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> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/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/ScheduledChore.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">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–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> -</body> -</html>
