| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_221) on Wed Jan 29 15:38:00 PST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TwillController (Apache Twill 0.14.0 API)</title> |
| <meta name="date" content="2020-01-29"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TwillController (Apache Twill 0.14.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TwillController.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/twill/api/TwillContext.html" title="interface in org.apache.twill.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/twill/api/TwillController.html" target="_top">Frames</a></li> |
| <li><a href="TwillController.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> |
| </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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.twill.api</div> |
| <h2 title="Interface TwillController" class="title">Interface TwillController</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api">ServiceController</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/twill/internal/AbstractTwillController.html" title="class in org.apache.twill.internal">AbstractTwillController</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">TwillController</span> |
| extends <a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api">ServiceController</a></pre> |
| <div class="block">For controlling a running application.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.twill.api.ServiceController"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.twill.api.<a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api">ServiceController</a></h3> |
| <code><a href="../../../../org/apache/twill/api/ServiceController.TerminationStatus.html" title="enum in org.apache.twill.api">ServiceController.TerminationStatus</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillController.html#addLogHandler-org.apache.twill.api.logging.LogHandler-">addLogHandler</a></span>(<a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging">LogHandler</a> handler)</code> |
| <div class="block">Adds a <a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging"><code>LogHandler</code></a> for receiving application log.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillController.html#changeInstances-java.lang.String-int-">changeInstances</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnable, |
| int newCount)</code> |
| <div class="block">Changes the number of running instances of a given runnable.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/discovery/ServiceDiscovered.html" title="interface in org.apache.twill.discovery">ServiceDiscovered</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillController.html#discoverService-java.lang.String-">discoverService</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> serviceName)</code> |
| <div class="block">Discovers the set of <a href="../../../../org/apache/twill/discovery/Discoverable.html" title="class in org.apache.twill.discovery"><code>Discoverable</code></a> endpoints that provides service for the given service name.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/ResourceReport.html" title="interface in org.apache.twill.api">ResourceReport</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillController.html#getResourceReport--">getResourceReport</a></span>()</code> |
| <div class="block">Get a snapshot of the resources used by the application, broken down by each runnable.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillController.html#resetLogLevels-java.lang.String...-">resetLogLevels</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... loggerNames)</code> |
| <div class="block">Reset the log levels of all runnables.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillController.html#resetRunnableLogLevels-java.lang.String-java.lang.String...-">resetRunnableLogLevels</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... loggerNames)</code> |
| <div class="block">Reset the log levels of the given runnable.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillController.html#restartAllInstances-java.lang.String-">restartAllInstances</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnable)</code> |
| <div class="block">Restart all instances of a particular <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillController.html#restartInstances-java.util.Map-">restartInstances</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>>> runnableToInstanceIds)</code> |
| <div class="block">Restart instances of some <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillController.html#restartInstances-java.lang.String-int-int...-">restartInstances</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnable, |
| int instanceId, |
| int... moreInstanceIds)</code> |
| <div class="block">Restart instances of some <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillController.html#restartInstances-java.lang.String-java.util.Set-">restartInstances</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnable, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> instanceIds)</code> |
| <div class="block">Restart instances of some <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillController.html#updateLogLevels-java.util.Map-">updateLogLevels</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a>> logLevels)</code> |
| <div class="block">Update the log levels for requested logger names for Twill applications running in a container.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillController.html#updateLogLevels-java.lang.String-java.util.Map-">updateLogLevels</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a>> logLevelsForRunnable)</code> |
| <div class="block">Update the log levels for requested logger names for a <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.twill.api.ServiceController"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.twill.api.<a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api">ServiceController</a></h3> |
| <code><a href="../../../../org/apache/twill/api/ServiceController.html#awaitTerminated--">awaitTerminated</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#awaitTerminated-long-java.util.concurrent.TimeUnit-">awaitTerminated</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#getRunId--">getRunId</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#getTerminationStatus--">getTerminationStatus</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#kill--">kill</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#onRunning-java.lang.Runnable-java.util.concurrent.Executor-">onRunning</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#onTerminated-java.lang.Runnable-java.util.concurrent.Executor-">onTerminated</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#sendCommand-org.apache.twill.api.Command-">sendCommand</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#sendCommand-java.lang.String-org.apache.twill.api.Command-">sendCommand</a>, <a href="../../../../org/apache/twill/api/ServiceController.html#terminate--">terminate</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addLogHandler-org.apache.twill.api.logging.LogHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addLogHandler</h4> |
| <pre>void addLogHandler(<a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging">LogHandler</a> handler)</pre> |
| <div class="block">Adds a <a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging"><code>LogHandler</code></a> for receiving application log.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>handler</code> - The handler to add.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="discoverService-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>discoverService</h4> |
| <pre><a href="../../../../org/apache/twill/discovery/ServiceDiscovered.html" title="interface in org.apache.twill.discovery">ServiceDiscovered</a> discoverService(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> serviceName)</pre> |
| <div class="block">Discovers the set of <a href="../../../../org/apache/twill/discovery/Discoverable.html" title="class in org.apache.twill.discovery"><code>Discoverable</code></a> endpoints that provides service for the given service name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serviceName</code> - Name of the service to discovery.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../org/apache/twill/discovery/ServiceDiscovered.html" title="interface in org.apache.twill.discovery"><code>ServiceDiscovered</code></a> object representing the result.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="changeInstances-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>changeInstances</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> changeInstances(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnable, |
| int newCount)</pre> |
| <div class="block">Changes the number of running instances of a given runnable.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnable</code> - The name of the runnable.</dd> |
| <dd><code>newCount</code> - Number of instances for the given runnable.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent"><code>Future</code></a> that will be completed when the number running instances has been |
| successfully changed. The future will carry the new count as the result. If there is any error |
| while changing instances, it'll be reflected in the future.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResourceReport--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResourceReport</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a> |
| <a href="../../../../org/apache/twill/api/ResourceReport.html" title="interface in org.apache.twill.api">ResourceReport</a> getResourceReport()</pre> |
| <div class="block">Get a snapshot of the resources used by the application, broken down by each runnable.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../org/apache/twill/api/ResourceReport.html" title="interface in org.apache.twill.api"><code>ResourceReport</code></a> containing information about resources used by the application or |
| null in case the user calls this before the application completely starts.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="restartAllInstances-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>restartAllInstances</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> restartAllInstances(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnable)</pre> |
| <div class="block">Restart all instances of a particular <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnable</code> - The name of the runnable to restart.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent"><code>Future</code></a> that will be completed when the restart operation has been done.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="restartInstances-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>restartInstances</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> restartInstances(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>>> runnableToInstanceIds)</pre> |
| <div class="block">Restart instances of some <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnableToInstanceIds</code> - A map of runnable ID to list of instance IDs to be restarted.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent"><code>Future</code></a> that will be completed when the restart operation has been done.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="restartInstances-java.lang.String-int-int...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>restartInstances</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> restartInstances(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnable, |
| int instanceId, |
| int... moreInstanceIds)</pre> |
| <div class="block">Restart instances of some <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnable</code> - The name of the runnable to restart.</dd> |
| <dd><code>instanceId</code> - The main instance id to be restarted.</dd> |
| <dd><code>moreInstanceIds</code> - The optional instance ids.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent"><code>Future</code></a> that will be completed when the restart operation has been done.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="restartInstances-java.lang.String-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>restartInstances</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> restartInstances(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnable, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> instanceIds)</pre> |
| <div class="block">Restart instances of some <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnable</code> - The name of the runnable to restart.</dd> |
| <dd><code>instanceIds</code> - Instances to be restarted</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent"><code>Future</code></a> that will be completed when the restart operation has been done.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateLogLevels-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateLogLevels</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a>>> updateLogLevels(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a>> logLevels)</pre> |
| <div class="block">Update the log levels for requested logger names for Twill applications running in a container. |
| The log level for a logger name can be <code>null</code> except for the root logger, which will reset the log level for |
| the specified logger.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>logLevels</code> - The <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> contains the requested logger names and log levels that need to be updated.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent"><code>Future</code></a> that will be completed when the log level update has been done. It will carry the |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> of log levels as the result.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateLogLevels-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateLogLevels</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a>>> updateLogLevels(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a>> logLevelsForRunnable)</pre> |
| <div class="block">Update the log levels for requested logger names for a <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>. |
| The log level for a logger name can be <code>null</code> except for the root logger, |
| which will reset the log level for |
| the specified logger.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnableName</code> - The name of the runnable to update the log level.</dd> |
| <dd><code>logLevelsForRunnable</code> - The <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> contains the requested logger name and log level that |
| need to be updated.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent"><code>Future</code></a> that will be completed when the log level update has been done. It will carry the |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> of log levels as the result.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resetLogLevels-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetLogLevels</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]> resetLogLevels(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... loggerNames)</pre> |
| <div class="block">Reset the log levels of all runnables. |
| The log levels will be the same as when the runnables start up.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>loggerNames</code> - The optional logger names to be reset for all runnables, if not provided, all log levels will |
| be reset.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent"><code>Future</code></a> that will be completed when the set log level operation has been done. The future result |
| is the logger names provided in the parameter.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resetRunnableLogLevels-java.lang.String-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>resetRunnableLogLevels</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent">Future</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]> resetRunnableLogLevels(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... loggerNames)</pre> |
| <div class="block">Reset the log levels of the given runnable. |
| The log levels will be same as when the runnable starts up.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>loggerNames</code> - The optional logger names to be reset for the runnable, if not provided, all log levels will |
| be reset.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent"><code>Future</code></a> that will be completed when the set log level operation has been done. The future result |
| is the logger names provided in the parameter.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TwillController.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/twill/api/TwillContext.html" title="interface in org.apache.twill.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/twill/api/TwillController.html" target="_top">Frames</a></li> |
| <li><a href="TwillController.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.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> |
| </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2013-2020 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
