blob: 45ad82b7eac5d8666ea8afef236813b26ac25f26 [file] [log] [blame]
<!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 -->
<title>DistributedSystemMXBean (Apache Geode 1.15.1)</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="DistributedSystemMXBean (Apache Geode 1.15.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6,"i60":6,"i61":6,"i62":6,"i63":6,"i64":6,"i65":6,"i66":6,"i67":6,"i68":6,"i69":6,"i70":6,"i71":6,"i72":6,"i73":6,"i74":6,"i75":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/management/DistributedRegionMXBean.html" title="interface in org.apache.geode.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/management/EvictionAttributesData.html" title="class in org.apache.geode.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/management/DistributedSystemMXBean.html" target="_top">Frames</a></li>
<li><a href="DistributedSystemMXBean.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.management</div>
<h2 title="Interface DistributedSystemMXBean" class="title">Interface DistributedSystemMXBean</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">DistributedSystemMXBean</span></pre>
<div class="block">MBean that provides access to information and management operations for a
<a href="../../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed"><code>DistributedSystem</code></a>.
It also provides an API for navigating the other MBeans exposed by the GemFire distributed
system.
There will be one DistributedSystemMBean per GemFire cluster.
<p>
ObjectName : GemFire:service=System,type=Distributed
<p>
List of notifications emitted by this MBean.
<table border="1" summary="">
<tr>
<th>Notification Type</th>
<th>Notification Source</th>
<th>Message</th>
</tr>
<tr>
<td>gemfire.distributedsystem.cache.member.joined</td>
<td>Name or ID of member who joined</td>
<td>Member Joined &lt;Member Name or ID&gt;</td>
</tr>
<tr>
<td>gemfire.distributedsystem.cache.member.departed</td>
<td>Name or ID of member who departed</td>
<td>Member Departed &lt;Member Name or ID&gt; has crashed = &lt;true/false&gt;</td>
</tr>
<tr>
<td>gemfire.distributedsystem.cache.member.suspect</td>
<td>Name or ID of member who is suspected</td>
<td>Member Suspected &lt;Member Name or ID&gt; By &lt;Who Suspected&gt;</td>
</tr>
<tr>
<td>system.alert</td>
<td>DistributedSystem("&lt;DistributedSystem ID"&gt;)</td>
<td>Alert Message</td>
</tr>
</table></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 7.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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><a href="../../../../org/apache/geode/management/DiskBackupStatus.html" title="interface in org.apache.geode.management">DiskBackupStatus</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#backupAllMembers-java.lang.String-java.lang.String-">backupAllMembers</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>&nbsp;targetDirPath,
<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>&nbsp;baselineDirPath)</code>
<div class="block">Performs a backup on all members.</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/geode/management/DistributedSystemMXBean.html#changeAlertLevel-java.lang.String-">changeAlertLevel</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>&nbsp;alertLevel)</code>
<div class="block">Sets the minimum level for alerts to be delivered to listeners.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#fetchCacheServerObjectName-java.lang.String-int-">fetchCacheServerObjectName</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>&nbsp;member,
int&nbsp;port)</code>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/CacheServerMXBean.html" title="interface in org.apache.geode.management"><code>CacheServerMXBean</code></a> used to access a cache server.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#fetchDiskStoreObjectName-java.lang.String-java.lang.String-">fetchDiskStoreObjectName</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>&nbsp;member,
<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>&nbsp;diskStoreName)</code>
<div class="block">Returns object name of a <a href="../../../../org/apache/geode/management/DiskStoreMXBean.html" title="interface in org.apache.geode.management"><code>DiskStoreMXBean</code></a> for a given name and member</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#fetchDistributedLockServiceObjectName-java.lang.String-">fetchDistributedLockServiceObjectName</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>&nbsp;lockServiceName)</code>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/DistributedLockServiceMXBean.html" title="interface in org.apache.geode.management"><code>DistributedLockServiceMXBean</code></a> used to access a distributed
lock service.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#fetchDistributedRegionObjectName-java.lang.String-">fetchDistributedRegionObjectName</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>&nbsp;regionPath)</code>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/DistributedRegionMXBean.html" title="interface in org.apache.geode.management"><code>DistributedRegionMXBean</code></a> used to access a distributed
region.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#fetchGatewayReceiverObjectName-java.lang.String-">fetchGatewayReceiverObjectName</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>&nbsp;member)</code>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html" title="interface in org.apache.geode.management"><code>GatewayReceiverMXBean</code></a> used to access a gateway receiver.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#fetchGatewaySenderObjectName-java.lang.String-java.lang.String-">fetchGatewaySenderObjectName</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>&nbsp;member,
<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>&nbsp;senderId)</code>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html" title="interface in org.apache.geode.management"><code>GatewaySenderMXBean</code></a> used to access a gateway sender.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#fetchLockServiceObjectName-java.lang.String-java.lang.String-">fetchLockServiceObjectName</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>&nbsp;member,
<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>&nbsp;lockService)</code>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/LockServiceMXBean.html" title="interface in org.apache.geode.management"><code>LockServiceMXBean</code></a> used to access a lock service.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/management/GemFireProperties.html" title="class in org.apache.geode.management">GemFireProperties</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#fetchMemberConfiguration-java.lang.String-">fetchMemberConfiguration</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>&nbsp;member)</code>
<div class="block">Returns the configuration information for a distributed member.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#fetchMemberObjectName-java.lang.String-">fetchMemberObjectName</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>&nbsp;member)</code>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/MemberMXBean.html" title="interface in org.apache.geode.management"><code>MemberMXBean</code></a> used to access a distributed member.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#fetchMemberUpTime-java.lang.String-">fetchMemberUpTime</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>&nbsp;member)</code>
<div class="block">Returns the total time (in seconds) since a distributed member was started.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#fetchRegionObjectName-java.lang.String-java.lang.String-">fetchRegionObjectName</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>&nbsp;member,
<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>&nbsp;regionPath)</code>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/RegionMXBean.html" title="interface in org.apache.geode.management"><code>RegionMXBean</code></a> used to access a region.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#fetchRegionObjectNames-javax.management.ObjectName-">fetchRegionObjectNames</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;memberMBeanName)</code>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/RegionMXBean.html" title="interface in org.apache.geode.management"><code>RegionMXBean</code></a>s used to access all regions on a
distributed member.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getActiveCQCount--">getActiveCQCount</a></span>()</code>
<div class="block">Returns the number of active (currently executing) CQs for all cache servers.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<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/geode/management/DistributedSystemMXBean.html#getAlertLevel--">getAlertLevel</a></span>()</code>
<div class="block">Returns the minimum level set for alerts to be delivered to listeners.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getAverageReads--">getAverageReads</a></span>()</code>
<div class="block">Returns the average number of reads per second for all members.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getAverageWrites--">getAverageWrites</a></span>()</code>
<div class="block">Returns the average writes per second, including both put and putAll operations, for all
members.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getDiskFlushAvgLatency--">getDiskFlushAvgLatency</a></span>()</code>
<div class="block">Returns the average disk flush latency time.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getDiskReadsRate--">getDiskReadsRate</a></span>()</code>
<div class="block">Returns the average number of disk reads per second across all distributed members.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getDiskWritesRate--">getDiskWritesRate</a></span>()</code>
<div class="block">Returns the average number of disk writes per second across all distributed members.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getDistributedSystemId--">getDistributedSystemId</a></span>()</code>
<div class="block">Returns the ID of the DistributedSystem.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getGarbageCollectionCount--">getGarbageCollectionCount</a></span>()</code>
<div class="block">Returns the number of garbage collection operations for all members.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getJVMPauses--">getJVMPauses</a></span>()</code>
<div class="block">Returns the number JVM pauses (which may or may not include full garbage collection pauses)
detected by GemFire.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getLocatorCount--">getLocatorCount</a></span>()</code>
<div class="block">Returns the number of locators in the distributed system.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getManagerObjectName--">getManagerObjectName</a></span>()</code>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/ManagerMXBean.html" title="interface in org.apache.geode.management"><code>ManagerMXBean</code></a> used to access the management service
running on this distributed member.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getMemberCount--">getMemberCount</a></span>()</code>
<div class="block">Returns the number of members in the distributed system.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getMemberObjectName--">getMemberObjectName</a></span>()</code>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/MemberMXBean.html" title="interface in org.apache.geode.management"><code>MemberMXBean</code></a> used to access this distributed member.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getNumClients--">getNumClients</a></span>()</code>
<div class="block">Returns the number of connected clients.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getNumInitialImagesInProgress--">getNumInitialImagesInProgress</a></span>()</code>
<div class="block">Returns the number of initial images in progress.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getNumRunningFunctions--">getNumRunningFunctions</a></span>()</code>
<div class="block">Returns the number of map-reduce jobs currently running on all members in the distributed
system.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getNumSubscriptions--">getNumSubscriptions</a></span>()</code>
<div class="block">Returns the number of subscriptions for all members.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getQueryCollectionsDepth--">getQueryCollectionsDepth</a></span>()</code>
<div class="block">Number of elements in a collection to be shown in queryData operation if query results contain
collections like Map, List etc.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getQueryRequestRate--">getQueryRequestRate</a></span>()</code>
<div class="block">Returns the average number of queries per second across all distributed members.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getQueryResultSetLimit--">getQueryResultSetLimit</a></span>()</code>
<div class="block">Number of rows DistributedSystemMXBean.queryData() operation will return.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getRegisteredCQCount--">getRegisteredCQCount</a></span>()</code>
<div class="block">Returns the number of CQs registers on all members.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getSystemDiskStoreCount--">getSystemDiskStoreCount</a></span>()</code>
<div class="block">Returns the number of disks stores in the distributed system.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getTotalBackupInProgress--">getTotalBackupInProgress</a></span>()</code>
<div class="block">Returns the number of backups currently in progress for all disk stores.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getTotalDiskUsage--">getTotalDiskUsage</a></span>()</code>
<div class="block">Returns the number of bytes used on all disks.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getTotalHeapSize--">getTotalHeapSize</a></span>()</code>
<div class="block">Returns the total available heap (in megabytes) across all distributed members.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getTotalHitCount--">getTotalHitCount</a></span>()</code>
<div class="block">Returns the number of times that a hit occurred for all regions.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getTotalMissCount--">getTotalMissCount</a></span>()</code>
<div class="block">Returns the number of times that a cache miss occurred for all regions.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getTotalRegionCount--">getTotalRegionCount</a></span>()</code>
<div class="block">Returns the number of <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a>s.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getTotalRegionEntryCount--">getTotalRegionEntryCount</a></span>()</code>
<div class="block">Returns the total number of entries in all regions.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getTransactionCommitted--">getTransactionCommitted</a></span>()</code>
<div class="block">Returns the number of committed transactions across all members.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getTransactionRolledBack--">getTransactionRolledBack</a></span>()</code>
<div class="block">Returns the number of transactions that were rolled back across all members.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#getUsedHeapSize--">getUsedHeapSize</a></span>()</code>
<div class="block">Returns the total heap used on all members.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<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/geode/management/DistributedSystemMXBean.html#listAllRegionPaths--">listAllRegionPaths</a></span>()</code>
<div class="block">Returns a list of full paths for all regions.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#listCacheServerObjectNames--">listCacheServerObjectNames</a></span>()</code>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/CacheServerMXBean.html" title="interface in org.apache.geode.management"><code>CacheServerMXBean</code></a>s used to access all cache
servers.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<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/geode/management/DistributedSystemMXBean.html#listCacheServers--">listCacheServers</a></span>()</code>
<div class="block">Returns a list of names for all cache servers which are able to serve requests from GemFire
clients.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#listDistributedRegionObjectNames--">listDistributedRegionObjectNames</a></span>()</code>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/DistributedRegionMXBean.html" title="interface in org.apache.geode.management"><code>DistributedRegionMXBean</code></a>s used to access all
distributed regions.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#listGatewayReceiverObjectNames--">listGatewayReceiverObjectNames</a></span>()</code>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html" title="interface in org.apache.geode.management"><code>GatewayReceiverMXBean</code></a>s used to access all
gateway senders.</div>
</td>
</tr>
<tr id="i52" 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/geode/management/DistributedSystemMXBean.html#listGatewayReceivers--">listGatewayReceivers</a></span>()</code>
<div class="block">Returns a list of IDs for all gateway receivers.</div>
</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#listGatewaySenderObjectNames--">listGatewaySenderObjectNames</a></span>()</code>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html" title="interface in org.apache.geode.management"><code>GatewaySenderMXBean</code></a>s used to access all gateway
senders.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#listGatewaySenderObjectNames-java.lang.String-">listGatewaySenderObjectNames</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>&nbsp;member)</code>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html" title="interface in org.apache.geode.management"><code>GatewaySenderMXBean</code></a>s used to access all gateway
senders on a member.</div>
</td>
</tr>
<tr id="i55" class="rowColor">
<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/geode/management/DistributedSystemMXBean.html#listGatewaySenders--">listGatewaySenders</a></span>()</code>
<div class="block">Returns a list of IDs for all gateway senders.</div>
</td>
</tr>
<tr id="i56" 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/geode/management/DistributedSystemMXBean.html#listGroups--">listGroups</a></span>()</code>
<div class="block">Returns a list of names for all groups.</div>
</td>
</tr>
<tr id="i57" class="rowColor">
<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/geode/management/DistributedSystemMXBean.html#listLocatorMembers-boolean-">listLocatorMembers</a></span>(boolean&nbsp;onlyStandAloneLocators)</code>
<div class="block">Returns a list of names for locator members.</div>
</td>
</tr>
<tr id="i58" 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/geode/management/DistributedSystemMXBean.html#listLocators--">listLocators</a></span>()</code>
<div class="block">Returns a list of IDs for all locators.</div>
</td>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#listMemberDiskstore--">listMemberDiskstore</a></span>()</code>
<div class="block">Returns a map of all <a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed"><code>DistributedMember</code></a>s and their <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a>s.</div>
</td>
</tr>
<tr id="i60" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#listMemberObjectNames--">listMemberObjectNames</a></span>()</code>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/MemberMXBean.html" title="interface in org.apache.geode.management"><code>MemberMXBean</code></a>s used to access all distributed
members.</div>
</td>
</tr>
<tr id="i61" class="rowColor">
<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/geode/management/DistributedSystemMXBean.html#listMembers--">listMembers</a></span>()</code>
<div class="block">Returns a list of names for all members.</div>
</td>
</tr>
<tr id="i62" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/management/PersistentMemberDetails.html" title="class in org.apache.geode.management">PersistentMemberDetails</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#listMissingDiskStores--">listMissingDiskStores</a></span>()</code>
<div class="block">Returns a list of details for disk stores which have been determined to be unavailable during
the recovery of region.</div>
</td>
</tr>
<tr id="i63" class="rowColor">
<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/geode/management/DistributedSystemMXBean.html#listRegions--">listRegions</a></span>()</code>
<div class="block">Returns a list of names for all regions.</div>
</td>
</tr>
<tr id="i64" 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/geode/management/DistributedSystemMXBean.html#listServers--">listServers</a></span>()</code>
<div class="block">Returns a list of names for all servers where server means any long-running GemFire process
that was started with "start server" command from GFSH.</div>
</td>
</tr>
<tr id="i65" class="rowColor">
<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/geode/management/DistributedSystemMXBean.html#queryData-java.lang.String-java.lang.String-int-">queryData</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>&nbsp;queryString,
<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>&nbsp;members,
int&nbsp;limit)</code>
<div class="block">This API is used to query data from GemFire system.</div>
</td>
</tr>
<tr id="i66" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#queryDataForCompressedResult-java.lang.String-java.lang.String-int-">queryDataForCompressedResult</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>&nbsp;queryString,
<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>&nbsp;members,
int&nbsp;limit)</code>
<div class="block">Functionality is same as queryData() method.</div>
</td>
</tr>
<tr id="i67" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#revokeMissingDiskStores-java.lang.String-">revokeMissingDiskStores</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>&nbsp;diskStoreId)</code>
<div class="block">Removes a disk store from the distributed system.</div>
</td>
</tr>
<tr id="i68" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#setQueryCollectionsDepth-int-">setQueryCollectionsDepth</a></span>(int&nbsp;queryCollectionsDepth)</code>&nbsp;</td>
</tr>
<tr id="i69" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#setQueryResultSetLimit-int-">setQueryResultSetLimit</a></span>(int&nbsp;queryResultSetLimit)</code>&nbsp;</td>
</tr>
<tr id="i70" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/management/DiskMetrics.html" title="class in org.apache.geode.management">DiskMetrics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#showDiskMetrics-java.lang.String-">showDiskMetrics</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>&nbsp;member)</code>
<div class="block">Returns disk metrics for a distributed member.</div>
</td>
</tr>
<tr id="i71" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/management/JVMMetrics.html" title="class in org.apache.geode.management">JVMMetrics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#showJVMMetrics-java.lang.String-">showJVMMetrics</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>&nbsp;member)</code>
<div class="block">Returns JVM metrics for a distributed member.</div>
</td>
</tr>
<tr id="i72" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/management/NetworkMetrics.html" title="class in org.apache.geode.management">NetworkMetrics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#showNetworkMetric-java.lang.String-">showNetworkMetric</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>&nbsp;member)</code>
<div class="block">Returns network metrics for a distributed member.</div>
</td>
</tr>
<tr id="i73" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/management/OSMetrics.html" title="class in org.apache.geode.management">OSMetrics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#showOSMetrics-java.lang.String-">showOSMetrics</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>&nbsp;member)</code>
<div class="block">Returns operating system metrics for a distributed member.</div>
</td>
</tr>
<tr id="i74" 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/geode/management/DistributedSystemMXBean.html#shutDownAllMembers--">shutDownAllMembers</a></span>()</code>
<div class="block">Shuts down all members of a distributed system except for the managing member.</div>
</td>
</tr>
<tr id="i75" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/management/DistributedSystemMXBean.html#viewRemoteClusterStatus--">viewRemoteClusterStatus</a></span>()</code>
<div class="block">Returns a map of remote distributed system IDs and the current connection status for each.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDistributedSystemId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDistributedSystemId</h4>
<pre>int&nbsp;getDistributedSystemId()</pre>
<div class="block">Returns the ID of the DistributedSystem. allow anyone to access this method</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The DistributedSystem ID or -1 if not set.</dd>
</dl>
</li>
</ul>
<a name="getMemberCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemberCount</h4>
<pre>int&nbsp;getMemberCount()</pre>
<div class="block">Returns the number of members in the distributed system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of members in the distributed system</dd>
</dl>
</li>
</ul>
<a name="listMembers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMembers</h4>
<pre><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>[]&nbsp;listMembers()</pre>
<div class="block">Returns a list of names for all members.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of names for all members</dd>
</dl>
</li>
</ul>
<a name="listLocatorMembers-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listLocatorMembers</h4>
<pre><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>[]&nbsp;listLocatorMembers(boolean&nbsp;onlyStandAloneLocators)</pre>
<div class="block">Returns a list of names for locator members.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>onlyStandAloneLocators</code> - if set to <code>true</code>, includes only stand alone locator
members.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of names for locator members.</dd>
</dl>
</li>
</ul>
<a name="listGroups--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listGroups</h4>
<pre><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>[]&nbsp;listGroups()</pre>
<div class="block">Returns a list of names for all groups.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of names for all groups</dd>
</dl>
</li>
</ul>
<a name="getLocatorCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocatorCount</h4>
<pre>int&nbsp;getLocatorCount()</pre>
<div class="block">Returns the number of locators in the distributed system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of locators in the distributed system</dd>
</dl>
</li>
</ul>
<a name="listLocators--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listLocators</h4>
<pre><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>[]&nbsp;listLocators()</pre>
<div class="block">Returns a list of IDs for all locators.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of IDs for all locators.</dd>
</dl>
</li>
</ul>
<a name="getSystemDiskStoreCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSystemDiskStoreCount</h4>
<pre>int&nbsp;getSystemDiskStoreCount()</pre>
<div class="block">Returns the number of disks stores in the distributed system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of disks stores in the distributed system</dd>
</dl>
</li>
</ul>
<a name="listMemberDiskstore--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMemberDiskstore</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&gt;&nbsp;listMemberDiskstore()</pre>
<div class="block">Returns a map of all <a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed"><code>DistributedMember</code></a>s and their <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a>s.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map of all <a href="../../../../org/apache/geode/distributed/DistributedMember.html" title="interface in org.apache.geode.distributed"><code>DistributedMember</code></a>s and their <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a>s</dd>
</dl>
</li>
</ul>
<a name="listGatewaySenders--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listGatewaySenders</h4>
<pre><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>[]&nbsp;listGatewaySenders()</pre>
<div class="block">Returns a list of IDs for all gateway senders.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of IDs for all gateway senders</dd>
</dl>
</li>
</ul>
<a name="listGatewayReceivers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listGatewayReceivers</h4>
<pre><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>[]&nbsp;listGatewayReceivers()</pre>
<div class="block">Returns a list of IDs for all gateway receivers.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of IDs for all gateway receivers</dd>
</dl>
</li>
</ul>
<a name="getAlertLevel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlertLevel</h4>
<pre><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>&nbsp;getAlertLevel()</pre>
<div class="block">Returns the minimum level set for alerts to be delivered to listeners.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the minimum level set for alerts to be delivered to listeners</dd>
</dl>
</li>
</ul>
<a name="changeAlertLevel-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeAlertLevel</h4>
<pre>void&nbsp;changeAlertLevel(<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>&nbsp;alertLevel)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Sets the minimum level for alerts to be delivered to listeners.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>alertLevel</code> - Minimum level for alerts to be delivered. Must be one of: WARNING, ERROR,
SEVERE or NONE.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the alertLevel is invalid</dd>
</dl>
</li>
</ul>
<a name="getTotalHeapSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalHeapSize</h4>
<pre>long&nbsp;getTotalHeapSize()</pre>
<div class="block">Returns the total available heap (in megabytes) across all distributed members.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total available heap (in megabytes) across all distributed members</dd>
</dl>
</li>
</ul>
<a name="getTotalRegionEntryCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalRegionEntryCount</h4>
<pre>long&nbsp;getTotalRegionEntryCount()</pre>
<div class="block">Returns the total number of entries in all regions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of entries in all regions</dd>
</dl>
</li>
</ul>
<a name="getTotalRegionCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalRegionCount</h4>
<pre>int&nbsp;getTotalRegionCount()</pre>
<div class="block">Returns the number of <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a>s.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of <a href="../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache"><code>Region</code></a>s</dd>
</dl>
</li>
</ul>
<a name="getTotalMissCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalMissCount</h4>
<pre>int&nbsp;getTotalMissCount()</pre>
<div class="block">Returns the number of times that a cache miss occurred for all regions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of times that a cache miss occurred for all regions</dd>
</dl>
</li>
</ul>
<a name="getTotalHitCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalHitCount</h4>
<pre>int&nbsp;getTotalHitCount()</pre>
<div class="block">Returns the number of times that a hit occurred for all regions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of times that a hit occurred for all regions</dd>
</dl>
</li>
</ul>
<a name="getNumClients--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumClients</h4>
<pre>int&nbsp;getNumClients()</pre>
<div class="block">Returns the number of connected clients.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of connected clients</dd>
</dl>
</li>
</ul>
<a name="getDiskReadsRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskReadsRate</h4>
<pre>float&nbsp;getDiskReadsRate()</pre>
<div class="block">Returns the average number of disk reads per second across all distributed members.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average number of disk reads per second across all distributed members</dd>
</dl>
</li>
</ul>
<a name="getDiskWritesRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskWritesRate</h4>
<pre>float&nbsp;getDiskWritesRate()</pre>
<div class="block">Returns the average number of disk writes per second across all distributed members.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average number of disk writes per second across all distributed members</dd>
</dl>
</li>
</ul>
<a name="getDiskFlushAvgLatency--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiskFlushAvgLatency</h4>
<pre>long&nbsp;getDiskFlushAvgLatency()</pre>
<div class="block">Returns the average disk flush latency time.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average disk flush latency time</dd>
</dl>
</li>
</ul>
<a name="getTotalBackupInProgress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalBackupInProgress</h4>
<pre>int&nbsp;getTotalBackupInProgress()</pre>
<div class="block">Returns the number of backups currently in progress for all disk stores.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of backups currently in progress for all disk stores</dd>
</dl>
</li>
</ul>
<a name="getNumInitialImagesInProgress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumInitialImagesInProgress</h4>
<pre>int&nbsp;getNumInitialImagesInProgress()</pre>
<div class="block">Returns the number of initial images in progress.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of initial images in progress</dd>
</dl>
</li>
</ul>
<a name="getActiveCQCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveCQCount</h4>
<pre>long&nbsp;getActiveCQCount()</pre>
<div class="block">Returns the number of active (currently executing) CQs for all cache servers.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of active (currently executing) CQs for all cache servers</dd>
</dl>
</li>
</ul>
<a name="getQueryRequestRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryRequestRate</h4>
<pre>float&nbsp;getQueryRequestRate()</pre>
<div class="block">Returns the average number of queries per second across all distributed members.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average number of queries per second across all distributed members</dd>
</dl>
</li>
</ul>
<a name="backupAllMembers-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>backupAllMembers</h4>
<pre><a href="../../../../org/apache/geode/management/DiskBackupStatus.html" title="interface in org.apache.geode.management">DiskBackupStatus</a>&nbsp;backupAllMembers(<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>&nbsp;targetDirPath,
<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>&nbsp;baselineDirPath)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Performs a backup on all members.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targetDirPath</code> - Directory to which backup files will be written</dd>
<dd><code>baselineDirPath</code> - path of the directory for baseline backup.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The results of the backup request.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - is an exception is encountered while backing up members</dd>
</dl>
</li>
</ul>
<a name="fetchMemberConfiguration-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchMemberConfiguration</h4>
<pre><a href="../../../../org/apache/geode/management/GemFireProperties.html" title="class in org.apache.geode.management">GemFireProperties</a>&nbsp;fetchMemberConfiguration(<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>&nbsp;member)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns the configuration information for a distributed member.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or ID of the member.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The configuration information for a member.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - for an invalid member ID.</dd>
</dl>
</li>
</ul>
<a name="fetchMemberUpTime-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchMemberUpTime</h4>
<pre>long&nbsp;fetchMemberUpTime(<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>&nbsp;member)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns the total time (in seconds) since a distributed member was started.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or ID of the member.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The total time (in seconds) since a member was started.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - for an invalid member ID.</dd>
</dl>
</li>
</ul>
<a name="listCacheServers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listCacheServers</h4>
<pre><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>[]&nbsp;listCacheServers()</pre>
<div class="block">Returns a list of names for all cache servers which are able to serve requests from GemFire
clients.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of names for all cache servers which are able to serve requests from GemFire
clients</dd>
</dl>
</li>
</ul>
<a name="listServers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listServers</h4>
<pre><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>[]&nbsp;listServers()</pre>
<div class="block">Returns a list of names for all servers where server means any long-running GemFire process
that was started with "start server" command from GFSH.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of names for all servers</dd>
</dl>
</li>
</ul>
<a name="showJVMMetrics-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>showJVMMetrics</h4>
<pre><a href="../../../../org/apache/geode/management/JVMMetrics.html" title="class in org.apache.geode.management">JVMMetrics</a>&nbsp;showJVMMetrics(<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>&nbsp;member)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns JVM metrics for a distributed member.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or ID of the member.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>VM metrics for a distributed member</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - for an invalid member ID.</dd>
</dl>
</li>
</ul>
<a name="showOSMetrics-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>showOSMetrics</h4>
<pre><a href="../../../../org/apache/geode/management/OSMetrics.html" title="class in org.apache.geode.management">OSMetrics</a>&nbsp;showOSMetrics(<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>&nbsp;member)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns operating system metrics for a distributed member.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or ID of the member.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>operating system metrics for a distributed member</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - for an invalid member ID.</dd>
</dl>
</li>
</ul>
<a name="showNetworkMetric-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>showNetworkMetric</h4>
<pre><a href="../../../../org/apache/geode/management/NetworkMetrics.html" title="class in org.apache.geode.management">NetworkMetrics</a>&nbsp;showNetworkMetric(<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>&nbsp;member)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns network metrics for a distributed member.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or ID of the member.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>network metrics for a distributed member</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - for an invalid member ID.</dd>
</dl>
</li>
</ul>
<a name="showDiskMetrics-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>showDiskMetrics</h4>
<pre><a href="../../../../org/apache/geode/management/DiskMetrics.html" title="class in org.apache.geode.management">DiskMetrics</a>&nbsp;showDiskMetrics(<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>&nbsp;member)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns disk metrics for a distributed member.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or ID of the member.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>disk metrics for a distributed member</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - for an invalid member ID.</dd>
</dl>
</li>
</ul>
<a name="shutDownAllMembers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutDownAllMembers</h4>
<pre><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>[]&nbsp;shutDownAllMembers()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Shuts down all members of a distributed system except for the managing member.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of names of all distributed members that were shutdown.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an exception is encountered when shutting down the members</dd>
</dl>
</li>
</ul>
<a name="listRegions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listRegions</h4>
<pre><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>[]&nbsp;listRegions()</pre>
<div class="block">Returns a list of names for all regions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of names for all regions</dd>
</dl>
</li>
</ul>
<a name="listAllRegionPaths--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listAllRegionPaths</h4>
<pre><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>[]&nbsp;listAllRegionPaths()</pre>
<div class="block">Returns a list of full paths for all regions. Returns an empty array if no region exists</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of full paths for all regions</dd>
</dl>
</li>
</ul>
<a name="revokeMissingDiskStores-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>revokeMissingDiskStores</h4>
<pre>boolean&nbsp;revokeMissingDiskStores(<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>&nbsp;diskStoreId)</pre>
<div class="block">Removes a disk store from the distributed system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>diskStoreId</code> - UUID of the disk store to remove</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the request is successful, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="listMissingDiskStores--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMissingDiskStores</h4>
<pre><a href="../../../../org/apache/geode/management/PersistentMemberDetails.html" title="class in org.apache.geode.management">PersistentMemberDetails</a>[]&nbsp;listMissingDiskStores()</pre>
<div class="block">Returns a list of details for disk stores which have been determined to be unavailable during
the recovery of region.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of details for disk stores which have been determined to be unavailable during
the recovery of region</dd>
</dl>
</li>
</ul>
<a name="getMemberObjectName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemberObjectName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;getMemberObjectName()</pre>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/MemberMXBean.html" title="interface in org.apache.geode.management"><code>MemberMXBean</code></a> used to access this distributed member.
allow anyone to access this method</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object name for a <a href="../../../../org/apache/geode/management/MemberMXBean.html" title="interface in org.apache.geode.management"><code>MemberMXBean</code></a> used to access this distributed member</dd>
</dl>
</li>
</ul>
<a name="getManagerObjectName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getManagerObjectName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;getManagerObjectName()</pre>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/ManagerMXBean.html" title="interface in org.apache.geode.management"><code>ManagerMXBean</code></a> used to access the management service
running on this distributed member.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object name for a <a href="../../../../org/apache/geode/management/ManagerMXBean.html" title="interface in org.apache.geode.management"><code>ManagerMXBean</code></a> used to access the management service
running on this distributed member</dd>
</dl>
</li>
</ul>
<a name="listMemberObjectNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listMemberObjectNames</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]&nbsp;listMemberObjectNames()</pre>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/MemberMXBean.html" title="interface in org.apache.geode.management"><code>MemberMXBean</code></a>s used to access all distributed
members.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of object names for the <a href="../../../../org/apache/geode/management/MemberMXBean.html" title="interface in org.apache.geode.management"><code>MemberMXBean</code></a>s used to access all distributed
members</dd>
</dl>
</li>
</ul>
<a name="fetchMemberObjectName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchMemberObjectName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;fetchMemberObjectName(<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>&nbsp;member)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/MemberMXBean.html" title="interface in org.apache.geode.management"><code>MemberMXBean</code></a> used to access a distributed member.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or ID of the member.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object name for a <a href="../../../../org/apache/geode/management/MemberMXBean.html" title="interface in org.apache.geode.management"><code>MemberMXBean</code></a> used to access a distributed member</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the member cannot be found</dd>
</dl>
</li>
</ul>
<a name="fetchRegionObjectNames-javax.management.ObjectName-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchRegionObjectNames</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]&nbsp;fetchRegionObjectNames(<a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;memberMBeanName)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/RegionMXBean.html" title="interface in org.apache.geode.management"><code>RegionMXBean</code></a>s used to access all regions on a
distributed member.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>memberMBeanName</code> - ObjectName of the member.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of object names or an empty array if no regions are found.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the member cannot be found</dd>
</dl>
</li>
</ul>
<a name="listDistributedRegionObjectNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listDistributedRegionObjectNames</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]&nbsp;listDistributedRegionObjectNames()</pre>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/DistributedRegionMXBean.html" title="interface in org.apache.geode.management"><code>DistributedRegionMXBean</code></a>s used to access all
distributed regions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of object names or an empty array if no distributed regions are found.</dd>
</dl>
</li>
</ul>
<a name="fetchDistributedRegionObjectName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchDistributedRegionObjectName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;fetchDistributedRegionObjectName(<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>&nbsp;regionPath)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/DistributedRegionMXBean.html" title="interface in org.apache.geode.management"><code>DistributedRegionMXBean</code></a> used to access a distributed
region.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>regionPath</code> - Full path of the region.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object name for a <a href="../../../../org/apache/geode/management/DistributedRegionMXBean.html" title="interface in org.apache.geode.management"><code>DistributedRegionMXBean</code></a> used to access a distributed
region</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the member cannot be found</dd>
</dl>
</li>
</ul>
<a name="fetchRegionObjectName-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchRegionObjectName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;fetchRegionObjectName(<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>&nbsp;member,
<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>&nbsp;regionPath)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/RegionMXBean.html" title="interface in org.apache.geode.management"><code>RegionMXBean</code></a> used to access a region.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or ID of the member.</dd>
<dd><code>regionPath</code> - Full path of the region.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object name for a <a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html" title="interface in org.apache.geode.management"><code>GatewayReceiverMXBean</code></a> used to access a region</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the member name is invalid or the member cannot be found</dd>
</dl>
</li>
</ul>
<a name="fetchGatewaySenderObjectName-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchGatewaySenderObjectName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;fetchGatewaySenderObjectName(<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>&nbsp;member,
<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>&nbsp;senderId)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html" title="interface in org.apache.geode.management"><code>GatewaySenderMXBean</code></a> used to access a gateway sender.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or ID of the member.</dd>
<dd><code>senderId</code> - ID of a gateway sender.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object name for a <a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html" title="interface in org.apache.geode.management"><code>GatewayReceiverMXBean</code></a> used to access a gateway sender</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the member name is invalid or the member cannot be found</dd>
</dl>
</li>
</ul>
<a name="fetchGatewayReceiverObjectName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchGatewayReceiverObjectName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;fetchGatewayReceiverObjectName(<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>&nbsp;member)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html" title="interface in org.apache.geode.management"><code>GatewayReceiverMXBean</code></a> used to access a gateway receiver.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or ID of the member.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object name for a <a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html" title="interface in org.apache.geode.management"><code>GatewayReceiverMXBean</code></a> used to access a gateway receiver</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the member name is invalid or the member cannot be found</dd>
</dl>
</li>
</ul>
<a name="listGatewaySenderObjectNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listGatewaySenderObjectNames</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]&nbsp;listGatewaySenderObjectNames()</pre>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html" title="interface in org.apache.geode.management"><code>GatewaySenderMXBean</code></a>s used to access all gateway
senders.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of object names or an empty array if no gateway senders are found.</dd>
</dl>
</li>
</ul>
<a name="listGatewaySenderObjectNames-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listGatewaySenderObjectNames</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]&nbsp;listGatewaySenderObjectNames(<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>&nbsp;member)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/GatewaySenderMXBean.html" title="interface in org.apache.geode.management"><code>GatewaySenderMXBean</code></a>s used to access all gateway
senders on a member.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or ID of the member.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of object names or an empty array if no gateway senders are found.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the member name is invalid or the member cannot be found</dd>
</dl>
</li>
</ul>
<a name="listGatewayReceiverObjectNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listGatewayReceiverObjectNames</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]&nbsp;listGatewayReceiverObjectNames()</pre>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/GatewayReceiverMXBean.html" title="interface in org.apache.geode.management"><code>GatewayReceiverMXBean</code></a>s used to access all
gateway senders.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of object names or an empty array if no gateway receivers are found.</dd>
</dl>
</li>
</ul>
<a name="fetchDistributedLockServiceObjectName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchDistributedLockServiceObjectName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;fetchDistributedLockServiceObjectName(<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>&nbsp;lockServiceName)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/DistributedLockServiceMXBean.html" title="interface in org.apache.geode.management"><code>DistributedLockServiceMXBean</code></a> used to access a distributed
lock service.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lockServiceName</code> - Name of the lock service.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object name for a <a href="../../../../org/apache/geode/management/DistributedLockServiceMXBean.html" title="interface in org.apache.geode.management"><code>DistributedLockServiceMXBean</code></a> used to access a distributed
lock service</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the member name is invalid or the member cannot be found</dd>
</dl>
</li>
</ul>
<a name="fetchLockServiceObjectName-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchLockServiceObjectName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;fetchLockServiceObjectName(<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>&nbsp;member,
<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>&nbsp;lockService)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/LockServiceMXBean.html" title="interface in org.apache.geode.management"><code>LockServiceMXBean</code></a> used to access a lock service.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or Id of the member.</dd>
<dd><code>lockService</code> - Name of the lock service.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object name for a <a href="../../../../org/apache/geode/management/LockServiceMXBean.html" title="interface in org.apache.geode.management"><code>LockServiceMXBean</code></a> used to access a lock service</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the member name is invalid or the member cannot be found</dd>
</dl>
</li>
</ul>
<a name="fetchDiskStoreObjectName-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchDiskStoreObjectName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;fetchDiskStoreObjectName(<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>&nbsp;member,
<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>&nbsp;diskStoreName)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns object name of a <a href="../../../../org/apache/geode/management/DiskStoreMXBean.html" title="interface in org.apache.geode.management"><code>DiskStoreMXBean</code></a> for a given name and member</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - name or id of the member</dd>
<dd><code>diskStoreName</code> - name of the disk store</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an ObjectName</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the member name is invalid or the member cannot be found</dd>
</dl>
</li>
</ul>
<a name="fetchCacheServerObjectName-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchCacheServerObjectName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>&nbsp;fetchCacheServerObjectName(<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>&nbsp;member,
int&nbsp;port)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Returns the object name for a <a href="../../../../org/apache/geode/management/CacheServerMXBean.html" title="interface in org.apache.geode.management"><code>CacheServerMXBean</code></a> used to access a cache server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>member</code> - Name or ID of the member.</dd>
<dd><code>port</code> - Port of the server.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object name for a <a href="../../../../org/apache/geode/management/CacheServerMXBean.html" title="interface in org.apache.geode.management"><code>CacheServerMXBean</code></a> used to access a cache server</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the member name is invalid or the member cannot be found</dd>
</dl>
</li>
</ul>
<a name="listCacheServerObjectNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listCacheServerObjectNames</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html?is-external=true" title="class or interface in javax.management">ObjectName</a>[]&nbsp;listCacheServerObjectNames()</pre>
<div class="block">Returns a list of object names for the <a href="../../../../org/apache/geode/management/CacheServerMXBean.html" title="interface in org.apache.geode.management"><code>CacheServerMXBean</code></a>s used to access all cache
servers.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of object names for the <a href="../../../../org/apache/geode/management/CacheServerMXBean.html" title="interface in org.apache.geode.management"><code>CacheServerMXBean</code></a>s used to access all cache
servers</dd>
</dl>
</li>
</ul>
<a name="getNumRunningFunctions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumRunningFunctions</h4>
<pre>int&nbsp;getNumRunningFunctions()</pre>
<div class="block">Returns the number of map-reduce jobs currently running on all members in the distributed
system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of map-reduce jobs currently running on all members in the distributed
system</dd>
</dl>
</li>
</ul>
<a name="getRegisteredCQCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRegisteredCQCount</h4>
<pre>long&nbsp;getRegisteredCQCount()</pre>
<div class="block">Returns the number of CQs registers on all members.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of CQs registers on all members</dd>
</dl>
</li>
</ul>
<a name="getTotalDiskUsage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalDiskUsage</h4>
<pre>long&nbsp;getTotalDiskUsage()</pre>
<div class="block">Returns the number of bytes used on all disks.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes used on all disks</dd>
</dl>
</li>
</ul>
<a name="getUsedHeapSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsedHeapSize</h4>
<pre>long&nbsp;getUsedHeapSize()</pre>
<div class="block">Returns the total heap used on all members.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total heap used on all members</dd>
</dl>
</li>
</ul>
<a name="getAverageReads--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageReads</h4>
<pre>float&nbsp;getAverageReads()</pre>
<div class="block">Returns the average number of reads per second for all members.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average number of reads per second for all members</dd>
</dl>
</li>
</ul>
<a name="getAverageWrites--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageWrites</h4>
<pre>float&nbsp;getAverageWrites()</pre>
<div class="block">Returns the average writes per second, including both put and putAll operations, for all
members.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average writes per second, including both put and putAll operations, for all
members</dd>
</dl>
</li>
</ul>
<a name="getNumSubscriptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumSubscriptions</h4>
<pre>int&nbsp;getNumSubscriptions()</pre>
<div class="block">Returns the number of subscriptions for all members.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of subscriptions for all members</dd>
</dl>
</li>
</ul>
<a name="getGarbageCollectionCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGarbageCollectionCount</h4>
<pre>long&nbsp;getGarbageCollectionCount()</pre>
<div class="block">Returns the number of garbage collection operations for all members.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of garbage collection operations for all members</dd>
</dl>
</li>
</ul>
<a name="viewRemoteClusterStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>viewRemoteClusterStatus</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;&nbsp;viewRemoteClusterStatus()</pre>
<div class="block">Returns a map of remote distributed system IDs and the current connection status for each.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map of remote distributed system IDs and the current connection status for each</dd>
</dl>
</li>
</ul>
<a name="getJVMPauses--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJVMPauses</h4>
<pre>long&nbsp;getJVMPauses()</pre>
<div class="block">Returns the number JVM pauses (which may or may not include full garbage collection pauses)
detected by GemFire.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number JVM pauses detected</dd>
</dl>
</li>
</ul>
<a name="queryData-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryData</h4>
<pre><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>&nbsp;queryData(<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>&nbsp;queryString,
<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>&nbsp;members,
int&nbsp;limit)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">This API is used to query data from GemFire system. This returns a JSON formatted String having
data and it's type. Type and value of data makes an array , type preceding the value.
e.g. {"result":[["java.lang.String","v"],["java.lang.String","b"]]}
GemFire PDXInstances are also supported. The type of PDXInstance is PDXInstance and value will
be key value pair. There is no marker to know the "IdentityField" of the PDXInstance.
If the query is executed on the cluster and no member list is given in input first key of the
JSON string will be "result" followed by the result set in JSON format.
If the query is executed on one or more specific members then returned string will have an
array of "member" and "result" keys.
For query on replicated region data from a random node which have the region is shown, if no
member input is given. For PR regions data from all the nodes are collected and shown. User
must be careful to query on a PR if the region is big and hosted on a lot of nodes
Join queries on PR mandates that user provide one member as input. If the member does not host
the regions or the regions are not co-located error string will be returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queryString</code> - GemFire supported OQL query</dd>
<dd><code>members</code> - comma separated list of members on which the query is to be executed. It is not
mandatory to give this input barring join queries on PR. If member list is not provided
query will be for the whole cluster.</dd>
<dd><code>limit</code> - result set limit. If not set or 0 is passed default limit of 1000 will be set.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a JSON formatted string containing data and its type</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an exception is encountered while executing the query</dd>
</dl>
</li>
</ul>
<a name="queryDataForCompressedResult-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryDataForCompressedResult</h4>
<pre>byte[]&nbsp;queryDataForCompressedResult(<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>&nbsp;queryString,
<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>&nbsp;members,
int&nbsp;limit)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Functionality is same as queryData() method. Only difference being the resultant JSON string is
compressed with Java GZIP with UTF-8 encoding. Any client application can de compress the
byte[] using GZIP.
e.g.
GZIPInputStream gis = new GZIPInputStream(new ByteArrayInputStream(bytes));
BufferedReader bf = new BufferedReader(new InputStreamReader(gis,"UTF-8"));
String outStr = ""; String line; while ((line = bf.readLine()) != null) { outStr += line; }</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queryString</code> - GemFire supported OQL query</dd>
<dd><code>members</code> - comma separated list of members on which the query is to be executed. It is not
mandatory to give this input barring join queries on PR. If member list is not provided
query will be for the whole cluster.</dd>
<dd><code>limit</code> - result set limit. If not set or 0 is passed default limit of 1000 will be set.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a byte[] which is a compressed JSON string.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an exception is encountered while executing the query</dd>
</dl>
</li>
</ul>
<a name="getTransactionCommitted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransactionCommitted</h4>
<pre>int&nbsp;getTransactionCommitted()</pre>
<div class="block">Returns the number of committed transactions across all members. It gives point in time value
i.e. Number of tx committed at the time of reading this value</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of committed transactions across all members</dd>
</dl>
</li>
</ul>
<a name="getTransactionRolledBack--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransactionRolledBack</h4>
<pre>int&nbsp;getTransactionRolledBack()</pre>
<div class="block">Returns the number of transactions that were rolled back across all members. It gives point in
time value i.e. Number of tx rolled back at the time of reading this value</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of transactions that were rolled back across all members</dd>
</dl>
</li>
</ul>
<a name="getQueryResultSetLimit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryResultSetLimit</h4>
<pre>int&nbsp;getQueryResultSetLimit()</pre>
<div class="block">Number of rows DistributedSystemMXBean.queryData() operation will return. By default it will be
1000. User can modify this to control number of rows to be shown on Pulse, as Pulse DataBrowser
internally uses DistributedSystemMXBean.queryData()</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of rows DistributedSystemMXBean.queryData() operation will return</dd>
</dl>
</li>
</ul>
<a name="setQueryResultSetLimit-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueryResultSetLimit</h4>
<pre>void&nbsp;setQueryResultSetLimit(int&nbsp;queryResultSetLimit)</pre>
</li>
</ul>
<a name="getQueryCollectionsDepth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryCollectionsDepth</h4>
<pre>int&nbsp;getQueryCollectionsDepth()</pre>
<div class="block">Number of elements in a collection to be shown in queryData operation if query results contain
collections like Map, List etc.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of elements in a collection to be shown in queryData operation if query
results contain collections</dd>
</dl>
</li>
</ul>
<a name="setQueryCollectionsDepth-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setQueryCollectionsDepth</h4>
<pre>void&nbsp;setQueryCollectionsDepth(int&nbsp;queryCollectionsDepth)</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="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/management/DistributedRegionMXBean.html" title="interface in org.apache.geode.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/geode/management/EvictionAttributesData.html" title="class in org.apache.geode.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/management/DistributedSystemMXBean.html" target="_top">Frames</a></li>
<li><a href="DistributedSystemMXBean.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>