| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>SchedulerStateManagerAdaptor (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="SchedulerStateManagerAdaptor (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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="Class SchedulerStateManagerAdaptor" class="title">Class SchedulerStateManagerAdaptor</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.spi.statemgr.SchedulerStateManagerAdaptor</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">SchedulerStateManagerAdaptor</span> |
| extends java.lang.Object</pre> |
| <div class="block">This file provides a Adaptor for Scheduler. |
| It provides only the methods needed for Scheduler, |
| and provides easier interfaces to invoke in Scheduler.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.heron.spi.statemgr.IStateManager,int)">SchedulerStateManagerAdaptor</a></span>​(<a href="IStateManager.html" title="interface in org.apache.heron.spi.statemgr">IStateManager</a> delegate, |
| int timeout)</code></th> |
| <td class="colLast"> |
| <div class="block">Construct SchedulerStateManagerAdaptor providing only the |
| interfaces used by scheduler.</div> |
| </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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>protected <V> V</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#awaitResult(com.google.common.util.concurrent.ListenableFuture)">awaitResult</a></span>​(com.google.common.util.concurrent.ListenableFuture<V> future)</code></th> |
| <td class="colLast"> |
| <div class="block">Waits for ListenableFuture to terminate.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected <V> V</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#awaitResult(com.google.common.util.concurrent.ListenableFuture,int,java.util.concurrent.TimeUnit)">awaitResult</a></span>​(com.google.common.util.concurrent.ListenableFuture<V> future, |
| int time, |
| java.util.concurrent.TimeUnit unit)</code></th> |
| <td class="colLast"> |
| <div class="block">Waits for ListenableFuture to terminate.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>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="i3" class="rowColor"> |
| <td class="colFirst"><code>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"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>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="i5" class="rowColor"> |
| <td class="colFirst"><code>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="i6" class="altColor"> |
| <td class="colFirst"><code>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="i7" class="rowColor"> |
| <td class="colFirst"><code>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="i8" class="altColor"> |
| <td class="colFirst"><code>java.lang.Boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteStatefulCheckpoint(java.lang.String)">deleteStatefulCheckpoint</a></span>​(java.lang.String topologyName)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>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="i10" class="altColor"> |
| <td class="colFirst"><code>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="i11" class="rowColor"> |
| <td class="colFirst"><code><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(java.lang.String)">getExecutionState</a></span>​(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="i12" class="altColor"> |
| <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"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><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(java.lang.String)">getMetricsCacheLocation</a></span>​(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="i14" class="altColor"> |
| <td class="colFirst"><code><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(java.lang.String)">getPackingPlan</a></span>​(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="i15" class="rowColor"> |
| <td class="colFirst"><code><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(java.lang.String)">getPhysicalPlan</a></span>​(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="i16" class="altColor"> |
| <td class="colFirst"><code><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(java.lang.String)">getSchedulerLocation</a></span>​(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="i17" class="rowColor"> |
| <td class="colFirst"><code><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(java.lang.String)">getTManagerLocation</a></span>​(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><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(java.lang.String)">getTopology</a></span>​(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>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="i20" class="altColor"> |
| <td class="colFirst"><code>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="i21" class="rowColor"> |
| <td class="colFirst"><code>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="i22" class="altColor"> |
| <td class="colFirst"><code>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="i23" class="rowColor"> |
| <td class="colFirst"><code>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> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>java.lang.Boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updatePackingPlan(org.apache.heron.proto.system.PackingPlans.PackingPlan,java.lang.String)">updatePackingPlan</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">Update the packing plan for the given topology.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateTopology(org.apache.heron.api.generated.TopologyAPI.Topology,java.lang.String)">updateTopology</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">Update the topology definition for the given topology.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.heron.spi.statemgr.IStateManager,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SchedulerStateManagerAdaptor</h4> |
| <pre>public SchedulerStateManagerAdaptor​(<a href="IStateManager.html" title="interface in org.apache.heron.spi.statemgr">IStateManager</a> delegate, |
| int timeout)</pre> |
| <div class="block">Construct SchedulerStateManagerAdaptor providing only the |
| interfaces used by scheduler.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delegate</code> - an instance of IStateManager that is already initialized. |
| Noticed that the initialize and close of IStateManager is not in the |
| SchedulerStateManager. Users are restricted from using those interfaces |
| since it is upto the abstract scheduler to decide when to open and close.</dd> |
| <dd><code>timeout</code> - the maximum time to wait in milliseconds</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="awaitResult(com.google.common.util.concurrent.ListenableFuture)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>awaitResult</h4> |
| <pre class="methodSignature">protected <V> V awaitResult​(com.google.common.util.concurrent.ListenableFuture<V> future)</pre> |
| <div class="block">Waits for ListenableFuture to terminate. Cancels on timeout</div> |
| </li> |
| </ul> |
| <a id="awaitResult(com.google.common.util.concurrent.ListenableFuture,int,java.util.concurrent.TimeUnit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>awaitResult</h4> |
| <pre class="methodSignature">protected <V> V awaitResult​(com.google.common.util.concurrent.ListenableFuture<V> future, |
| int time, |
| java.util.concurrent.TimeUnit unit)</pre> |
| <div class="block">Waits for ListenableFuture to terminate. Cancels on timeout</div> |
| </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">public <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> |
| </li> |
| </ul> |
| <a id="isTopologyRunning(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTopologyRunning</h4> |
| <pre class="methodSignature">public 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="setExecutionState(org.apache.heron.proto.system.ExecutionEnvironment.ExecutionState,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExecutionState</h4> |
| <pre class="methodSignature">public 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="setTopology(org.apache.heron.api.generated.TopologyAPI.Topology,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTopology</h4> |
| <pre class="methodSignature">public 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="paramLabel">Parameters:</span></dt> |
| <dd><code>topologyName</code> - the name of the topology</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="updateTopology(org.apache.heron.api.generated.TopologyAPI.Topology,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateTopology</h4> |
| <pre class="methodSignature">public java.lang.Boolean updateTopology​(<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">Update the topology definition for the given topology. If the topology doesn't exist, |
| create it. If it does, update it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topologyName</code> - the name of the topology</dd> |
| <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">public 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="setPackingPlan(org.apache.heron.proto.system.PackingPlans.PackingPlan,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPackingPlan</h4> |
| <pre class="methodSignature">public 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="paramLabel">Parameters:</span></dt> |
| <dd><code>packingPlan</code> - the packing plan of the topology</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="updatePackingPlan(org.apache.heron.proto.system.PackingPlans.PackingPlan,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updatePackingPlan</h4> |
| <pre class="methodSignature">public java.lang.Boolean updatePackingPlan​(<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">Update the packing plan for the given topology. If the packing plan doesn't exist, create it. |
| If it does, update it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>packingPlan</code> - the packing plan of the topology</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean - Success or Failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteTManagerLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteTManagerLocation</h4> |
| <pre class="methodSignature">public 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="deleteMetricsCacheLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteMetricsCacheLocation</h4> |
| <pre class="methodSignature">public 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="deleteExecutionState(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteExecutionState</h4> |
| <pre class="methodSignature">public 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="deleteTopology(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteTopology</h4> |
| <pre class="methodSignature">public 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="deletePackingPlan(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deletePackingPlan</h4> |
| <pre class="methodSignature">public 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="deletePhysicalPlan(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deletePhysicalPlan</h4> |
| <pre class="methodSignature">public 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="deleteSchedulerLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteSchedulerLocation</h4> |
| <pre class="methodSignature">public 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="deleteLocks(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteLocks</h4> |
| <pre class="methodSignature">public java.lang.Boolean deleteLocks​(java.lang.String topologyName)</pre> |
| </li> |
| </ul> |
| <a id="deleteStatefulCheckpoint(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteStatefulCheckpoint</h4> |
| <pre class="methodSignature">public java.lang.Boolean deleteStatefulCheckpoint​(java.lang.String topologyName)</pre> |
| </li> |
| </ul> |
| <a id="getTManagerLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTManagerLocation</h4> |
| <pre class="methodSignature">public <a href="../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a> getTManagerLocation​(java.lang.String topologyName)</pre> |
| <div class="block">Get the tmanager location for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>TManagerLocation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSchedulerLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchedulerLocation</h4> |
| <pre class="methodSignature">public <a href="../../proto/scheduler/Scheduler.SchedulerLocation.html" title="class in org.apache.heron.proto.scheduler">Scheduler.SchedulerLocation</a> getSchedulerLocation​(java.lang.String topologyName)</pre> |
| <div class="block">Get the scheduler location for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SchedulerLocation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMetricsCacheLocation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetricsCacheLocation</h4> |
| <pre class="methodSignature">public <a href="../../proto/tmanager/TopologyManager.MetricsCacheLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.MetricsCacheLocation</a> getMetricsCacheLocation​(java.lang.String topologyName)</pre> |
| <div class="block">Get the metricscache location for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>MetricsCacheLocation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTopology(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTopology</h4> |
| <pre class="methodSignature">public <a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> getTopology​(java.lang.String topologyName)</pre> |
| <div class="block">Get the topology definition for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Topology</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExecutionState(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutionState</h4> |
| <pre class="methodSignature">public <a href="../../proto/system/ExecutionEnvironment.ExecutionState.html" title="class in org.apache.heron.proto.system">ExecutionEnvironment.ExecutionState</a> getExecutionState​(java.lang.String topologyName)</pre> |
| <div class="block">Get the execution state for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ExecutionState</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPhysicalPlan(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPhysicalPlan</h4> |
| <pre class="methodSignature">public <a href="../../proto/system/PhysicalPlans.PhysicalPlan.html" title="class in org.apache.heron.proto.system">PhysicalPlans.PhysicalPlan</a> getPhysicalPlan​(java.lang.String topologyName)</pre> |
| <div class="block">Get the physical plan for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PhysicalPlans.PhysicalPlan</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPackingPlan(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getPackingPlan</h4> |
| <pre class="methodSignature">public <a href="../../proto/system/PackingPlans.PackingPlan.html" title="class in org.apache.heron.proto.system">PackingPlans.PackingPlan</a> getPackingPlan​(java.lang.String topologyName)</pre> |
| <div class="block">Get the packing plan for the given topology</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>PackingPlans.PackingPlan</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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
