| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>IStateManager (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/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="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IStateManager (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"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}; |
| 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"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.heron.spi.statemgr</a></div> |
| <h2 title="Interface IStateManager" class="title">Interface IStateManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code>java.lang.AutoCloseable</code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../statemgr/zookeeper/curator/CuratorStateManager.html" title="class in org.apache.heron.statemgr.zookeeper.curator">CuratorStateManager</a></code>, <code><a href="../../statemgr/FileSystemStateManager.html" title="class in org.apache.heron.statemgr">FileSystemStateManager</a></code>, <code><a href="../../statemgr/localfs/LocalFileSystemStateManager.html" title="class in org.apache.heron.statemgr.localfs">LocalFileSystemStateManager</a></code>, <code><a href="../../statemgr/NullStateManager.html" title="class in org.apache.heron.statemgr">NullStateManager</a></code></dd> |
| </dl> |
| <hr> |
| <pre><a href="../../classification/InterfaceAudience.LimitedPrivate.html" title="annotation in org.apache.heron.classification">@LimitedPrivate</a> |
| <a href="../../classification/InterfaceStability.Unstable.html" title="annotation in org.apache.heron.classification">@Unstable</a> |
| public interface <span class="typeNameLabel">IStateManager</span> |
| extends java.lang.AutoCloseable</pre> |
| <div class="block">This file defines the IStateManager interface. |
| <p> |
| Services across Heron use HeronStateMgr to get/set state information. |
| Currently the primary things kept by state are: |
| 1. Where is the the topology manager running. |
| The topology manager is responsible for writing this information out |
| upon startup. The stream managers query this upon startup to find out |
| who is their topology manager. In case they loose connection with |
| the topology manager, the stream managers query this again to see |
| if the topology manager has changed. |
| <p> |
| 2. Topology and the current running state of the topology |
| This information is seeded by the topology submitter. |
| The topology manager updates this when the state of the topology |
| changes. |
| <p> |
| 3. Current assignment. |
| This information is solely used by topology manager. When it |
| creates a new assignment or when the assignment changes, it writes |
| out this information. This is required for topology manager failover. |
| <p> |
| Clients call the methods of the state passing a callback. The callback |
| is called with result code upon the completion of the operation.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="IStateManager.LockName.html" title="enum in org.apache.heron.spi.statemgr">IStateManager.LockName</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This is to for disposing or cleaning up any internal state accumulated by |
| the StateManager</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteExecutionState(java.lang.String)">deleteExecutionState</a></span>​(java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Delete the execution state for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteLocks(java.lang.String)">deleteLocks</a></span>​(java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Delete all locks for a given topology.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteMetricsCacheLocation(java.lang.String)">deleteMetricsCacheLocation</a></span>​(java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Delete the metricscache location for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deletePackingPlan(java.lang.String)">deletePackingPlan</a></span>​(java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Delete the packing plan for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deletePhysicalPlan(java.lang.String)">deletePhysicalPlan</a></span>​(java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Delete the physical plan for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteSchedulerLocation(java.lang.String)">deleteSchedulerLocation</a></span>​(java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Delete the scheduler location for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteStatefulCheckpoints(java.lang.String)">deleteStatefulCheckpoints</a></span>​(java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Delete the stateful checkpoints for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteTManagerLocation(java.lang.String)">deleteTManagerLocation</a></span>​(java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Delete the tmanager location for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteTopology(java.lang.String)">deleteTopology</a></span>​(java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Delete the topology definition for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/system/ExecutionEnvironment.ExecutionState.html" title="class in org.apache.heron.proto.system">ExecutionEnvironment.ExecutionState</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutionState(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getExecutionState</a></span>​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the execution state for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="Lock.html" title="interface in org.apache.heron.spi.statemgr">Lock</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLock(java.lang.String,org.apache.heron.spi.statemgr.IStateManager.LockName)">getLock</a></span>​(java.lang.String topologyName, |
| <a href="IStateManager.LockName.html" title="enum in org.apache.heron.spi.statemgr">IStateManager.LockName</a> lockName)</code></th> |
| <td class="colLast"> |
| <div class="block">Return a lock object backed by the state manager store.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/tmanager/TopologyManager.MetricsCacheLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.MetricsCacheLocation</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetricsCacheLocation(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getMetricsCacheLocation</a></span>​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the MetricsCache location for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/system/PackingPlans.PackingPlan.html" title="class in org.apache.heron.proto.system">PackingPlans.PackingPlan</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPackingPlan(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getPackingPlan</a></span>​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the packing plan for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/system/PhysicalPlans.PhysicalPlan.html" title="class in org.apache.heron.proto.system">PhysicalPlans.PhysicalPlan</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPhysicalPlan(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getPhysicalPlan</a></span>​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the physical plan for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/scheduler/Scheduler.SchedulerLocation.html" title="class in org.apache.heron.proto.scheduler">Scheduler.SchedulerLocation</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSchedulerLocation(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getSchedulerLocation</a></span>​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the scheduler location for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/ckptmgr/CheckpointManager.StatefulConsistentCheckpoints.html" title="class in org.apache.heron.proto.ckptmgr">CheckpointManager.StatefulConsistentCheckpoints</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatefulCheckpoints(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getStatefulCheckpoints</a></span>​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the Stateful Checkpoints</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTManagerLocation(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getTManagerLocation</a></span>​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the tmanager location for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTopology(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getTopology</a></span>​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the topology definition for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(org.apache.heron.spi.common.Config)">initialize</a></span>​(<a href="../common/Config.html" title="class in org.apache.heron.spi.common">Config</a> config)</code></th> |
| <td class="colLast"> |
| <div class="block">Initialize StateManager with the incoming context.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTopologyRunning(java.lang.String)">isTopologyRunning</a></span>​(java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Is the given topology in RUNNING state?</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExecutionState(org.apache.heron.proto.system.ExecutionEnvironment.ExecutionState,java.lang.String)">setExecutionState</a></span>​(<a href="../../proto/system/ExecutionEnvironment.ExecutionState.html" title="class in org.apache.heron.proto.system">ExecutionEnvironment.ExecutionState</a> executionState, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the execution state for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMetricsCacheLocation(org.apache.heron.proto.tmanager.TopologyManager.MetricsCacheLocation,java.lang.String)">setMetricsCacheLocation</a></span>​(<a href="../../proto/tmanager/TopologyManager.MetricsCacheLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.MetricsCacheLocation</a> location, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the location of MetricsCache.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPackingPlan(org.apache.heron.proto.system.PackingPlans.PackingPlan,java.lang.String)">setPackingPlan</a></span>​(<a href="../../proto/system/PackingPlans.PackingPlan.html" title="class in org.apache.heron.proto.system">PackingPlans.PackingPlan</a> packingPlan, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the packing plan for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPhysicalPlan(org.apache.heron.proto.system.PhysicalPlans.PhysicalPlan,java.lang.String)">setPhysicalPlan</a></span>​(<a href="../../proto/system/PhysicalPlans.PhysicalPlan.html" title="class in org.apache.heron.proto.system">PhysicalPlans.PhysicalPlan</a> physicalPlan, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the physical plan for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSchedulerLocation(org.apache.heron.proto.scheduler.Scheduler.SchedulerLocation,java.lang.String)">setSchedulerLocation</a></span>​(<a href="../../proto/scheduler/Scheduler.SchedulerLocation.html" title="class in org.apache.heron.proto.scheduler">Scheduler.SchedulerLocation</a> location, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the scheduler location for the given topology</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStatefulCheckpoints(org.apache.heron.proto.ckptmgr.CheckpointManager.StatefulConsistentCheckpoints,java.lang.String)">setStatefulCheckpoints</a></span>​(<a href="../../proto/ckptmgr/CheckpointManager.StatefulConsistentCheckpoints.html" title="class in org.apache.heron.proto.ckptmgr">CheckpointManager.StatefulConsistentCheckpoints</a> checkpoint, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the Stateful Checkpoints</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTManagerLocation(org.apache.heron.proto.tmanager.TopologyManager.TManagerLocation,java.lang.String)">setTManagerLocation</a></span>​(<a href="../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a> location, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the location of Tmanager.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTopology(org.apache.heron.api.generated.TopologyAPI.Topology,java.lang.String)">setTopology</a></span>​(<a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the topology definition for the given topology</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="initialize(org.apache.heron.spi.common.Config)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre class="methodSignature">void initialize​(<a href="../common/Config.html" title="class in org.apache.heron.spi.common">Config</a> config)</pre> |
| <div class="block">Initialize StateManager with the incoming context.</div> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">void close()</pre> |
| <div class="block">This is to for disposing or cleaning up any internal state accumulated by |
| the StateManager |
| <p> |
| Closes this stream and releases any system resources associated |
| with it. If the stream is already closed then invoking this |
| method has no effect.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isTopologyRunning(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTopologyRunning</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> isTopologyRunning​(java.lang.String topologyName)</pre> |
| <div class="block">Is the given topology in RUNNING state?</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLock(java.lang.String,org.apache.heron.spi.statemgr.IStateManager.LockName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLock</h4> |
| <pre class="methodSignature"><a href="Lock.html" title="interface in org.apache.heron.spi.statemgr">Lock</a> getLock​(java.lang.String topologyName, |
| <a href="IStateManager.LockName.html" title="enum in org.apache.heron.spi.statemgr">IStateManager.LockName</a> lockName)</pre> |
| <div class="block">Return a lock object backed by the state manager store.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topologyName</code> - the name of the topology</dd> |
| <dd><code>lockName</code> - any thread may get the <code>Lock</code> object bound to a given name, but only one |
| thread may obtain the actual lock from that @{code Lock} object.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an object representing an implementation of a lock.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteLocks(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteLocks</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> deleteLocks​(java.lang.String topologyName)</pre> |
| <div class="block">Delete all locks for a given topology. Ideally locks should be deleted when released but it's |
| possible that some state systems (e.g., ZooKeeper) will not delete all resources when a lock is |
| released. This method should be invoked to clean all such lock resources.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTManagerLocation(org.apache.heron.proto.tmanager.TopologyManager.TManagerLocation,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTManagerLocation</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> setTManagerLocation​(<a href="../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a> location, |
| java.lang.String topologyName)</pre> |
| <div class="block">Set the location of Tmanager.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTManagerLocation(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTManagerLocation</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a>> getTManagerLocation​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</pre> |
| <div class="block">Get the tmanager location for the given topology</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>watcher</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>TManagerLocation</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr"><code>WatchCallback</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteTManagerLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteTManagerLocation</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> deleteTManagerLocation​(java.lang.String topologyName)</pre> |
| <div class="block">Delete the tmanager location for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMetricsCacheLocation(org.apache.heron.proto.tmanager.TopologyManager.MetricsCacheLocation,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMetricsCacheLocation</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> setMetricsCacheLocation​(<a href="../../proto/tmanager/TopologyManager.MetricsCacheLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.MetricsCacheLocation</a> location, |
| java.lang.String topologyName)</pre> |
| <div class="block">Set the location of MetricsCache.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMetricsCacheLocation(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetricsCacheLocation</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/tmanager/TopologyManager.MetricsCacheLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.MetricsCacheLocation</a>> getMetricsCacheLocation​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</pre> |
| <div class="block">Get the MetricsCache location for the given topology</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>watcher</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>TManagerLocation</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr"><code>WatchCallback</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteMetricsCacheLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteMetricsCacheLocation</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> deleteMetricsCacheLocation​(java.lang.String topologyName)</pre> |
| <div class="block">Delete the metricscache location for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTopology(org.apache.heron.api.generated.TopologyAPI.Topology,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTopology</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> setTopology​(<a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology, |
| java.lang.String topologyName)</pre> |
| <div class="block">Set the topology definition for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTopology(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTopology</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<<a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a>> getTopology​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</pre> |
| <div class="block">Get the topology definition for the given topology</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>watcher</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Topology</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr"><code>WatchCallback</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteTopology(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteTopology</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> deleteTopology​(java.lang.String topologyName)</pre> |
| <div class="block">Delete the topology definition for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPackingPlan(org.apache.heron.proto.system.PackingPlans.PackingPlan,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPackingPlan</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> setPackingPlan​(<a href="../../proto/system/PackingPlans.PackingPlan.html" title="class in org.apache.heron.proto.system">PackingPlans.PackingPlan</a> packingPlan, |
| java.lang.String topologyName)</pre> |
| <div class="block">Set the packing plan for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPackingPlan(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPackingPlan</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/system/PackingPlans.PackingPlan.html" title="class in org.apache.heron.proto.system">PackingPlans.PackingPlan</a>> getPackingPlan​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</pre> |
| <div class="block">Get the packing plan for the given topology</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>watcher</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PackingPlan</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr"><code>WatchCallback</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deletePackingPlan(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deletePackingPlan</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> deletePackingPlan​(java.lang.String topologyName)</pre> |
| <div class="block">Delete the packing plan for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPhysicalPlan(org.apache.heron.proto.system.PhysicalPlans.PhysicalPlan,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPhysicalPlan</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> setPhysicalPlan​(<a href="../../proto/system/PhysicalPlans.PhysicalPlan.html" title="class in org.apache.heron.proto.system">PhysicalPlans.PhysicalPlan</a> physicalPlan, |
| java.lang.String topologyName)</pre> |
| <div class="block">Set the physical plan for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPhysicalPlan(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPhysicalPlan</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/system/PhysicalPlans.PhysicalPlan.html" title="class in org.apache.heron.proto.system">PhysicalPlans.PhysicalPlan</a>> getPhysicalPlan​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</pre> |
| <div class="block">Get the physical plan for the given topology</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>watcher</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PhysicalPlan</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr"><code>WatchCallback</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deletePhysicalPlan(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deletePhysicalPlan</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> deletePhysicalPlan​(java.lang.String topologyName)</pre> |
| <div class="block">Delete the physical plan for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setExecutionState(org.apache.heron.proto.system.ExecutionEnvironment.ExecutionState,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExecutionState</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> setExecutionState​(<a href="../../proto/system/ExecutionEnvironment.ExecutionState.html" title="class in org.apache.heron.proto.system">ExecutionEnvironment.ExecutionState</a> executionState, |
| java.lang.String topologyName)</pre> |
| <div class="block">Set the execution state for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExecutionState(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutionState</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/system/ExecutionEnvironment.ExecutionState.html" title="class in org.apache.heron.proto.system">ExecutionEnvironment.ExecutionState</a>> getExecutionState​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</pre> |
| <div class="block">Get the execution state for the given topology</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>watcher</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ExecutionState</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr"><code>WatchCallback</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteExecutionState(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteExecutionState</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> deleteExecutionState​(java.lang.String topologyName)</pre> |
| <div class="block">Delete the execution state for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSchedulerLocation(org.apache.heron.proto.scheduler.Scheduler.SchedulerLocation,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchedulerLocation</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> setSchedulerLocation​(<a href="../../proto/scheduler/Scheduler.SchedulerLocation.html" title="class in org.apache.heron.proto.scheduler">Scheduler.SchedulerLocation</a> location, |
| java.lang.String topologyName)</pre> |
| <div class="block">Set the scheduler location for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSchedulerLocation(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchedulerLocation</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/scheduler/Scheduler.SchedulerLocation.html" title="class in org.apache.heron.proto.scheduler">Scheduler.SchedulerLocation</a>> getSchedulerLocation​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</pre> |
| <div class="block">Get the scheduler location for the given topology</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>watcher</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SchedulerLocation</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr"><code>WatchCallback</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteSchedulerLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteSchedulerLocation</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> deleteSchedulerLocation​(java.lang.String topologyName)</pre> |
| <div class="block">Delete the scheduler location for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setStatefulCheckpoints(org.apache.heron.proto.ckptmgr.CheckpointManager.StatefulConsistentCheckpoints,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStatefulCheckpoints</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> setStatefulCheckpoints​(<a href="../../proto/ckptmgr/CheckpointManager.StatefulConsistentCheckpoints.html" title="class in org.apache.heron.proto.ckptmgr">CheckpointManager.StatefulConsistentCheckpoints</a> checkpoint, |
| java.lang.String topologyName)</pre> |
| <div class="block">Set the Stateful Checkpoints</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStatefulCheckpoints(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatefulCheckpoints</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<<a href="../../proto/ckptmgr/CheckpointManager.StatefulConsistentCheckpoints.html" title="class in org.apache.heron.proto.ckptmgr">CheckpointManager.StatefulConsistentCheckpoints</a>> getStatefulCheckpoints​(<a href="WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a> watcher, |
| java.lang.String topologyName)</pre> |
| <div class="block">Get the Stateful Checkpoints</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteStatefulCheckpoints(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>deleteStatefulCheckpoints</h4> |
| <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> deleteStatefulCheckpoints​(java.lang.String topologyName)</pre> |
| <div class="block">Delete the stateful checkpoints for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
