http://git-wip-us.apache.org/repos/asf/hbase-site/blob/97d559f1/2.0/apidocs/org/apache/hadoop/hbase/ChoreService.html ---------------------------------------------------------------------- diff --git a/2.0/apidocs/org/apache/hadoop/hbase/ChoreService.html b/2.0/apidocs/org/apache/hadoop/hbase/ChoreService.html new file mode 100644 index 0000000..d929bf5 --- /dev/null +++ b/2.0/apidocs/org/apache/hadoop/hbase/ChoreService.html @@ -0,0 +1,550 @@ +<!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>ChoreService (Apache HBase 2.0.0-beta-2 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="ChoreService (Apache HBase 2.0.0-beta-2 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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/ChoreService.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/CellUtil.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ClockOutOfSyncException.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/ChoreService.html" target="_top">Frames</a></li> +<li><a href="ChoreService.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 ChoreService" class="title">Class ChoreService</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://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.ChoreService</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/ChoreService.html#line.57">ChoreService</a> +extends <a href="https://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">ChoreService is a service that can be used to schedule instances of <a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase"><code>ScheduledChore</code></a> to run + periodically while sharing threads. The ChoreService is backed by a + <a href="https://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> whose core pool size changes dynamically depending on the + number of <a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase"><code>ScheduledChore</code></a> scheduled. All of the threads in the core thread pool of the + underlying <a href="https://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> are set to be daemon threads. + <p> + The ChoreService provides the ability to schedule, cancel, and trigger instances of + <a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase"><code>ScheduledChore</code></a>. The ChoreService also provides the ability to check on the status of + scheduled chores. The number of threads used by the ChoreService changes based on the scheduling + load and whether or not the scheduled chores are executing on time. As more chores are scheduled, + there may be a need to increase the number of threads if it is noticed that chores are no longer + meeting their scheduled start times. On the other hand, as chores are cancelled, an attempt is + made to reduce the number of running threads to see if chores can still meet their start times + with a smaller thread pool. + <p> + When finished with a ChoreService it is good practice to call <a href="../../../../org/apache/hadoop/hbase/ChoreService.html#shutdown--"><code>shutdown()</code></a>. + Calling this method ensures that all scheduled chores are cancelled and cleaned up properly.</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 int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ChoreService.html#MIN_CORE_POOL_SIZE">MIN_CORE_POOL_SIZE</a></span></code> +<div class="block">The minimum number of threads in the core pool of the underlying ScheduledThreadPoolExecutor</div> +</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/ChoreService.html#ChoreService-java.lang.String-">ChoreService</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> coreThreadPoolPrefix)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ChoreService.html#ChoreService-java.lang.String-boolean-">ChoreService</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> coreThreadPoolPrefix, + boolean jitter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ChoreService.html#ChoreService-java.lang.String-int-boolean-">ChoreService</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> coreThreadPoolPrefix, + int corePoolSize, + boolean jitter)</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ChoreService.html#cancelChore-org.apache.hadoop.hbase.ScheduledChore-">cancelChore</a></span>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> chore)</code> +<div class="block">Cancel any ongoing schedules that this chore has with the implementer of this interface.</div> +</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/ChoreService.html#cancelChore-org.apache.hadoop.hbase.ScheduledChore-boolean-">cancelChore</a></span>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> chore, + boolean mayInterruptIfRunning)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ChoreService.html#isChoreScheduled-org.apache.hadoop.hbase.ScheduledChore-">isChoreScheduled</a></span>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> chore)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ChoreService.html#isShutdown--">isShutdown</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ChoreService.html#isTerminated--">isTerminated</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ChoreService.html#onChoreMissedStartTime-org.apache.hadoop.hbase.ScheduledChore-">onChoreMissedStartTime</a></span>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> chore)</code> +<div class="block">A callback that tells the implementer of this interface that one of the scheduled chores is + missing its start time.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ChoreService.html#scheduleChore-org.apache.hadoop.hbase.ScheduledChore-">scheduleChore</a></span>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> chore)</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ChoreService.html#shutdown--">shutdown</a></span>()</code> +<div class="block">shutdown the service.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ChoreService.html#triggerNow-org.apache.hadoop.hbase.ScheduledChore-">triggerNow</a></span>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> chore)</code> +<div class="block">This method tries to execute the chore immediately.</div> +</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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="https://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="https://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="https://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="MIN_CORE_POOL_SIZE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MIN_CORE_POOL_SIZE</h4> +<pre>@InterfaceAudience.Private +public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.64">MIN_CORE_POOL_SIZE</a></pre> +<div class="block">The minimum number of threads in the core pool of the underlying ScheduledThreadPoolExecutor</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.ChoreService.MIN_CORE_POOL_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ChoreService-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ChoreService</h4> +<pre>@InterfaceAudience.Private +public <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.99">ChoreService</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> coreThreadPoolPrefix)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>coreThreadPoolPrefix</code> - Prefix that will be applied to the Thread name of all threads + spawned by this service</dd> +</dl> +</li> +</ul> +<a name="ChoreService-java.lang.String-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ChoreService</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.109">ChoreService</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> coreThreadPoolPrefix, + boolean jitter)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>coreThreadPoolPrefix</code> - Prefix that will be applied to the Thread name of all threads + spawned by this service</dd> +<dd><code>jitter</code> - Should chore service add some jitter for all of the scheduled chores. When set + to true this will add -10% to 10% jitter.</dd> +</dl> +</li> +</ul> +<a name="ChoreService-java.lang.String-int-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ChoreService</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.122">ChoreService</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> coreThreadPoolPrefix, + int corePoolSize, + boolean jitter)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>coreThreadPoolPrefix</code> - Prefix that will be applied to the Thread name of all threads + spawned by this service</dd> +<dd><code>corePoolSize</code> - The initial size to set the core pool of the ScheduledThreadPoolExecutor + to during initialization. The default size is 1, but specifying a larger size may be + beneficial if you know that 1 thread will not be enough.</dd> +<dd><code>jitter</code> - Should chore service add some jitter for all of the scheduled chores. When set + to true this will add -10% to 10% jitter.</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="scheduleChore-org.apache.hadoop.hbase.ScheduledChore-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scheduleChore</h4> +<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.147">scheduleChore</a>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> chore)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>chore</code> - Chore to be scheduled. If the chore is already scheduled with another ChoreService + instance, that schedule will be cancelled (i.e. a Chore can only ever be scheduled + with a single ChoreService instance).</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true when the chore was successfully scheduled. false when the scheduling failed + (typically occurs when a chore is scheduled during shutdown of service)</dd> +</dl> +</li> +</ul> +<a name="cancelChore-org.apache.hadoop.hbase.ScheduledChore-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cancelChore</h4> +<pre>@InterfaceAudience.Private +public void <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.183">cancelChore</a>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> chore)</pre> +<div class="block">Cancel any ongoing schedules that this chore has with the implementer of this interface.</div> +</li> +</ul> +<a name="cancelChore-org.apache.hadoop.hbase.ScheduledChore-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cancelChore</h4> +<pre>@InterfaceAudience.Private +public void <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.189">cancelChore</a>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> chore, + boolean mayInterruptIfRunning)</pre> +</li> +</ul> +<a name="isChoreScheduled-org.apache.hadoop.hbase.ScheduledChore-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isChoreScheduled</h4> +<pre>@InterfaceAudience.Private +public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.206">isChoreScheduled</a>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> chore)</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true when the chore is scheduled with the implementer of this interface</dd> +</dl> +</li> +</ul> +<a name="triggerNow-org.apache.hadoop.hbase.ScheduledChore-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>triggerNow</h4> +<pre>@InterfaceAudience.Private +public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.213">triggerNow</a>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> chore)</pre> +<div class="block">This method tries to execute the chore immediately. If the chore is executing at the time of + this call, the chore will begin another execution as soon as the current execution finishes + <p> + If the chore is not scheduled with a ChoreService, this call will fail.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>false when the chore could not be triggered immediately</dd> +</dl> +</li> +</ul> +<a name="onChoreMissedStartTime-org.apache.hadoop.hbase.ScheduledChore-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onChoreMissedStartTime</h4> +<pre>@InterfaceAudience.Private +public void <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.301">onChoreMissedStartTime</a>(<a href="../../../../org/apache/hadoop/hbase/ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a> chore)</pre> +<div class="block">A callback that tells the implementer of this interface that one of the scheduled chores is + missing its start time. The implication of a chore missing its start time is that the + service's current means of scheduling may not be sufficient to handle the number of ongoing + chores (the other explanation is that the chore's execution time is greater than its + scheduled period). The service should try to increase its concurrency when this callback is + received.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>chore</code> - The chore that missed its start time</dd> +</dl> +</li> +</ul> +<a name="shutdown--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shutdown</h4> +<pre>public void <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.324">shutdown</a>()</pre> +<div class="block">shutdown the service. Any chores that are scheduled for execution will be cancelled. Any chores + in the middle of execution will be interrupted and shutdown. This service will be unusable + after this method has been called (i.e. future scheduling attempts will fail).</div> +</li> +</ul> +<a name="isShutdown--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isShutdown</h4> +<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.338">isShutdown</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true when the service is shutdown and thus cannot be used anymore</dd> +</dl> +</li> +</ul> +<a name="isTerminated--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isTerminated</h4> +<pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/ChoreService.html#line.345">isTerminated</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true when the service is shutdown and all threads have terminated</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/ChoreService.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/CellUtil.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ClockOutOfSyncException.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/ChoreService.html" target="_top">Frames</a></li> +<li><a href="ChoreService.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–2018 <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/97d559f1/2.0/apidocs/org/apache/hadoop/hbase/ClockOutOfSyncException.html ---------------------------------------------------------------------- diff --git a/2.0/apidocs/org/apache/hadoop/hbase/ClockOutOfSyncException.html b/2.0/apidocs/org/apache/hadoop/hbase/ClockOutOfSyncException.html new file mode 100644 index 0000000..55b572d --- /dev/null +++ b/2.0/apidocs/org/apache/hadoop/hbase/ClockOutOfSyncException.html @@ -0,0 +1,271 @@ +<!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>ClockOutOfSyncException (Apache HBase 2.0.0-beta-2 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="ClockOutOfSyncException (Apache HBase 2.0.0-beta-2 API)"; + } + } + catch(err) { + } +//--> +</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/ClockOutOfSyncException.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/ChoreService.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ClusterId.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/ClockOutOfSyncException.html" target="_top">Frames</a></li> +<li><a href="ClockOutOfSyncException.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="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</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 ClockOutOfSyncException" class="title">Class ClockOutOfSyncException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">java.io.IOException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.ClockOutOfSyncException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.Public +public class <a href="../../../../src-html/org/apache/hadoop/hbase/ClockOutOfSyncException.html#line.31">ClockOutOfSyncException</a> +extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">This exception is thrown by the master when a region server clock skew is + too high.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#org.apache.hadoop.hbase.ClockOutOfSyncException">Serialized Form</a></dd> +</dl> +</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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClockOutOfSyncException.html#ClockOutOfSyncException-java.lang.String-">ClockOutOfSyncException</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> message)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-"; title="class or interface in java.lang">addSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--"; title="class or interface in java.lang">fillInStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--"; title="class or interface in java.lang">getCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--"; title="class or interface in java.lang">getLocalizedMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--"; title="class or interface in java.lang">getMessage</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--"; title="class or interface in java.lang">getStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--"; title="class or interface in java.lang">getSuppressed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-"; title="class or interface in java.lang">initCause</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--"; title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-"; title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-"; title="class or interface in java.lang">printStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/ api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a></code></li> +</ul> +<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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://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="https://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="https://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="ClockOutOfSyncException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ClockOutOfSyncException</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/ClockOutOfSyncException.html#line.32">ClockOutOfSyncException</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> message)</pre> +</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/ClockOutOfSyncException.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/ChoreService.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ClusterId.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/ClockOutOfSyncException.html" target="_top">Frames</a></li> +<li><a href="ClockOutOfSyncException.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="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007–2018 <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/97d559f1/2.0/apidocs/org/apache/hadoop/hbase/ClusterId.html ---------------------------------------------------------------------- diff --git a/2.0/apidocs/org/apache/hadoop/hbase/ClusterId.html b/2.0/apidocs/org/apache/hadoop/hbase/ClusterId.html new file mode 100644 index 0000000..ddc7599 --- /dev/null +++ b/2.0/apidocs/org/apache/hadoop/hbase/ClusterId.html @@ -0,0 +1,374 @@ +<!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>ClusterId (Apache HBase 2.0.0-beta-2 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="ClusterId (Apache HBase 2.0.0-beta-2 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":9,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/ClusterId.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/ClockOutOfSyncException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.html" title="interface 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/ClusterId.html" target="_top">Frames</a></li> +<li><a href="ClusterId.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 ClusterId" class="title">Class ClusterId</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://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.ClusterId</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@InterfaceAudience.Private +public class <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterId.html#line.36">ClusterId</a> +extends <a href="https://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">The identifier for this cluster. + It is serialized to the filesystem and up into zookeeper. This is a container for the id. + Also knows how to serialize and deserialize the cluster id.</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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterId.html#ClusterId--">ClusterId</a></span>()</code> +<div class="block">New ClusterID.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterId.html#ClusterId-java.lang.String-">ClusterId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> uuid)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterIdProtos.ClusterId</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterId.html#convert--">convert</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/ClusterId.html" title="class in org.apache.hadoop.hbase">ClusterId</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterId.html#convert-org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterIdProtos.ClusterId-">convert</a></span>(org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterIdProtos.ClusterId cid)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/ClusterId.html" title="class in org.apache.hadoop.hbase">ClusterId</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterId.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] bytes)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterId.html#toByteArray--">toByteArray</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="https://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/ClusterId.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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://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="https://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="https://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="ClusterId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ClusterId</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterId.html#line.42">ClusterId</a>()</pre> +<div class="block">New ClusterID. Generates a uniqueid.</div> +</li> +</ul> +<a name="ClusterId-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ClusterId</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterId.html#line.46">ClusterId</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> uuid)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="toByteArray--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toByteArray</h4> +<pre>public byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterId.html#line.53">toByteArray</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The clusterid serialized using pb w/ pb magic prefix</dd> +</dl> +</li> +</ul> +<a name="parseFrom-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parseFrom</h4> +<pre>public static <a href="../../../../org/apache/hadoop/hbase/ClusterId.html" title="class in org.apache.hadoop.hbase">ClusterId</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterId.html#line.63">parseFrom</a>(byte[] bytes) + throws <a href="../../../../org/apache/hadoop/hbase/exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>bytes</code> - A pb serialized <a href="../../../../org/apache/hadoop/hbase/ClusterId.html" title="class in org.apache.hadoop.hbase"><code>ClusterId</code></a> instance with pb magic prefix</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An instance of <a href="../../../../org/apache/hadoop/hbase/ClusterId.html" title="class in org.apache.hadoop.hbase"><code>ClusterId</code></a> made from <code>bytes</code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/hadoop/hbase/exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/hadoop/hbase/ClusterId.html#toByteArray--"><code>toByteArray()</code></a></dd> +</dl> +</li> +</ul> +<a name="convert--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre>public org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterIdProtos.ClusterId <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterId.html#line.84">convert</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A pb instance to represent this instance.</dd> +</dl> +</li> +</ul> +<a name="convert-org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterIdProtos.ClusterId-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre>public static <a href="../../../../org/apache/hadoop/hbase/ClusterId.html" title="class in org.apache.hadoop.hbase">ClusterId</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterId.html#line.93">convert</a>(org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterIdProtos.ClusterId cid)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cid</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A <a href="../../../../org/apache/hadoop/hbase/ClusterId.html" title="class in org.apache.hadoop.hbase"><code>ClusterId</code></a> made from the passed in <code>cid</code></dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="https://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/ClusterId.html#line.101">toString</a>()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="https://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="https://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="https://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/ClusterId.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/ClockOutOfSyncException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.html" title="interface 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/ClusterId.html" target="_top">Frames</a></li> +<li><a href="ClusterId.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–2018 <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/97d559f1/2.0/apidocs/org/apache/hadoop/hbase/ClusterMetrics.Option.html ---------------------------------------------------------------------- diff --git a/2.0/apidocs/org/apache/hadoop/hbase/ClusterMetrics.Option.html b/2.0/apidocs/org/apache/hadoop/hbase/ClusterMetrics.Option.html new file mode 100644 index 0000000..5d1a498 --- /dev/null +++ b/2.0/apidocs/org/apache/hadoop/hbase/ClusterMetrics.Option.html @@ -0,0 +1,473 @@ +<!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>ClusterMetrics.Option (Apache HBase 2.0.0-beta-2 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="ClusterMetrics.Option (Apache HBase 2.0.0-beta-2 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/ClusterMetrics.Option.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/ClusterMetrics.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ClusterMetricsBuilder.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/ClusterMetrics.Option.html" target="_top">Frames</a></li> +<li><a href="ClusterMetrics.Option.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="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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="Enum ClusterMetrics.Option" class="title">Enum ClusterMetrics.Option</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.ClusterMetrics.Option</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a>></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.html" title="interface in org.apache.hadoop.hbase">ClusterMetrics</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.html#line.156">ClusterMetrics.Option</a> +extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a>></pre> +<div class="block">Kinds of ClusterMetrics</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html#BACKUP_MASTERS">BACKUP_MASTERS</a></span></code> +<div class="block">metrics about backup masters name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html#BALANCER_ON">BALANCER_ON</a></span></code> +<div class="block">metrics about balancer is on or not</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html#CLUSTER_ID">CLUSTER_ID</a></span></code> +<div class="block">metrics about cluster id</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html#DEAD_SERVERS">DEAD_SERVERS</a></span></code> +<div class="block">metrics about dead region servers</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html#HBASE_VERSION">HBASE_VERSION</a></span></code> +<div class="block">metrics about hbase version</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html#LIVE_SERVERS">LIVE_SERVERS</a></span></code> +<div class="block">metrics about live region servers</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html#MASTER">MASTER</a></span></code> +<div class="block">metrics about master name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html#MASTER_COPROCESSORS">MASTER_COPROCESSORS</a></span></code> +<div class="block">metrics about master coprocessors</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html#MASTER_INFO_PORT">MASTER_INFO_PORT</a></span></code> +<div class="block">metrics info port</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html#REGIONS_IN_TRANSITION">REGIONS_IN_TRANSITION</a></span></code> +<div class="block">metrics about regions in transition</div> +</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-"; title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--"; title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/ 8/docs/api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--"; title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-"; title="class or interface in java.lang">valueOf</a></code></li> +</ul> +<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="https://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="https://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="https://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="https://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="https://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="https://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="https://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"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="HBASE_VERSION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HBASE_VERSION</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.Option.html#line.160">HBASE_VERSION</a></pre> +<div class="block">metrics about hbase version</div> +</li> +</ul> +<a name="CLUSTER_ID"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CLUSTER_ID</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.Option.html#line.164">CLUSTER_ID</a></pre> +<div class="block">metrics about cluster id</div> +</li> +</ul> +<a name="BALANCER_ON"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BALANCER_ON</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.Option.html#line.168">BALANCER_ON</a></pre> +<div class="block">metrics about balancer is on or not</div> +</li> +</ul> +<a name="LIVE_SERVERS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LIVE_SERVERS</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.Option.html#line.172">LIVE_SERVERS</a></pre> +<div class="block">metrics about live region servers</div> +</li> +</ul> +<a name="DEAD_SERVERS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEAD_SERVERS</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.Option.html#line.176">DEAD_SERVERS</a></pre> +<div class="block">metrics about dead region servers</div> +</li> +</ul> +<a name="MASTER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MASTER</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.Option.html#line.180">MASTER</a></pre> +<div class="block">metrics about master name</div> +</li> +</ul> +<a name="BACKUP_MASTERS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BACKUP_MASTERS</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.Option.html#line.184">BACKUP_MASTERS</a></pre> +<div class="block">metrics about backup masters name</div> +</li> +</ul> +<a name="MASTER_COPROCESSORS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MASTER_COPROCESSORS</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.Option.html#line.188">MASTER_COPROCESSORS</a></pre> +<div class="block">metrics about master coprocessors</div> +</li> +</ul> +<a name="REGIONS_IN_TRANSITION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>REGIONS_IN_TRANSITION</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.Option.html#line.192">REGIONS_IN_TRANSITION</a></pre> +<div class="block">metrics about regions in transition</div> +</li> +</ul> +<a name="MASTER_INFO_PORT"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MASTER_INFO_PORT</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.Option.html#line.196">MASTER_INFO_PORT</a></pre> +<div class="block">metrics info port</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a>[] <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.Option.html#line.26">values</a>()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (ClusterMetrics.Option c : ClusterMetrics.Option.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../org/apache/hadoop/hbase/ClusterMetrics.Option.html" title="enum in org.apache.hadoop.hbase">ClusterMetrics.Option</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ClusterMetrics.Option.html#line.26">valueOf</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true"; title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</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/ClusterMetrics.Option.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/ClusterMetrics.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/ClusterMetricsBuilder.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/ClusterMetrics.Option.html" target="_top">Frames</a></li> +<li><a href="ClusterMetrics.Option.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="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
