You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by sb...@apache.org on 2016/10/25 21:52:23 UTC
[26/51] [abbrv] [partial] incubator-geode git commit: Adding javadocs
for the 1.0.0-incubating release
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/admin/GemFireHealthConfig.html
----------------------------------------------------------------------
diff --git a/releases/latest/javadoc/org/apache/geode/admin/GemFireHealthConfig.html b/releases/latest/javadoc/org/apache/geode/admin/GemFireHealthConfig.html
new file mode 100644
index 0000000..446188f
--- /dev/null
+++ b/releases/latest/javadoc/org/apache/geode/admin/GemFireHealthConfig.html
@@ -0,0 +1,360 @@
+<!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 (1.8.0_45) on Sat Oct 15 16:23:29 PDT 2016 -->
+<title>GemFireHealthConfig (Apache Geode (incubating) 1.0.0-incubating)</title>
+<meta name="date" content="2016-10-15">
+<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="GemFireHealthConfig (Apache Geode (incubating) 1.0.0-incubating)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":38,"i1":38,"i2":38};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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="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/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/geode/admin/GemFireMemberStatus.html" title="class in org.apache.geode.admin"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/geode/admin/GemFireHealthConfig.html" target="_top">Frames</a></li>
+<li><a href="GemFireHealthConfig.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>Constr | </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>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.geode.admin</div>
+<h2 title="Interface GemFireHealthConfig" class="title">Interface GemFireHealthConfig</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Superinterfaces:</dt>
+<dd><a href="../../../../org/apache/geode/admin/CacheHealthConfig.html" title="interface in org.apache.geode.admin">CacheHealthConfig</a>, <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html" title="interface in org.apache.geode.admin">MemberHealthConfig</a></dd>
+</dl>
+<hr>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">as of 7.0 use the <code><a href="../../../../org/apache/geode/management/package-summary.html">management</a></code> package instead</span></div>
+</div>
+<br>
+<pre>public interface <span class="typeNameLabel">GemFireHealthConfig</span>
+extends <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html" title="interface in org.apache.geode.admin">MemberHealthConfig</a>, <a href="../../../../org/apache/geode/admin/CacheHealthConfig.html" title="interface in org.apache.geode.admin">CacheHealthConfig</a></pre>
+<div class="block">Provides configuration information relating to all of the
+ components of a GemFire distributed system.</div>
+<dl>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>GemFire 3.5</dd>
+</dl>
+</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/geode/admin/GemFireHealthConfig.html#DEFAULT_HEALTH_EVALUATION_INTERVAL">DEFAULT_HEALTH_EVALUATION_INTERVAL</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">The default number of seconds between assessments of the health
+ of the GemFire components.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="fields.inherited.from.class.org.apache.geode.admin.MemberHealthConfig">
+<!-- -->
+</a>
+<h3>Fields inherited from interface org.apache.geode.admin.<a href="../../../../org/apache/geode/admin/MemberHealthConfig.html" title="interface in org.apache.geode.admin">MemberHealthConfig</a></h3>
+<code><a href="../../../../org/apache/geode/admin/MemberHealthConfig.html#DEFAULT_MAX_MESSAGE_QUEUE_SIZE">DEFAULT_MAX_MESSAGE_QUEUE_SIZE</a>, <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html#DEFAULT_MAX_REPLY_TIMEOUTS">DEFAULT_MAX_REPLY_TIMEOUTS</a>, <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html#DEFAULT_MAX_RETRANSMISSION_RATIO">DEFAULT_MAX_RETRANSMISSION_RATIO</a>, <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html#DEFAULT_MAX_VM_PROCESS_SIZE">DEFAULT_MAX_VM_PROCESS_SIZE</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="fields.inherited.from.class.org.apache.geode.admin.CacheHealthConfig">
+<!-- -->
+</a>
+<h3>Fields inherited from interface org.apache.geode.admin.<a href="../../../../org/apache/geode/admin/CacheHealthConfig.html" title="interface in org.apache.geode.admin">CacheHealthConfig</a></h3>
+<code><a href="../../../../org/apache/geode/admin/CacheHealthConfig.html#DEFAULT_MAX_EVENT_QUEUE_SIZE">DEFAULT_MAX_EVENT_QUEUE_SIZE</a>, <a href="../../../../org/apache/geode/admin/CacheHealthConfig.html#DEFAULT_MAX_LOAD_TIME">DEFAULT_MAX_LOAD_TIME</a>, <a href="../../../../org/apache/geode/admin/CacheHealthConfig.html#DEFAULT_MAX_NET_SEARCH_TIME">DEFAULT_MAX_NET_SEARCH_TIME</a>, <a href="../../../../org/apache/geode/admin/CacheHealthConfig.html#DEFAULT_MIN_HIT_RATIO">DEFAULT_MIN_HIT_RATIO</a></code></li>
+</ul>
+</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="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html#getHealthEvaluationInterval--">getHealthEvaluationInterval</a></span>()</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">Returns the number of seconds between assessments of the health of
+ the GemFire components.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html#getHostName--">getHostName</a></span>()</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">Returns the name of the host to which this configuration
+ applies.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/admin/GemFireHealthConfig.html#setHealthEvaluationInterval-int-">setHealthEvaluationInterval</a></span>(int interval)</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">Sets the number of seconds between assessments of the health of
+ the GemFire components.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.admin.MemberHealthConfig">
+<!-- -->
+</a>
+<h3>Methods inherited from interface org.apache.geode.admin.<a href="../../../../org/apache/geode/admin/MemberHealthConfig.html" title="interface in org.apache.geode.admin">MemberHealthConfig</a></h3>
+<code><a href="../../../../org/apache/geode/admin/MemberHealthConfig.html#getMaxMessageQueueSize--">getMaxMessageQueueSize</a>, <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html#getMaxReplyTimeouts--">getMaxReplyTimeouts</a>, <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html#getMaxRetransmissionRatio--">getMaxRetransmissionRatio</a>, <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html#getMaxVMProcessSize--">getMaxVMProcessSize</a>, <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html#setMaxMessageQueueSize-long-">setMaxMessageQueueSize</a>, <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html#setMaxReplyTimeouts-long-">setMaxReplyTimeouts</a>, <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html#setMaxRetransmissionRatio-double-">setMaxRetransmissionRatio</a>, <a href="../../../../org/apache/geode/admin/MemberHealthConfig.html#setMaxVMProcessSize-long-">setMaxVMProcessSize</a></code></li
>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.admin.CacheHealthConfig">
+<!-- -->
+</a>
+<h3>Methods inherited from interface org.apache.geode.admin.<a href="../../../../org/apache/geode/admin/CacheHealthConfig.html" title="interface in org.apache.geode.admin">CacheHealthConfig</a></h3>
+<code><a href="../../../../org/apache/geode/admin/CacheHealthConfig.html#getMaxEventQueueSize--">getMaxEventQueueSize</a>, <a href="../../../../org/apache/geode/admin/CacheHealthConfig.html#getMaxLoadTime--">getMaxLoadTime</a>, <a href="../../../../org/apache/geode/admin/CacheHealthConfig.html#getMaxNetSearchTime--">getMaxNetSearchTime</a>, <a href="../../../../org/apache/geode/admin/CacheHealthConfig.html#getMinHitRatio--">getMinHitRatio</a>, <a href="../../../../org/apache/geode/admin/CacheHealthConfig.html#setMaxEventQueueSize-long-">setMaxEventQueueSize</a>, <a href="../../../../org/apache/geode/admin/CacheHealthConfig.html#setMaxLoadTime-long-">setMaxLoadTime</a>, <a href="../../../../org/apache/geode/admin/CacheHealthConfig.html#setMaxNetSearchTime-long-">setMaxNetSearchTime</a>, <a href="../../../../org/apache/geode/admin/CacheHealthConfig.html#setMinHitRatio-double-">setMinHitRatio</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="DEFAULT_HEALTH_EVALUATION_INTERVAL">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>DEFAULT_HEALTH_EVALUATION_INTERVAL</h4>
+<pre>static final int DEFAULT_HEALTH_EVALUATION_INTERVAL</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">The default number of seconds between assessments of the health
+ of the GemFire components.</div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../constant-values.html#org.apache.geode.admin.GemFireHealthConfig.DEFAULT_HEALTH_EVALUATION_INTERVAL">Constant Field Values</a></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="getHostName--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getHostName</h4>
+<pre>java.lang.String getHostName()</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">Returns the name of the host to which this configuration
+ applies. If this is the "default" configuration, then
+ <code>null</code> is returned.</div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../org/apache/geode/admin/GemFireHealth.html#getGemFireHealthConfig-java.lang.String-"><code>GemFireHealth.getGemFireHealthConfig(java.lang.String)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="setHealthEvaluationInterval-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setHealthEvaluationInterval</h4>
+<pre>void setHealthEvaluationInterval(int interval)</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">Sets the number of seconds between assessments of the health of
+ the GemFire components.</div>
+</li>
+</ul>
+<a name="getHealthEvaluationInterval--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getHealthEvaluationInterval</h4>
+<pre>int getHealthEvaluationInterval()</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">Returns the number of seconds between assessments of the health of
+ the GemFire components.</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="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/geode/admin/GemFireHealth.Health.html" title="class in org.apache.geode.admin"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/geode/admin/GemFireMemberStatus.html" title="class in org.apache.geode.admin"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/geode/admin/GemFireHealthConfig.html" target="_top">Frames</a></li>
+<li><a href="GemFireHealthConfig.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>Constr | </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>Constr | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>