Google Git
Sign in
apache / incubator-twill / 5b972e716c5f800706f01dc53d4135183fa7abbf / . / src / site / resources / apidocs-0.6.0-incubating / org / apache / twill / yarn / YarnTwillRunnerService.html
blob: 22efc33924e7b4cd951d1949189e842949d83a33 [file] [log] [blame]
<!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 (version 1.7.0_80) on Fri Jul 24 11:31:41 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>YarnTwillRunnerService (Apache Twill 0.6.0-incubating API)</title>
<meta name="date" content="2015-07-24">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="YarnTwillRunnerService (Apache Twill 0.6.0-incubating API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/YarnTwillRunnerService.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/yarn/YarnSecureStore.html" title="class in org.apache.twill.yarn"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/twill/yarn/YarnTwillRunnerService.html" target="_top">Frames</a></li>
<li><a href="YarnTwillRunnerService.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:&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 name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.twill.yarn</div>
<h2 title="Class YarnTwillRunnerService" class="title">Class YarnTwillRunnerService</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.twill.yarn.YarnTwillRunnerService</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a>, <a href="../../../../org/apache/twill/api/TwillRunnerService.html" title="interface in org.apache.twill.api">TwillRunnerService</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">YarnTwillRunnerService</span>
extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../org/apache/twill/api/TwillRunnerService.html" title="interface in org.apache.twill.api">TwillRunnerService</a></pre>
<div class="block">An implementation of <a href="../../../../org/apache/twill/api/TwillRunnerService.html" title="interface in org.apache.twill.api"><code>TwillRunnerService</code></a> that runs application on a YARN cluster.</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.TwillRunner">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.twill.api.<a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></h3>
<code><a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api">TwillRunner.LiveInfo</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#YarnTwillRunnerService(org.apache.hadoop.yarn.conf.YarnConfiguration,%20java.lang.String)">YarnTwillRunnerService</a></strong>(org.apache.hadoop.yarn.conf.YarnConfiguration&nbsp;config,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;zkConnect)</code>
<div class="block">Creates an instance with a <a href="../../../../org/apache/twill/filesystem/HDFSLocationFactory.html" title="class in org.apache.twill.filesystem"><code>HDFSLocationFactory</code></a> created base on the given configuration with the
user home directory as the location factory namespace.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#YarnTwillRunnerService(org.apache.hadoop.yarn.conf.YarnConfiguration,%20java.lang.String,%20org.apache.twill.filesystem.LocationFactory)">YarnTwillRunnerService</a></strong>(org.apache.hadoop.yarn.conf.YarnConfiguration&nbsp;config,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;zkConnect,
<a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a>&nbsp;locationFactory)</code>
<div class="block">Creates an instance.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#getJVMOptions()">getJVMOptions</a></strong>()</code>
<div class="block">Returns any extra JVM options that have been set.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#lookup(java.lang.String)">lookup</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;applicationName)</code>
<div class="block">Gets an <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> of <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> for all running instances of the given application.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#lookup(java.lang.String,%20org.apache.twill.api.RunId)">lookup</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;applicationName,
<a href="../../../../org/apache/twill/api/RunId.html" title="interface in org.apache.twill.api">RunId</a>&nbsp;runId)</code>
<div class="block">Gets a <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> for the given application and runId.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api">TwillRunner.LiveInfo</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#lookupLive()">lookupLive</a></strong>()</code>
<div class="block">Gets an <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> of <a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api"><code>TwillRunner.LiveInfo</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#prepare(org.apache.twill.api.TwillApplication)">prepare</a></strong>(<a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api">TwillApplication</a>&nbsp;application)</code>
<div class="block">Prepares to run the given <a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api"><code>TwillApplication</code></a> as specified by the application.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#prepare(org.apache.twill.api.TwillRunnable)">prepare</a></strong>(<a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a>&nbsp;runnable)</code>
<div class="block">Prepares to run the given <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> with <a href="../../../../org/apache/twill/api/ResourceSpecification.html#BASIC"><code>ResourceSpecification.BASIC</code></a> resource specification.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#prepare(org.apache.twill.api.TwillRunnable,%20org.apache.twill.api.ResourceSpecification)">prepare</a></strong>(<a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a>&nbsp;runnable,
<a href="../../../../org/apache/twill/api/ResourceSpecification.html" title="interface in org.apache.twill.api">ResourceSpecification</a>&nbsp;resourceSpecification)</code>
<div class="block">Prepares to run the given <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> with the given resource specification.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common">Cancellable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#scheduleSecureStoreUpdate(org.apache.twill.api.SecureStoreUpdater,%20long,%20long,%20java.util.concurrent.TimeUnit)">scheduleSecureStoreUpdate</a></strong>(<a href="../../../../org/apache/twill/api/SecureStoreUpdater.html" title="interface in org.apache.twill.api">SecureStoreUpdater</a>&nbsp;updater,
long&nbsp;initialDelay,
long&nbsp;delay,
<a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</code>
<div class="block">Schedules a periodic update of SecureStore.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#setJVMOptions(java.lang.String)">setJVMOptions</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;options)</code>
<div class="block">This methods sets the extra JVM options that will be passed to the java command line for every application
started through this <a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html" title="class in org.apache.twill.yarn"><code>YarnTwillRunnerService</code></a> instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#start()">start</a></strong>()</code>
<div class="block">Starts the service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#stop()">stop</a></strong>()</code>
<div class="block">Stops the service.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="YarnTwillRunnerService(org.apache.hadoop.yarn.conf.YarnConfiguration, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>YarnTwillRunnerService</h4>
<pre>public&nbsp;YarnTwillRunnerService(org.apache.hadoop.yarn.conf.YarnConfiguration&nbsp;config,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;zkConnect)</pre>
<div class="block">Creates an instance with a <a href="../../../../org/apache/twill/filesystem/HDFSLocationFactory.html" title="class in org.apache.twill.filesystem"><code>HDFSLocationFactory</code></a> created base on the given configuration with the
user home directory as the location factory namespace.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Configuration of the yarn cluster</dd><dd><code>zkConnect</code> - ZooKeeper connection string</dd></dl>
</li>
</ul>
<a name="YarnTwillRunnerService(org.apache.hadoop.yarn.conf.YarnConfiguration, java.lang.String, org.apache.twill.filesystem.LocationFactory)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>YarnTwillRunnerService</h4>
<pre>public&nbsp;YarnTwillRunnerService(org.apache.hadoop.yarn.conf.YarnConfiguration&nbsp;config,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;zkConnect,
<a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a>&nbsp;locationFactory)</pre>
<div class="block">Creates an instance.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Configuration of the yarn cluster</dd><dd><code>zkConnect</code> - ZooKeeper connection string</dd><dd><code>locationFactory</code> - Factory to create <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a> instances that are readable and writable by this service</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public&nbsp;void&nbsp;start()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunnerService.html#start()">TwillRunnerService</a></code></strong></div>
<div class="block">Starts the service. Calling this method on a already started instance has no effect.
A service that is stopped cannot be started again.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/twill/api/TwillRunnerService.html#start()">start</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunnerService.html" title="interface in org.apache.twill.api">TwillRunnerService</a></code></dd>
</dl>
</li>
</ul>
<a name="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public&nbsp;void&nbsp;stop()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunnerService.html#stop()">TwillRunnerService</a></code></strong></div>
<div class="block">Stops the service. Calling this method on a already stopped instance has no effect.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/twill/api/TwillRunnerService.html#stop()">stop</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunnerService.html" title="interface in org.apache.twill.api">TwillRunnerService</a></code></dd>
</dl>
</li>
</ul>
<a name="setJVMOptions(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setJVMOptions</h4>
<pre>public&nbsp;void&nbsp;setJVMOptions(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;options)</pre>
<div class="block">This methods sets the extra JVM options that will be passed to the java command line for every application
started through this <a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html" title="class in org.apache.twill.yarn"><code>YarnTwillRunnerService</code></a> instance. It only affects applications that are started
after options is set.
This is intended for advance usage. All options will be passed unchanged to the java command line. Invalid
options could cause application not able to start.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - extra JVM options.</dd></dl>
</li>
</ul>
<a name="getJVMOptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJVMOptions</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getJVMOptions()</pre>
<div class="block">Returns any extra JVM options that have been set.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html#setJVMOptions(java.lang.String)"><code>setJVMOptions(String)</code></a></dd></dl>
</li>
</ul>
<a name="scheduleSecureStoreUpdate(org.apache.twill.api.SecureStoreUpdater, long, long, java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheduleSecureStoreUpdate</h4>
<pre>public&nbsp;<a href="../../../../org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common">Cancellable</a>&nbsp;scheduleSecureStoreUpdate(<a href="../../../../org/apache/twill/api/SecureStoreUpdater.html" title="interface in org.apache.twill.api">SecureStoreUpdater</a>&nbsp;updater,
long&nbsp;initialDelay,
long&nbsp;delay,
<a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html#scheduleSecureStoreUpdate(org.apache.twill.api.SecureStoreUpdater,%20long,%20long,%20java.util.concurrent.TimeUnit)">TwillRunner</a></code></strong></div>
<div class="block">Schedules a periodic update of SecureStore. The first call to the given <a href="../../../../org/apache/twill/api/SecureStoreUpdater.html" title="interface in org.apache.twill.api"><code>SecureStoreUpdater</code></a> will be made
after <code>initialDelay</code>, and subsequently with the given <code>delay</code> between completion of one update
and starting of the next. If exception is thrown on call
<a href="../../../../org/apache/twill/api/SecureStoreUpdater.html#update(java.lang.String,%20org.apache.twill.api.RunId)"><code>SecureStoreUpdater.update(String, RunId)</code></a>, the exception will only get logged
and won't suppress the next update call.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/twill/api/TwillRunner.html#scheduleSecureStoreUpdate(org.apache.twill.api.SecureStoreUpdater,%20long,%20long,%20java.util.concurrent.TimeUnit)">scheduleSecureStoreUpdate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>updater</code> - A <a href="../../../../org/apache/twill/api/SecureStoreUpdater.html" title="interface in org.apache.twill.api"><code>SecureStoreUpdater</code></a> for creating new SecureStore.</dd><dd><code>initialDelay</code> - Delay before the first call to update method.</dd><dd><code>delay</code> - Delay between completion of one update call to the next one.</dd><dd><code>unit</code> - time unit for the initialDelay and delay.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common"><code>Cancellable</code></a> for cancelling the scheduled update.</dd></dl>
</li>
</ul>
<a name="prepare(org.apache.twill.api.TwillRunnable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre>public&nbsp;<a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a>&nbsp;prepare(<a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a>&nbsp;runnable)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html#prepare(org.apache.twill.api.TwillRunnable)">TwillRunner</a></code></strong></div>
<div class="block">Prepares to run the given <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> with <a href="../../../../org/apache/twill/api/ResourceSpecification.html#BASIC"><code>ResourceSpecification.BASIC</code></a> resource specification.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/twill/api/TwillRunner.html#prepare(org.apache.twill.api.TwillRunnable)">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>runnable</code> - The runnable to run through Twill when <a href="../../../../org/apache/twill/api/TwillPreparer.html#start()"><code>TwillPreparer.start()</code></a> is called.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> for setting up runtime options.</dd></dl>
</li>
</ul>
<a name="prepare(org.apache.twill.api.TwillRunnable, org.apache.twill.api.ResourceSpecification)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre>public&nbsp;<a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a>&nbsp;prepare(<a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a>&nbsp;runnable,
<a href="../../../../org/apache/twill/api/ResourceSpecification.html" title="interface in org.apache.twill.api">ResourceSpecification</a>&nbsp;resourceSpecification)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html#prepare(org.apache.twill.api.TwillRunnable,%20org.apache.twill.api.ResourceSpecification)">TwillRunner</a></code></strong></div>
<div class="block">Prepares to run the given <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> with the given resource specification.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/twill/api/TwillRunner.html#prepare(org.apache.twill.api.TwillRunnable,%20org.apache.twill.api.ResourceSpecification)">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>runnable</code> - The runnable to run through Twill when <a href="../../../../org/apache/twill/api/TwillPreparer.html#start()"><code>TwillPreparer.start()</code></a> is called.</dd><dd><code>resourceSpecification</code> - The resource specification for running the runnable.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> for setting up runtime options.</dd></dl>
</li>
</ul>
<a name="prepare(org.apache.twill.api.TwillApplication)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre>public&nbsp;<a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a>&nbsp;prepare(<a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api">TwillApplication</a>&nbsp;application)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html#prepare(org.apache.twill.api.TwillApplication)">TwillRunner</a></code></strong></div>
<div class="block">Prepares to run the given <a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api"><code>TwillApplication</code></a> as specified by the application.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/twill/api/TwillRunner.html#prepare(org.apache.twill.api.TwillApplication)">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>application</code> - The application to run through Twill when <a href="../../../../org/apache/twill/api/TwillPreparer.html#start()"><code>TwillPreparer.start()</code></a> is called.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> for setting up runtime options.</dd></dl>
</li>
</ul>
<a name="lookup(java.lang.String, org.apache.twill.api.RunId)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lookup</h4>
<pre>public&nbsp;<a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a>&nbsp;lookup(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;applicationName,
<a href="../../../../org/apache/twill/api/RunId.html" title="interface in org.apache.twill.api">RunId</a>&nbsp;runId)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html#lookup(java.lang.String,%20org.apache.twill.api.RunId)">TwillRunner</a></code></strong></div>
<div class="block">Gets a <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> for the given application and runId.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/twill/api/TwillRunner.html#lookup(java.lang.String,%20org.apache.twill.api.RunId)">lookup</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>applicationName</code> - Name of the application.</dd><dd><code>runId</code> - The runId of the running application.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> to interact with the application or null if no such runId is found.</dd></dl>
</li>
</ul>
<a name="lookup(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lookup</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a>&gt;&nbsp;lookup(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;applicationName)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html#lookup(java.lang.String)">TwillRunner</a></code></strong></div>
<div class="block">Gets an <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> of <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> for all running instances of the given application.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/twill/api/TwillRunner.html#lookup(java.lang.String)">lookup</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>applicationName</code> - Name of the application.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A live <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> that gives the latest <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> set for all running
instances of the application when <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang"><code>Iterable.iterator()</code></a> is invoked.</dd></dl>
</li>
</ul>
<a name="lookupLive()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>lookupLive</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api">TwillRunner.LiveInfo</a>&gt;&nbsp;lookupLive()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html#lookupLive()">TwillRunner</a></code></strong></div>
<div class="block">Gets an <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> of <a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api"><code>TwillRunner.LiveInfo</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/twill/api/TwillRunner.html#lookupLive()">lookupLive</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>A live <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> that gives the latest information on the set of applications that
have running instances when <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang"><code>Iterable.iterator()</code></a>} is invoked.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/YarnTwillRunnerService.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/yarn/YarnSecureStore.html" title="class in org.apache.twill.yarn"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/twill/yarn/YarnTwillRunnerService.html" target="_top">Frames</a></li>
<li><a href="YarnTwillRunnerService.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:&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 name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2013 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>