releases/latest/javadoc/org/apache/geode/management/api/ClusterManagementService.html - geode-site - Git at Google

 <!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>ClusterManagementService (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="ClusterManagementService (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};
 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/api/ClusterManagementResult.StatusCode.html" title="enum in org.apache.geode.management.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/apache/geode/management/api/ClusterManagementServiceTransport.html" title="interface in org.apache.geode.management.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/geode/management/api/ClusterManagementService.html" target="_top">Frames</a></li>
 <li><a href="ClusterManagementService.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.api</div>
 <h2 title="Interface ClusterManagementService" class="title">Interface ClusterManagementService</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Superinterfaces:</dt>
 <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
 </dl>
 <hr>
 <br>
 <pre><a href="../../../../../org/apache/geode/annotations/Experimental.html" title="annotation in org.apache.geode.annotations">@Experimental</a>
 public interface <span class="typeNameLabel">ClusterManagementService</span>
 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre>
 <div class="block">Implementations of this interface are responsible for applying and persisting cache
  configuration changes.</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="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>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#close--">close</a></span>()</code>
 <div class="block">release any resources controlled by this service</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>&lt;T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a>&lt;?&gt;&gt;<br><a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationResult.html" title="class in org.apache.geode.management.api">ClusterManagementRealizationResult</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#create-T-">create</a></span>(T&nbsp;config)</code>
 <div class="block">This method will create the element on all the applicable members in the cluster and persist
  the configuration in the cluster configuration if persistence is enabled.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>&lt;T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a>&lt;?&gt;&gt;<br><a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationResult.html" title="class in org.apache.geode.management.api">ClusterManagementRealizationResult</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#delete-T-">delete</a></span>(T&nbsp;config)</code>
 <div class="block">This method will delete the element on all the applicable members in the cluster and update the
  configuration in the cluster configuration if persistence is enabled.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>&lt;A extends <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api">ClusterManagementOperation</a>&lt;V&gt;,V extends <a href="../../../../../org/apache/geode/management/runtime/OperationResult.html" title="interface in org.apache.geode.management.runtime">OperationResult</a>&gt;<br><a href="../../../../../org/apache/geode/management/api/ClusterManagementOperationResult.html" title="class in org.apache.geode.management.api">ClusterManagementOperationResult</a>&lt;A,V&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#get-A-java.lang.String-">get</a></span>(A&nbsp;opType,
    <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;opId)</code>
 <div class="block">Returns the status of the identified operation.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>&lt;T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a>&lt;R&gt;,R extends <a href="../../../../../org/apache/geode/management/runtime/RuntimeInfo.html" title="class in org.apache.geode.management.runtime">RuntimeInfo</a>&gt;<br><a href="../../../../../org/apache/geode/management/api/ClusterManagementGetResult.html" title="class in org.apache.geode.management.api">ClusterManagementGetResult</a>&lt;T,R&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#get-T-">get</a></span>(T&nbsp;config)</code>
 <div class="block">This method will get a single instance of the element type in the cluster configuration, along
  with additional runtime information from cluster members</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>&lt;A extends <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api">ClusterManagementOperation</a>&lt;V&gt;,V extends <a href="../../../../../org/apache/geode/management/runtime/OperationResult.html" title="interface in org.apache.geode.management.runtime">OperationResult</a>&gt;<br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a>&lt;<a href="../../../../../org/apache/geode/management/api/ClusterManagementOperationResult.html" title="class in org.apache.geode.management.api">ClusterManagementOperationResult</a>&lt;A,V&gt;&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#getFuture-A-java.lang.String-">getFuture</a></span>(A&nbsp;opType,
          <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;opId)</code>
 <div class="block">Returns a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that provides a synchronous way to get the result of a
  completed operation.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#isConnected--">isConnected</a></span>()</code>
 <div class="block">Test to see if this instance of ClusterManagementService retrieved from the client side is
  properly connected to the locator or not</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>&lt;A extends <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api">ClusterManagementOperation</a>&lt;V&gt;,V extends <a href="../../../../../org/apache/geode/management/runtime/OperationResult.html" title="interface in org.apache.geode.management.runtime">OperationResult</a>&gt;<br><a href="../../../../../org/apache/geode/management/api/ClusterManagementListOperationsResult.html" title="class in org.apache.geode.management.api">ClusterManagementListOperationsResult</a>&lt;A,V&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#list-A-">list</a></span>(A&nbsp;opType)</code>
 <div class="block">This method will list the status of all asynchronous cluster management operations in progress
  or recently completed.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>&lt;T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a>&lt;R&gt;,R extends <a href="../../../../../org/apache/geode/management/runtime/RuntimeInfo.html" title="class in org.apache.geode.management.runtime">RuntimeInfo</a>&gt;<br><a href="../../../../../org/apache/geode/management/api/ClusterManagementListResult.html" title="class in org.apache.geode.management.api">ClusterManagementListResult</a>&lt;T,R&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#list-T-">list</a></span>(T&nbsp;filter)</code>
 <div class="block">This method will list instances of the element type in the cluster configuration, along with
  additional runtime information from cluster members</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>&lt;A extends <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api">ClusterManagementOperation</a>&lt;V&gt;,V extends <a href="../../../../../org/apache/geode/management/runtime/OperationResult.html" title="interface in org.apache.geode.management.runtime">OperationResult</a>&gt;<br><a href="../../../../../org/apache/geode/management/api/ClusterManagementOperationResult.html" title="class in org.apache.geode.management.api">ClusterManagementOperationResult</a>&lt;A,V&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#start-A-">start</a></span>(A&nbsp;op)</code>
 <div class="block">This method will launch a cluster management operation asynchronously.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>&lt;T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a>&lt;?&gt;&gt;<br><a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationResult.html" title="class in org.apache.geode.management.api">ClusterManagementRealizationResult</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/management/api/ClusterManagementService.html#update-T-">update</a></span>(T&nbsp;config)</code>
 <div class="block">This method will update the element on all the applicable members in the cluster and persist
  the updated configuration in the cluster configuration if persistence is enabled.</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="create-org.apache.geode.management.configuration.AbstractConfiguration-">
 <!--   -->
 </a><a name="create-T-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>create</h4>
 <pre>&lt;T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a>&lt;?&gt;&gt;&nbsp;<a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationResult.html" title="class in org.apache.geode.management.api">ClusterManagementRealizationResult</a>&nbsp;create(T&nbsp;config)</pre>
 <div class="block">This method will create the element on all the applicable members in the cluster and persist
  the configuration in the cluster configuration if persistence is enabled.</div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>T</code> - the type of <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration"><code>AbstractConfiguration</code></a> to create</dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>config</code> - this holds the configuration attributes of the element to be created on the
         cluster, as well as the group this config belongs to</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationResult.html" title="class in org.apache.geode.management.api"><code>ClusterManagementRealizationResult</code></a> indicating the success of the creation</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationException.html" title="class in org.apache.geode.management.api">ClusterManagementRealizationException</a></code> - if unsuccessful</dd>
 </dl>
 </li>
 </ul>
 <a name="delete-org.apache.geode.management.configuration.AbstractConfiguration-">
 <!--   -->
 </a><a name="delete-T-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>delete</h4>
 <pre>&lt;T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a>&lt;?&gt;&gt;&nbsp;<a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationResult.html" title="class in org.apache.geode.management.api">ClusterManagementRealizationResult</a>&nbsp;delete(T&nbsp;config)</pre>
 <div class="block">This method will delete the element on all the applicable members in the cluster and update the
  configuration in the cluster configuration if persistence is enabled.</div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>T</code> - the type of <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration"><code>AbstractConfiguration</code></a> to delete</dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>config</code> - this holds the name or id of the element to be deleted on the cluster</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationResult.html" title="class in org.apache.geode.management.api"><code>ClusterManagementRealizationResult</code></a> indicating the success of the deletion</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationException.html" title="class in org.apache.geode.management.api">ClusterManagementRealizationException</a></code> - if unsuccessful</dd>
 </dl>
 </li>
 </ul>
 <a name="update-org.apache.geode.management.configuration.AbstractConfiguration-">
 <!--   -->
 </a><a name="update-T-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>update</h4>
 <pre>&lt;T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a>&lt;?&gt;&gt;&nbsp;<a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationResult.html" title="class in org.apache.geode.management.api">ClusterManagementRealizationResult</a>&nbsp;update(T&nbsp;config)</pre>
 <div class="block">This method will update the element on all the applicable members in the cluster and persist
  the updated configuration in the cluster configuration if persistence is enabled.</div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>T</code> - the type of <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration"><code>AbstractConfiguration</code></a> to update</dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>config</code> - this holds the configuration attributes of the element to be updated on the
         cluster, as well as the group this config belongs to</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationResult.html" title="class in org.apache.geode.management.api"><code>ClusterManagementRealizationResult</code></a> indicating the success of the update</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../../org/apache/geode/management/api/ClusterManagementRealizationException.html" title="class in org.apache.geode.management.api">ClusterManagementRealizationException</a></code> - if unsuccessful</dd>
 </dl>
 </li>
 </ul>
 <a name="list-org.apache.geode.management.configuration.AbstractConfiguration-">
 <!--   -->
 </a><a name="list-T-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>list</h4>
 <pre>&lt;T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a>&lt;R&gt;,R extends <a href="../../../../../org/apache/geode/management/runtime/RuntimeInfo.html" title="class in org.apache.geode.management.runtime">RuntimeInfo</a>&gt;&nbsp;<a href="../../../../../org/apache/geode/management/api/ClusterManagementListResult.html" title="class in org.apache.geode.management.api">ClusterManagementListResult</a>&lt;T,R&gt;&nbsp;list(T&nbsp;filter)</pre>
 <div class="block">This method will list instances of the element type in the cluster configuration, along with
  additional runtime information from cluster members</div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>T</code> - the type of <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration"><code>AbstractConfiguration</code></a> to list</dd>
 <dd><code>R</code> - the type of <a href="../../../../../org/apache/geode/management/runtime/RuntimeInfo.html" title="class in org.apache.geode.management.runtime"><code>RuntimeInfo</code></a> used by the <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration"><code>AbstractConfiguration</code></a></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>filter</code> - the filterable attributes are used to identify the elements to list. Any
         non-filterable attributes will be ignored.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <a href="../../../../../org/apache/geode/management/api/ClusterManagementListResult.html" title="class in org.apache.geode.management.api"><code>ClusterManagementListResult</code></a> holding a list of matching instances in
          <a href="../../../../../org/apache/geode/management/api/ClusterManagementListResult.html#getResult--"><code>ClusterManagementListResult.getResult()</code></a></dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../../org/apache/geode/management/api/ClusterManagementException.html" title="class in org.apache.geode.management.api">ClusterManagementException</a></code> - if unsuccessful</dd>
 </dl>
 </li>
 </ul>
 <a name="get-org.apache.geode.management.configuration.AbstractConfiguration-">
 <!--   -->
 </a><a name="get-T-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>get</h4>
 <pre>&lt;T extends <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a>&lt;R&gt;,R extends <a href="../../../../../org/apache/geode/management/runtime/RuntimeInfo.html" title="class in org.apache.geode.management.runtime">RuntimeInfo</a>&gt;&nbsp;<a href="../../../../../org/apache/geode/management/api/ClusterManagementGetResult.html" title="class in org.apache.geode.management.api">ClusterManagementGetResult</a>&lt;T,R&gt;&nbsp;get(T&nbsp;config)</pre>
 <div class="block">This method will get a single instance of the element type in the cluster configuration, along
  with additional runtime information from cluster members</div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>T</code> - the type of <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration"><code>AbstractConfiguration</code></a> to get</dd>
 <dd><code>R</code> - the type of <a href="../../../../../org/apache/geode/management/runtime/RuntimeInfo.html" title="class in org.apache.geode.management.runtime"><code>RuntimeInfo</code></a> used by the <a href="../../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration"><code>AbstractConfiguration</code></a></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>config</code> - this holds the name or id of the element to be retrieved</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <a href="../../../../../org/apache/geode/management/api/ClusterManagementGetResult.html" title="class in org.apache.geode.management.api"><code>ClusterManagementGetResult</code></a></dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../../org/apache/geode/management/api/ClusterManagementException.html" title="class in org.apache.geode.management.api">ClusterManagementException</a></code> - if unsuccessful or, no matching element is found, or
          multiple matches are found</dd>
 </dl>
 </li>
 </ul>
 <a name="start-org.apache.geode.management.api.ClusterManagementOperation-">
 <!--   -->
 </a><a name="start-A-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>start</h4>
 <pre>&lt;A extends <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api">ClusterManagementOperation</a>&lt;V&gt;,V extends <a href="../../../../../org/apache/geode/management/runtime/OperationResult.html" title="interface in org.apache.geode.management.runtime">OperationResult</a>&gt;&nbsp;<a href="../../../../../org/apache/geode/management/api/ClusterManagementOperationResult.html" title="class in org.apache.geode.management.api">ClusterManagementOperationResult</a>&lt;A,V&gt;&nbsp;start(A&nbsp;op)</pre>
 <div class="block">This method will launch a cluster management operation asynchronously.</div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>A</code> - the operation type (a subclass of <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api"><code>ClusterManagementOperation</code></a></dd>
 <dd><code>V</code> - the return type of the operation</dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>op</code> - the operation plus any parameters.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperationResult.html" title="class in org.apache.geode.management.api"><code>ClusterManagementOperationResult</code></a> holding a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> (if the
          operation was launched successfully) or an error code otherwise.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../../org/apache/geode/management/api/ClusterManagementException.html" title="class in org.apache.geode.management.api">ClusterManagementException</a></code> - if unsuccessful</dd>
 </dl>
 </li>
 </ul>
 <a name="get-org.apache.geode.management.api.ClusterManagementOperation-java.lang.String-">
 <!--   -->
 </a><a name="get-A-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>get</h4>
 <pre>&lt;A extends <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api">ClusterManagementOperation</a>&lt;V&gt;,V extends <a href="../../../../../org/apache/geode/management/runtime/OperationResult.html" title="interface in org.apache.geode.management.runtime">OperationResult</a>&gt;&nbsp;<a href="../../../../../org/apache/geode/management/api/ClusterManagementOperationResult.html" title="class in org.apache.geode.management.api">ClusterManagementOperationResult</a>&lt;A,V&gt;&nbsp;get(A&nbsp;opType,
                                                                                                               <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;opId)</pre>
 <div class="block">Returns the status of the identified operation.</div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>A</code> - the operation type (a subclass of <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api"><code>ClusterManagementOperation</code></a></dd>
 <dd><code>V</code> - the return type of the operation</dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>opType</code> - the type of the operation to get</dd>
 <dd><code>opId</code> - the operationId of a previously started operation</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the status of the identified operation</dd>
 </dl>
 </li>
 </ul>
 <a name="getFuture-org.apache.geode.management.api.ClusterManagementOperation-java.lang.String-">
 <!--   -->
 </a><a name="getFuture-A-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getFuture</h4>
 <pre>&lt;A extends <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api">ClusterManagementOperation</a>&lt;V&gt;,V extends <a href="../../../../../org/apache/geode/management/runtime/OperationResult.html" title="interface in org.apache.geode.management.runtime">OperationResult</a>&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a>&lt;<a href="../../../../../org/apache/geode/management/api/ClusterManagementOperationResult.html" title="class in org.apache.geode.management.api">ClusterManagementOperationResult</a>&lt;A,V&gt;&gt;&nbsp;getFuture(A&nbsp;opType,
                                                                                                                                        <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;opId)</pre>
 <div class="block">Returns a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> that provides a synchronous way to get the result of a
  completed operation.</div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>A</code> - the operation type (a subclass of <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api"><code>ClusterManagementOperation</code></a></dd>
 <dd><code>V</code> - the return type of the operation</dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>opType</code> - the type of the operation to get</dd>
 <dd><code>opId</code> - the operationId of a previously started operation</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the status of the identified operation</dd>
 </dl>
 </li>
 </ul>
 <a name="list-org.apache.geode.management.api.ClusterManagementOperation-">
 <!--   -->
 </a><a name="list-A-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>list</h4>
 <pre>&lt;A extends <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api">ClusterManagementOperation</a>&lt;V&gt;,V extends <a href="../../../../../org/apache/geode/management/runtime/OperationResult.html" title="interface in org.apache.geode.management.runtime">OperationResult</a>&gt;&nbsp;<a href="../../../../../org/apache/geode/management/api/ClusterManagementListOperationsResult.html" title="class in org.apache.geode.management.api">ClusterManagementListOperationsResult</a>&lt;A,V&gt;&nbsp;list(A&nbsp;opType)</pre>
 <div class="block">This method will list the status of all asynchronous cluster management operations in progress
  or recently completed.</div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>A</code> - the operation type (a subclass of <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperation.html" title="interface in org.apache.geode.management.api"><code>ClusterManagementOperation</code></a></dd>
 <dd><code>V</code> - the return type of the operation</dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>opType</code> - the operation type to list</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a list of <a href="../../../../../org/apache/geode/management/api/ClusterManagementOperationResult.html" title="class in org.apache.geode.management.api"><code>ClusterManagementOperationResult</code></a></dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../../org/apache/geode/management/api/ClusterManagementException.html" title="class in org.apache.geode.management.api">ClusterManagementException</a></code> - if unsuccessful</dd>
 </dl>
 </li>
 </ul>
 <a name="isConnected--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isConnected</h4>
 <pre>boolean&nbsp;isConnected()</pre>
 <div class="block">Test to see if this instance of ClusterManagementService retrieved from the client side is
  properly connected to the locator or not</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if connected</dd>
 </dl>
 </li>
 </ul>
 <a name="close--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>close</h4>
 <pre>void&nbsp;close()</pre>
 <div class="block">release any resources controlled by this service</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
 </a>
 <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/api/ClusterManagementResult.StatusCode.html" title="enum in org.apache.geode.management.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/apache/geode/management/api/ClusterManagementServiceTransport.html" title="interface in org.apache.geode.management.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/geode/management/api/ClusterManagementService.html" target="_top">Frames</a></li>
 <li><a href="ClusterManagementService.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>