blob: 4ff73004eeba4d301b7a597be3b37b13fa6fa800 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>ILocalCluster (Storm 2.6.2 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.storm, interface: ILocalCluster">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/ILocalCluster.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.storm</a></div>
<h1 title="Interface ILocalCluster" class="title">Interface ILocalCluster</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="ILocalClusterTrackedTopologyAware.html" title="interface in org.apache.storm">ILocalClusterTrackedTopologyAware</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="LocalCluster.html" title="class in org.apache.storm">LocalCluster</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ILocalCluster</span><span class="extends-implements">
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></span></div>
<div class="block">This is here mostly for backwards compatibility.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Interface</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="ILocalCluster.ILocalTopology.html" class="type-name-link" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></code></div>
<div class="col-last even-row-color">
<div class="block">Close this class to kill the topology.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#activate(java.lang.String)" class="member-name-link">activate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Activate a topology.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#advanceClusterTime(int)" class="member-name-link">advanceClusterTime</a><wbr>(int&nbsp;secs)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Advance the cluster time when the cluster is using SimulatedTime.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#advanceClusterTime(int,int)" class="member-name-link">advanceClusterTime</a><wbr>(int&nbsp;secs,
int&nbsp;steps)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Advance the cluster time when the cluster is using SimulatedTime.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#deactivate(java.lang.String)" class="member-name-link">deactivate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Deactivate a topology.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="generated/ClusterSummary.html" title="class in org.apache.storm.generated">ClusterSummary</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getClusterInfo()" class="member-name-link">getClusterInfo</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get cluster information.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="cluster/IStormClusterState.html" title="interface in org.apache.storm.cluster">IStormClusterState</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getClusterState()" class="member-name-link">getClusterState</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">This is intended for internal testing only.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTopology(java.lang.String)" class="member-name-link">getTopology</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the compiled storm topology.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTopologyConf(java.lang.String)" class="member-name-link">getTopologyConf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">The config of a topology as a JSON string.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="generated/TopologyInfo.html" title="class in org.apache.storm.generated">TopologyInfo</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTopologyInfo(java.lang.String)" class="member-name-link">getTopologyInfo</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the state of a topology.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="generated/TopologyInfo.html" title="class in org.apache.storm.generated">TopologyInfo</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTopologyInfoByName(java.lang.String)" class="member-name-link">getTopologyInfoByName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the state of a topology.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="generated/TopologyInfo.html" title="class in org.apache.storm.generated">TopologyInfo</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTopologyInfoByNameWithOpts(java.lang.String,org.apache.storm.generated.GetInfoOptions)" class="member-name-link">getTopologyInfoByNameWithOpts</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="generated/GetInfoOptions.html" title="class in org.apache.storm.generated">GetInfoOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the state of a topology.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="generated/TopologyInfo.html" title="class in org.apache.storm.generated">TopologyInfo</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTopologyInfoWithOpts(java.lang.String,org.apache.storm.generated.GetInfoOptions)" class="member-name-link">getTopologyInfoWithOpts</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
<a href="generated/GetInfoOptions.html" title="class in org.apache.storm.generated">GetInfoOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the state of a topology.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="generated/TopologySummary.html" title="class in org.apache.storm.generated">TopologySummary</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTopologySummaries()" class="member-name-link">getTopologySummaries</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="generated/TopologySummary.html" title="class in org.apache.storm.generated">TopologySummary</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTopologySummary(java.lang.String)" class="member-name-link">getTopologySummary</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="generated/TopologySummary.html" title="class in org.apache.storm.generated">TopologySummary</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTopologySummaryByName(java.lang.String)" class="member-name-link">getTopologySummaryByName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTrackedId()" class="member-name-link">getTrackedId</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">If the cluster is tracked get the id for the tracked cluster.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#killTopology(java.lang.String)" class="member-name-link">killTopology</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Kill a topology (if you are not using ILocalTopology).</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#killTopologyWithOpts(java.lang.String,org.apache.storm.generated.KillOptions)" class="member-name-link">killTopologyWithOpts</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName,
<a href="generated/KillOptions.html" title="class in org.apache.storm.generated">KillOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Kill a topology (if you are not using ILocalTopology).</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#rebalance(java.lang.String,org.apache.storm.generated.RebalanceOptions)" class="member-name-link">rebalance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="generated/RebalanceOptions.html" title="class in org.apache.storm.generated">RebalanceOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Rebalance a topology.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#shutdown()" class="member-name-link">shutdown</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link"><code>AutoCloseable.close()</code></a> instead.</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ILocalCluster.ILocalTopology.html" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#submitTopology(java.lang.String,java.util.Map,org.apache.storm.generated.StormTopology)" class="member-name-link">submitTopology</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;conf,
<a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>&nbsp;topology)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Submit a topology to be run in local mode.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ILocalCluster.ILocalTopology.html" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#submitTopologyWithOpts(java.lang.String,java.util.Map,org.apache.storm.generated.StormTopology,org.apache.storm.generated.SubmitOptions)" class="member-name-link">submitTopologyWithOpts</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;conf,
<a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>&nbsp;topology,
<a href="generated/SubmitOptions.html" title="class in org.apache.storm.generated">SubmitOptions</a>&nbsp;submitOpts)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Submit a topology to be run in local mode.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#uploadNewCredentials(java.lang.String,org.apache.storm.generated.Credentials)" class="member-name-link">uploadNewCredentials</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName,
<a href="generated/Credentials.html" title="class in org.apache.storm.generated">Credentials</a>&nbsp;creds)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Upload new credentials to a topology.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.AutoCloseable">Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="submitTopology(java.lang.String,java.util.Map,org.apache.storm.generated.StormTopology)">
<h3>submitTopology</h3>
<div class="member-signature"><span class="return-type"><a href="ILocalCluster.ILocalTopology.html" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></span>&nbsp;<span class="element-name">submitTopology</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;conf,
<a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>&nbsp;topology)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Submit a topology to be run in local mode.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>topologyName</code> - the name of the topology to use</dd>
<dd><code>conf</code> - the config for the topology</dd>
<dd><code>topology</code> - the topology itself.</dd>
<dt>Returns:</dt>
<dd>an AutoCloseable that will kill the topology.</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="submitTopologyWithOpts(java.lang.String,java.util.Map,org.apache.storm.generated.StormTopology,org.apache.storm.generated.SubmitOptions)">
<h3>submitTopologyWithOpts</h3>
<div class="member-signature"><span class="return-type"><a href="ILocalCluster.ILocalTopology.html" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></span>&nbsp;<span class="element-name">submitTopologyWithOpts</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;conf,
<a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>&nbsp;topology,
<a href="generated/SubmitOptions.html" title="class in org.apache.storm.generated">SubmitOptions</a>&nbsp;submitOpts)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Submit a topology to be run in local mode.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>topologyName</code> - the name of the topology to use</dd>
<dd><code>conf</code> - the config for the topology</dd>
<dd><code>topology</code> - the topology itself.</dd>
<dd><code>submitOpts</code> - options for topology</dd>
<dt>Returns:</dt>
<dd>an AutoCloseable that will kill the topology.</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="uploadNewCredentials(java.lang.String,org.apache.storm.generated.Credentials)">
<h3>uploadNewCredentials</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">uploadNewCredentials</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName,
<a href="generated/Credentials.html" title="class in org.apache.storm.generated">Credentials</a>&nbsp;creds)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Upload new credentials to a topology.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>topologyName</code> - the name of the topology</dd>
<dd><code>creds</code> - the new credentails for the topology.</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="killTopology(java.lang.String)">
<h3>killTopology</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">killTopology</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Kill a topology (if you are not using ILocalTopology).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>topologyName</code> - the name of the topology</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="killTopologyWithOpts(java.lang.String,org.apache.storm.generated.KillOptions)">
<h3>killTopologyWithOpts</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">killTopologyWithOpts</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName,
<a href="generated/KillOptions.html" title="class in org.apache.storm.generated">KillOptions</a>&nbsp;options)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Kill a topology (if you are not using ILocalTopology).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>topologyName</code> - the name of the topology</dd>
<dd><code>options</code> - for how to kill the topology</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="activate(java.lang.String)">
<h3>activate</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">activate</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Activate a topology.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>topologyName</code> - the name of the topology to activate</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="deactivate(java.lang.String)">
<h3>deactivate</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">deactivate</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;topologyName)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Deactivate a topology.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>topologyName</code> - the name of the topology to deactivate</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="rebalance(java.lang.String,org.apache.storm.generated.RebalanceOptions)">
<h3>rebalance</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">rebalance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="generated/RebalanceOptions.html" title="class in org.apache.storm.generated">RebalanceOptions</a>&nbsp;options)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Rebalance a topology.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the topology</dd>
<dd><code>options</code> - options for rebalanceing the topology.</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="shutdown()">
<h3>shutdown</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="return-type">void</span>&nbsp;<span class="element-name">shutdown</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link"><code>AutoCloseable.close()</code></a> instead.</div>
</div>
<div class="block">Shut down the cluster.</div>
</section>
</li>
<li>
<section class="detail" id="getTopologyConf(java.lang.String)">
<h3>getTopologyConf</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getTopologyConf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">The config of a topology as a JSON string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - the id of the topology (not the name)</dd>
<dt>Returns:</dt>
<dd>The config of a topology as a JSON string</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTopology(java.lang.String)">
<h3>getTopology</h3>
<div class="member-signature"><span class="return-type"><a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a></span>&nbsp;<span class="element-name">getTopology</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Get the compiled storm topology.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - the id of the topology (not the name)</dd>
<dt>Returns:</dt>
<dd>the compiled storm topology</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getClusterInfo()">
<h3>getClusterInfo</h3>
<div class="member-signature"><span class="return-type"><a href="generated/ClusterSummary.html" title="class in org.apache.storm.generated">ClusterSummary</a></span>&nbsp;<span class="element-name">getClusterInfo</span>()
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Get cluster information.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>a summary of the current state of the cluster</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTopologySummaries()">
<h3>getTopologySummaries</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="generated/TopologySummary.html" title="class in org.apache.storm.generated">TopologySummary</a>&gt;</span>&nbsp;<span class="element-name">getTopologySummaries</span>()
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTopologySummaryByName(java.lang.String)">
<h3>getTopologySummaryByName</h3>
<div class="member-signature"><span class="return-type"><a href="generated/TopologySummary.html" title="class in org.apache.storm.generated">TopologySummary</a></span>&nbsp;<span class="element-name">getTopologySummaryByName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTopologySummary(java.lang.String)">
<h3>getTopologySummary</h3>
<div class="member-signature"><span class="return-type"><a href="generated/TopologySummary.html" title="class in org.apache.storm.generated">TopologySummary</a></span>&nbsp;<span class="element-name">getTopologySummary</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTopologyInfo(java.lang.String)">
<h3>getTopologyInfo</h3>
<div class="member-signature"><span class="return-type"><a href="generated/TopologyInfo.html" title="class in org.apache.storm.generated">TopologyInfo</a></span>&nbsp;<span class="element-name">getTopologyInfo</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Get the state of a topology.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - the id of the topology (not the name)</dd>
<dt>Returns:</dt>
<dd>the state of a topology</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTopologyInfoByName(java.lang.String)">
<h3>getTopologyInfoByName</h3>
<div class="member-signature"><span class="return-type"><a href="generated/TopologyInfo.html" title="class in org.apache.storm.generated">TopologyInfo</a></span>&nbsp;<span class="element-name">getTopologyInfoByName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Get the state of a topology.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the topology (not the id)</dd>
<dt>Returns:</dt>
<dd>the state of a topology</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTopologyInfoWithOpts(java.lang.String,org.apache.storm.generated.GetInfoOptions)">
<h3>getTopologyInfoWithOpts</h3>
<div class="member-signature"><span class="return-type"><a href="generated/TopologyInfo.html" title="class in org.apache.storm.generated">TopologyInfo</a></span>&nbsp;<span class="element-name">getTopologyInfoWithOpts</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
<a href="generated/GetInfoOptions.html" title="class in org.apache.storm.generated">GetInfoOptions</a>&nbsp;options)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Get the state of a topology.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - the id of the topology (not the name)</dd>
<dd><code>options</code> - This is to choose number of Error(s) in TopologyInfo.</dd>
<dt>Returns:</dt>
<dd>the state of a topology</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTopologyInfoByNameWithOpts(java.lang.String,org.apache.storm.generated.GetInfoOptions)">
<h3>getTopologyInfoByNameWithOpts</h3>
<div class="member-signature"><span class="return-type"><a href="generated/TopologyInfo.html" title="class in org.apache.storm.generated">TopologyInfo</a></span>&nbsp;<span class="element-name">getTopologyInfoByNameWithOpts</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="generated/GetInfoOptions.html" title="class in org.apache.storm.generated">GetInfoOptions</a>&nbsp;options)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Get the state of a topology.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the topology (not the id)</dd>
<dd><code>options</code> - This is GetInfoOptions to choose Error(s) in on TopologyInfo.</dd>
<dt>Returns:</dt>
<dd>the state of a topology</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getClusterState()">
<h3>getClusterState</h3>
<div class="member-signature"><span class="return-type"><a href="cluster/IStormClusterState.html" title="interface in org.apache.storm.cluster">IStormClusterState</a></span>&nbsp;<span class="element-name">getClusterState</span>()</div>
<div class="block">This is intended for internal testing only.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>an internal class that holds the state of the cluster.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="advanceClusterTime(int)">
<h3>advanceClusterTime</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">advanceClusterTime</span><wbr><span class="parameters">(int&nbsp;secs)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div>
<div class="block">Advance the cluster time when the cluster is using SimulatedTime. This is intended for internal testing only.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>secs</code> - the number of seconds to advance time</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="advanceClusterTime(int,int)">
<h3>advanceClusterTime</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">advanceClusterTime</span><wbr><span class="parameters">(int&nbsp;secs,
int&nbsp;steps)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div>
<div class="block">Advance the cluster time when the cluster is using SimulatedTime. This is intended for internal testing only.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>secs</code> - the number of seconds to advance time</dd>
<dd><code>steps</code> - the number of steps we should take when advancing simulated time</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTrackedId()">
<h3>getTrackedId</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getTrackedId</span>()</div>
<div class="block">If the cluster is tracked get the id for the tracked cluster. This is intended for internal testing only.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the id of the tracked cluster</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>