Google Git
Sign in
apache / incubator-heron / refs/heads/asf-site / . / content / api / java / org / apache / heron / scheduler / local / LocalScheduler.html
blob: 6b216cc16ff293a381cf1ac465aef7ed4a1e3751 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>LocalScheduler (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="LocalScheduler (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};
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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.heron.scheduler.local</a></div>
<h2 title="Class LocalScheduler" class="title">Class LocalScheduler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.heron.scheduler.local.LocalScheduler</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.AutoCloseable</code>, <code><a href="../../spi/scheduler/IScalable.html" title="interface in org.apache.heron.spi.scheduler">IScalable</a></code>, <code><a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">LocalScheduler</span>
extends java.lang.Object
implements <a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a>, <a href="../../spi/scheduler/IScalable.html" title="interface in org.apache.heron.spi.scheduler">IScalable</a></pre>
</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">&nbsp;</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()">LocalScheduler</a></span>()</code></th>
<td class="colLast">&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>java.util.Set&lt;<a href="../../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addContainers(java.util.Set)">addContainers</a></span>&#8203;(java.util.Set&lt;<a href="../../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>&gt;&nbsp;containers)</code></th>
<td class="colLast">
<div class="block">Requests new containers for scaling a topology</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<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="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</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="i3" 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,org.apache.heron.spi.common.Config)">initialize</a></span>&#8203;(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a>&nbsp;mConfig,
<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a>&nbsp;mRuntime)</code></th>
<td class="colLast">
<div class="block">This will initialize scheduler using config file.</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="#onKill(org.apache.heron.proto.scheduler.Scheduler.KillTopologyRequest)">onKill</a></span>&#8203;(<a href="../../proto/scheduler/Scheduler.KillTopologyRequest.html" title="class in org.apache.heron.proto.scheduler">Scheduler.KillTopologyRequest</a>&nbsp;request)</code></th>
<td class="colLast">
<div class="block">Handler to kill topology</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="#onRestart(org.apache.heron.proto.scheduler.Scheduler.RestartTopologyRequest)">onRestart</a></span>&#8203;(<a href="../../proto/scheduler/Scheduler.RestartTopologyRequest.html" title="class in org.apache.heron.proto.scheduler">Scheduler.RestartTopologyRequest</a>&nbsp;request)</code></th>
<td class="colLast">
<div class="block">Handler to restart topology</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="#onSchedule(org.apache.heron.spi.packing.PackingPlan)">onSchedule</a></span>&#8203;(<a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a>&nbsp;packing)</code></th>
<td class="colLast">
<div class="block">Schedule the provided packed plan</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<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>&#8203;(<a href="../../proto/scheduler/Scheduler.UpdateTopologyRequest.html" title="class in org.apache.heron.proto.scheduler">Scheduler.UpdateTopologyRequest</a>&nbsp;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>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeContainers(java.util.Set)">removeContainers</a></span>&#8203;(java.util.Set&lt;<a href="../../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>&gt;&nbsp;containersToRemove)</code></th>
<td class="colLast">
<div class="block">Requests containers to be released for down-scaling a topology.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startExecutor(int,java.util.Set)">startExecutor</a></span>&#8203;(int&nbsp;container,
java.util.Set&lt;<a href="../../spi/packing/PackingPlan.InstancePlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.InstancePlan</a>&gt;&nbsp;instances)</code></th>
<td class="colLast">
<div class="block">Start the executor for the given container</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startExecutorMonitor(int,java.lang.Process,java.util.Set)">startExecutorMonitor</a></span>&#8203;(int&nbsp;container,
java.lang.Process&nbsp;containerExecutor,
java.util.Set&lt;<a href="../../spi/packing/PackingPlan.InstancePlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.InstancePlan</a>&gt;&nbsp;instances)</code></th>
<td class="colLast">
<div class="block">Start the monitor of a given executor</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected java.lang.Process</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startExecutorProcess(int,java.util.Set)">startExecutorProcess</a></span>&#8203;(int&nbsp;container,
java.util.Set&lt;<a href="../../spi/packing/PackingPlan.InstancePlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.InstancePlan</a>&gt;&nbsp;instances)</code></th>
<td class="colLast">
<div class="block">Start executor process via running an async shell process</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&nbsp;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="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LocalScheduler</h4>
<pre>public&nbsp;LocalScheduler()</pre>
</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="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">public&nbsp;void&nbsp;initialize&#8203;(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a>&nbsp;mConfig,
<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a>&nbsp;mRuntime)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/scheduler/IScheduler.html#initialize(org.apache.heron.spi.common.Config,org.apache.heron.spi.common.Config)">IScheduler</a></code></span></div>
<div class="block">This will initialize scheduler using config file. Will be called during start.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spi/scheduler/IScheduler.html#initialize(org.apache.heron.spi.common.Config,org.apache.heron.spi.common.Config)">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a></code></dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/scheduler/IScheduler.html#close()">IScheduler</a></code></span></div>
<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>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spi/scheduler/IScheduler.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a></code></dd>
</dl>
</li>
</ul>
<a id="startExecutorProcess(int,java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startExecutorProcess</h4>
<pre class="methodSignature">protected&nbsp;java.lang.Process&nbsp;startExecutorProcess&#8203;(int&nbsp;container,
java.util.Set&lt;<a href="../../spi/packing/PackingPlan.InstancePlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.InstancePlan</a>&gt;&nbsp;instances)</pre>
<div class="block">Start executor process via running an async shell process</div>
</li>
</ul>
<a id="startExecutor(int,java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startExecutor</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;startExecutor&#8203;(int&nbsp;container,
java.util.Set&lt;<a href="../../spi/packing/PackingPlan.InstancePlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.InstancePlan</a>&gt;&nbsp;instances)</pre>
<div class="block">Start the executor for the given container</div>
</li>
</ul>
<a id="startExecutorMonitor(int,java.lang.Process,java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startExecutorMonitor</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;startExecutorMonitor&#8203;(int&nbsp;container,
java.lang.Process&nbsp;containerExecutor,
java.util.Set&lt;<a href="../../spi/packing/PackingPlan.InstancePlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.InstancePlan</a>&gt;&nbsp;instances)</pre>
<div class="block">Start the monitor of a given executor</div>
</li>
</ul>
<a id="onSchedule(org.apache.heron.spi.packing.PackingPlan)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onSchedule</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;onSchedule&#8203;(<a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a>&nbsp;packing)</pre>
<div class="block">Schedule the provided packed plan</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spi/scheduler/IScheduler.html#onSchedule(org.apache.heron.spi.packing.PackingPlan)">onSchedule</a></code>&nbsp;in interface&nbsp;<code><a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a></code></dd>
<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">public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getJobLinks()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/scheduler/IScheduler.html#getJobLinks()">IScheduler</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spi/scheduler/IScheduler.html#getJobLinks()">getJobLinks</a></code>&nbsp;in interface&nbsp;<code><a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a></code></dd>
<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">public&nbsp;boolean&nbsp;onKill&#8203;(<a href="../../proto/scheduler/Scheduler.KillTopologyRequest.html" title="class in org.apache.heron.proto.scheduler">Scheduler.KillTopologyRequest</a>&nbsp;request)</pre>
<div class="block">Handler to kill topology</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spi/scheduler/IScheduler.html#onKill(org.apache.heron.proto.scheduler.Scheduler.KillTopologyRequest)">onKill</a></code>&nbsp;in interface&nbsp;<code><a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a></code></dd>
<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">public&nbsp;boolean&nbsp;onRestart&#8203;(<a href="../../proto/scheduler/Scheduler.RestartTopologyRequest.html" title="class in org.apache.heron.proto.scheduler">Scheduler.RestartTopologyRequest</a>&nbsp;request)</pre>
<div class="block">Handler to restart topology</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spi/scheduler/IScheduler.html#onRestart(org.apache.heron.proto.scheduler.Scheduler.RestartTopologyRequest)">onRestart</a></code>&nbsp;in interface&nbsp;<code><a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a></code></dd>
<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="blockList">
<li class="blockList">
<h4>onUpdate</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;onUpdate&#8203;(<a href="../../proto/scheduler/Scheduler.UpdateTopologyRequest.html" title="class in org.apache.heron.proto.scheduler">Scheduler.UpdateTopologyRequest</a>&nbsp;request)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/scheduler/IScheduler.html#onUpdate(org.apache.heron.proto.scheduler.Scheduler.UpdateTopologyRequest)">IScheduler</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spi/scheduler/IScheduler.html#onUpdate(org.apache.heron.proto.scheduler.Scheduler.UpdateTopologyRequest)">onUpdate</a></code>&nbsp;in interface&nbsp;<code><a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a></code></dd>
<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>
<a id="addContainers(java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addContainers</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;<a href="../../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>&gt;&nbsp;addContainers&#8203;(java.util.Set&lt;<a href="../../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>&gt;&nbsp;containers)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/scheduler/IScalable.html#addContainers(java.util.Set)">IScalable</a></code></span></div>
<div class="block">Requests new containers for scaling a topology</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spi/scheduler/IScalable.html#addContainers(java.util.Set)">addContainers</a></code>&nbsp;in interface&nbsp;<code><a href="../../spi/scheduler/IScalable.html" title="interface in org.apache.heron.spi.scheduler">IScalable</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containers</code> - Set of containers to be added by the scheduler</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Set of added containers with real ids and resources from the scheduler</dd>
</dl>
</li>
</ul>
<a id="removeContainers(java.util.Set)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeContainers</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeContainers&#8203;(java.util.Set&lt;<a href="../../spi/packing/PackingPlan.ContainerPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.ContainerPlan</a>&gt;&nbsp;containersToRemove)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/scheduler/IScalable.html#removeContainers(java.util.Set)">IScalable</a></code></span></div>
<div class="block">Requests containers to be released for down-scaling a topology.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spi/scheduler/IScalable.html#removeContainers(java.util.Set)">removeContainers</a></code>&nbsp;in interface&nbsp;<code><a href="../../spi/scheduler/IScalable.html" title="interface in org.apache.heron.spi.scheduler">IScalable</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containersToRemove</code> - Set of containers to be removed by the scheduler</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&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>