| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>IScheduler (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="IScheduler (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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>Nested | </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.scheduler</a></div> |
| <h2 title="Interface IScheduler" class="title">Interface IScheduler</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="../../scheduler/aurora/AuroraScheduler.html" title="class in org.apache.heron.scheduler.aurora">AuroraScheduler</a></code>, <code><a href="../../scheduler/kubernetes/KubernetesScheduler.html" title="class in org.apache.heron.scheduler.kubernetes">KubernetesScheduler</a></code>, <code><a href="../../scheduler/local/LocalScheduler.html" title="class in org.apache.heron.scheduler.local">LocalScheduler</a></code>, <code><a href="../../scheduler/marathon/MarathonScheduler.html" title="class in org.apache.heron.scheduler.marathon">MarathonScheduler</a></code>, <code><a href="../../scheduler/mesos/MesosScheduler.html" title="class in org.apache.heron.scheduler.mesos">MesosScheduler</a></code>, <code><a href="../../scheduler/nomad/NomadScheduler.html" title="class in org.apache.heron.scheduler.nomad">NomadScheduler</a></code>, <code><a href="../../scheduler/NullScheduler.html" title="class in org.apache.heron.scheduler">NullScheduler</a></code>, <code><a href="../../scheduler/slurm/SlurmScheduler.html" title="class in org.apache.heron.scheduler.slurm">SlurmScheduler</a></code>, <code><a href="../../scheduler/yarn/YarnScheduler.html" title="class in org.apache.heron.scheduler.yarn">YarnScheduler</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.Evolving.html" title="annotation in org.apache.heron.classification">@Evolving</a> |
| public interface <span class="typeNameLabel">IScheduler</span> |
| extends java.lang.AutoCloseable</pre> |
| <div class="block">Scheduler object responsible for bringing up topology. Will be instantiated using no-arg |
| constructor.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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 scheduler</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJobLinks()">getJobLinks</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This method will be called after onScheduler |
| It is responsible to return links to topology's customized ui pages.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <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,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, |
| <a href="../common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime)</code></th> |
| <td class="colLast"> |
| <div class="block">This will initialize scheduler using config file.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onKill(org.apache.heron.proto.scheduler.Scheduler.KillTopologyRequest)">onKill</a></span>​(<a href="../../proto/scheduler/Scheduler.KillTopologyRequest.html" title="class in org.apache.heron.proto.scheduler">Scheduler.KillTopologyRequest</a> request)</code></th> |
| <td class="colLast"> |
| <div class="block">Called by SchedulerServer when it receives a http request to kill topology, |
| while the http request body would be the protobuf Scheduler.KillTopologyRequest.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onRestart(org.apache.heron.proto.scheduler.Scheduler.RestartTopologyRequest)">onRestart</a></span>​(<a href="../../proto/scheduler/Scheduler.RestartTopologyRequest.html" title="class in org.apache.heron.proto.scheduler">Scheduler.RestartTopologyRequest</a> request)</code></th> |
| <td class="colLast"> |
| <div class="block">Called by SchedulerServer when it receives a http request to restart topology, |
| while the http request body would be the protobuf Scheduler.RestartTopologyRequest.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onSchedule(org.apache.heron.spi.packing.PackingPlan)">onSchedule</a></span>​(<a href="../packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a> packing)</code></th> |
| <td class="colLast"> |
| <div class="block">This method will be called after initialize.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onUpdate(org.apache.heron.proto.scheduler.Scheduler.UpdateTopologyRequest)">onUpdate</a></span>​(<a href="../../proto/scheduler/Scheduler.UpdateTopologyRequest.html" title="class in org.apache.heron.proto.scheduler">Scheduler.UpdateTopologyRequest</a> request)</code></th> |
| <td class="colLast"> |
| <div class="block">Called by SchedulerServer when it receives a http request to update topology, |
| while the http request body would be the protobuf Scheduler.UpdateTopologyRequest.</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,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, |
| <a href="../common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime)</pre> |
| <div class="block">This will initialize scheduler using config file. Will be called during start.</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 scheduler |
| <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="onSchedule(org.apache.heron.spi.packing.PackingPlan)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onSchedule</h4> |
| <pre class="methodSignature">boolean onSchedule​(<a href="../packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a> packing)</pre> |
| <div class="block">This method will be called after initialize. |
| It is responsible for grabbing resource to launch executor and make sure they |
| get launched. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>packing</code> - Initial mapping suggested by running packing algorithm.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getJobLinks()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJobLinks</h4> |
| <pre class="methodSignature">java.util.List<java.lang.String> getJobLinks()</pre> |
| <div class="block">This method will be called after onScheduler |
| It is responsible to return links to topology's customized ui pages. |
| Example: link to the Mesos Slave UI page displaying all scheduled containers</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the links if any customized page. It returns an empty list if no any links</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onKill(org.apache.heron.proto.scheduler.Scheduler.KillTopologyRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onKill</h4> |
| <pre class="methodSignature">boolean onKill​(<a href="../../proto/scheduler/Scheduler.KillTopologyRequest.html" title="class in org.apache.heron.proto.scheduler">Scheduler.KillTopologyRequest</a> request)</pre> |
| <div class="block">Called by SchedulerServer when it receives a http request to kill topology, |
| while the http request body would be the protobuf Scheduler.KillTopologyRequest. |
| The SchedulerServer would parse the request body and feed with this method. |
| It would be invoked in the executors of SchedulerServer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The KillTopologyRequest sent from local heron-cli</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the IScheduler kills the topology successfully. SchedulerServer would |
| send KillTopologyResponse correspondingly according to this method's return value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onRestart(org.apache.heron.proto.scheduler.Scheduler.RestartTopologyRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onRestart</h4> |
| <pre class="methodSignature">boolean onRestart​(<a href="../../proto/scheduler/Scheduler.RestartTopologyRequest.html" title="class in org.apache.heron.proto.scheduler">Scheduler.RestartTopologyRequest</a> request)</pre> |
| <div class="block">Called by SchedulerServer when it receives a http request to restart topology, |
| while the http request body would be the protobuf Scheduler.RestartTopologyRequest. |
| The SchedulerServer would parse the request body and feed with this method. |
| It would be invoked in the executors of SchedulerServer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The RestartTopologyRequest sent from local heron-cli</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the IScheduler restarts the topology successfully. SchedulerServer would |
| send RestartTopologyResponse correspondingly according to this method's return value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onUpdate(org.apache.heron.proto.scheduler.Scheduler.UpdateTopologyRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>onUpdate</h4> |
| <pre class="methodSignature">boolean onUpdate​(<a href="../../proto/scheduler/Scheduler.UpdateTopologyRequest.html" title="class in org.apache.heron.proto.scheduler">Scheduler.UpdateTopologyRequest</a> request)</pre> |
| <div class="block">Called by SchedulerServer when it receives a http request to update topology, |
| while the http request body would be the protobuf Scheduler.UpdateTopologyRequest. |
| The SchedulerServer would parse the request body and feed with this method. |
| It would be invoked in the executors of SchedulerServer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The UpdateTopologyRequest sent from local heron-cli</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the IScheduler updates the topology successfully. SchedulerServer would |
| send UpdateTopologyResponse correspondingly according to this method's return value.</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>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> |
