http://git-wip-us.apache.org/repos/asf/twill/blob/8abb84ac/src/site/resources/apidocs-0.11.0/index-all.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.11.0/index-all.html b/src/site/resources/apidocs-0.11.0/index-all.html new file mode 100644 index 0000000..ce7432d --- /dev/null +++ b/src/site/resources/apidocs-0.11.0/index-all.html @@ -0,0 +1,2524 @@ +<!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 Sat Apr 08 11:09:16 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Index (Apache Twill 0.11.0 API)</title> +<meta name="date" content="2017-04-08"> +<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="Index (Apache Twill 0.11.0 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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="./overview-tree.html">Tree</a></li> +<li><a href="./deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="./help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="./index.html?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="contentContainer"><a href="#_A_">A</a> <a href="#_B_">B</a> <a href="#_C_">C</a> <a href="#_D_">D</a> <a href="#_E_">E</a> <a href="#_F_">F</a> <a href="#_G_">G</a> <a href="#_H_">H</a> <a href="#_I_">I</a> <a href="#_J_">J</a> <a href="#_K_">K</a> <a href="#_L_">L</a> <a href="#_M_">M</a> <a href="#_N_">N</a> <a href="#_O_">O</a> <a href="#_P_">P</a> <a href="#_R_">R</a> <a href="#_S_">S</a> <a href="#_T_">T</a> <a href="#_U_">U</a> <a href="#_V_">V</a> <a href="#_W_">W</a> <a href="#_Y_">Y</a> <a href="#_Z_">Z</a> <a name="_A_"> +<!-- --> +</a> +<h2 class="title">A</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/twill/api/EventHandler.TimeoutAction.html#abort()">abort()</a></span> - Static method in class org.apache.twill.api.<a href="./org/apache/twill/api/EventHandler.TimeoutAction.html" title="class in org.apache.twill.api">EventHandler.TimeoutAction</a></dt> +<dd> +<div class="block">Creates a <a href="./org/apache/twill/api/EventHandler.TimeoutAction.html" title="class in org.apache.twill.api"><code>EventHandler.TimeoutAction</code></a> to indicate aborting the application.</div> +</dd> +<dt><a href="./org/apache/twill/api/AbstractTwillRunnable.html" title="class in org.apache.twill.api"><span class="strong">AbstractTwillRunnable</span></a> - Class in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">This abstract class provides default implementation of the <a href="./org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/AbstractTwillRunnable.html#AbstractTwillRunnable()">AbstractTwillRunnable()</a></span> - Constructor for class org.apache.twill.api.<a href="./org/apache/twill/api/AbstractTwillRunnable.html" title="class in org.apache.twill.api">AbstractTwillRunnable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/AbstractTwillRunnable.html#AbstractTwillRunnable(java.util.Map)">AbstractTwillRunnable(Map<String, String>)</a></span> - Constructor for class org.apache.twill.api.<a href="./org/apache/twill/api/AbstractTwillRunnable.html" title="class in org.apache.twill.api">AbstractTwillRunnable</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/zookeeper/AbstractZKClient.html" title="class in org.apache.twill.zookeeper"><span class="strong">AbstractZKClient</span></a> - Class in <a href="./org/apache/twill/zookeeper/package-summary.html">org.apache.twill.zookeeper</a></dt> +<dd> +<div class="block">An abstract base implementation of <a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper"><code>ZKClient</code></a> that simplifies implementation by providing forwarding for + methods that are meant to be delegated to other methods.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/AbstractZKClient.html#AbstractZKClient()">AbstractZKClient()</a></span> - Constructor for class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/AbstractZKClient.html" title="class in org.apache.twill.zookeeper">AbstractZKClient</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/ClassAcceptor.html#accept(java.lang.String,%20java.net.URL,%20java.net.URL)">accept(String, URL, URL)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/ClassAcceptor.html" title="class in org.apache.twill.api">ClassAcceptor</a></dt> +<dd> +<div class="block">Invoked to determine if class can be accepted.</div> +</dd> +<dt><a href="./org/apache/twill/zookeeper/ACLData.html" title="interface in org.apache.twill.zookeeper"><span class="strong">ACLData</span></a> - Interface in <a href="./org/apache/twill/zookeeper/package-summary.html">org.apache.twill.zookeeper</a></dt> +<dd> +<div class="block">Represents result of call to <a href="./org/apache/twill/zookeeper/ZKClient.html#getACL(java.lang.String)"><code>ZKClient.getACL(String)</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html#add(java.lang.String,%20java.io.File)">add(String, File)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.LocalFileAdder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html#add(java.lang.String,%20java.net.URI)">add(String, URI)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.LocalFileAdder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html#add(java.lang.String,%20java.io.File,%20boolean)">add(String, File, boolean)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.LocalFileAdder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html#add(java.lang.String,%20java.net.URI,%20boolean)">add(String, URI, boolean)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.LocalFileAdder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html#add(java.lang.String,%20java.io.File,%20java.lang.String)">add(String, File, String)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.LocalFileAdder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html#add(java.lang.String,%20java.net.URI,%20java.lang.String)">add(String, URI, String)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.LocalFileAdder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html#add(java.lang.String,%20java.io.File)">add(String, File)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html" title="class in org.apache.twill.api">TwillSpecification.Builder.MoreFile</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html#add(java.lang.String,%20java.net.URI)">add(String, URI)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html" title="class in org.apache.twill.api">TwillSpecification.Builder.MoreFile</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html#add(java.lang.String,%20java.io.File,%20boolean)">add(String, File, boolean)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html" title="class in org.apache.twill.api">TwillSpecification.Builder.MoreFile</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html#add(java.lang.String,%20java.net.URI,%20boolean)">add(String, URI, boolean)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html" title="class in org.apache.twill.api">TwillSpecification.Builder.MoreFile</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html#add(java.lang.String,%20java.io.File,%20java.lang.String)">add(String, File, String)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html" title="class in org.apache.twill.api">TwillSpecification.Builder.MoreFile</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html#add(java.lang.String,%20java.net.URI,%20java.lang.String)">add(String, URI, String)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html" title="class in org.apache.twill.api">TwillSpecification.Builder.MoreFile</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MorePlacementPolicies.html#add(org.apache.twill.api.Hosts,%20java.lang.String,%20java.lang.String...)">add(Hosts, String, String...)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MorePlacementPolicies.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.MorePlacementPolicies</a></dt> +<dd> +<div class="block">Specify hosts for a list of runnables.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MorePlacementPolicies.html#add(org.apache.twill.api.Racks,%20java.lang.String,%20java.lang.String...)">add(Racks, String, String...)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MorePlacementPolicies.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.MorePlacementPolicies</a></dt> +<dd> +<div class="block">Specify racks for a list of runnables.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MorePlacementPolicies.html#add(org.apache.twill.api.Hosts,%20org.apache.twill.api.Racks,%20java.lang.String,%20java.lang.String...)">add(Hosts, Racks, String, String...)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MorePlacementPolicies.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.MorePlacementPolicies</a></dt> +<dd> +<div class="block">Specify hosts and racks for a list of runnables.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MorePlacementPolicies.html#add(org.apache.twill.api.TwillSpecification.PlacementPolicy.Type,%20java.lang.String,%20java.lang.String...)">add(TwillSpecification.PlacementPolicy.Type, String, String...)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MorePlacementPolicies.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.MorePlacementPolicies</a></dt> +<dd> +<div class="block">Specify a placement policy for a list of runnables.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MoreRunnable.html#add(org.apache.twill.api.TwillRunnable)">add(TwillRunnable)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MoreRunnable.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.MoreRunnable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MoreRunnable.html#add(org.apache.twill.api.TwillRunnable,%20org.apache.twill.api.ResourceSpecification)">add(TwillRunnable, ResourceSpecification)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MoreRunnable.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.MoreRunnable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MoreRunnable.html#add(java.lang.String,%20org.apache.twill.api.TwillRunnable)">add(String, TwillRunnable)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MoreRunnable.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.MoreRunnable</a></dt> +<dd> +<div class="block">Adds a <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> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MoreRunnable.html#add(java.lang.String,%20org.apache.twill.api.TwillRunnable,%20org.apache.twill.api.ResourceSpecification)">add(String, TwillRunnable, ResourceSpecification)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MoreRunnable.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.MoreRunnable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.PlacementPolicySetter.html#add(org.apache.twill.api.Hosts,%20java.lang.String,%20java.lang.String...)">add(Hosts, String, String...)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.PlacementPolicySetter.html" title="class in org.apache.twill.api">TwillSpecification.Builder.PlacementPolicySetter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.PlacementPolicySetter.html#add(org.apache.twill.api.Racks,%20java.lang.String,%20java.lang.String...)">add(Racks, String, String...)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.PlacementPolicySetter.html" title="class in org.apache.twill.api">TwillSpecification.Builder.PlacementPolicySetter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.PlacementPolicySetter.html#add(org.apache.twill.api.Hosts,%20org.apache.twill.api.Racks,%20java.lang.String,%20java.lang.String...)">add(Hosts, Racks, String, String...)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.PlacementPolicySetter.html" title="class in org.apache.twill.api">TwillSpecification.Builder.PlacementPolicySetter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.PlacementPolicySetter.html#add(org.apache.twill.api.TwillSpecification.PlacementPolicy.Type,%20java.lang.String,%20java.lang.String...)">add(TwillSpecification.PlacementPolicy.Type, String, String...)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.PlacementPolicySetter.html" title="class in org.apache.twill.api">TwillSpecification.Builder.PlacementPolicySetter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.RunnableSetter.html#add(org.apache.twill.api.TwillRunnable)">add(TwillRunnable)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.RunnableSetter.html" title="class in org.apache.twill.api">TwillSpecification.Builder.RunnableSetter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.RunnableSetter.html#add(org.apache.twill.api.TwillRunnable,%20org.apache.twill.api.ResourceSpecification)">add(TwillRunnable, ResourceSpecification)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.RunnableSetter.html" title="class in org.apache.twill.api">TwillSpecification.Builder.RunnableSetter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.RunnableSetter.html#add(java.lang.String,%20org.apache.twill.api.TwillRunnable)">add(String, TwillRunnable)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.RunnableSetter.html" title="class in org.apache.twill.api">TwillSpecification.Builder.RunnableSetter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.RunnableSetter.html#add(java.lang.String,%20org.apache.twill.api.TwillRunnable,%20org.apache.twill.api.ResourceSpecification)">add(String, TwillRunnable, ResourceSpecification)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.RunnableSetter.html" title="class in org.apache.twill.api">TwillSpecification.Builder.RunnableSetter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/KafkaConsumer.Preparer.html#add(java.lang.String,%20int,%20long)">add(String, int, long)</a></span> - Method in interface org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a></dt> +<dd> +<div class="block">Consumes messages from a given offset.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/KafkaPublisher.Preparer.html#add(java.nio.ByteBuffer,%20java.lang.Object)">add(ByteBuffer, Object)</a></span> - Method in interface org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/KafkaPublisher.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaPublisher.Preparer</a></dt> +<dd> +<div class="block">Adds the given message to the message set, partitioned with the given partition key.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClientService.Builder.html#addAuthInfo(java.lang.String,%20byte[])">addAuthInfo(String, byte[])</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClientService.Builder.html" title="class in org.apache.twill.zookeeper">ZKClientService.Builder</a></dt> +<dd> +<div class="block">Adds an authorization information.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/BrokerService.html#addChangeListener(org.apache.twill.kafka.client.BrokerService.BrokerChangeListener,%20java.util.concurrent.Executor)">addChangeListener(BrokerService.BrokerChangeListener, Executor)</a></span> - Method in interface org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/BrokerService.html" title="interface in org.apache.twill.kafka.client">BrokerService</a></dt> +<dd> +<div class="block">Adds a listener to changes in broker list managed by this service.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ForwardingZKClient.html#addConnectionWatcher(org.apache.zookeeper.Watcher)">addConnectionWatcher(Watcher)</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ForwardingZKClient.html" title="class in org.apache.twill.zookeeper">ForwardingZKClient</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClient.html#addConnectionWatcher(org.apache.zookeeper.Watcher)">addConnectionWatcher(Watcher)</a></span> - Method in interface org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></dt> +<dd> +<div class="block">Adds a <code>Watcher</code> that will be called whenever connection state change.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/KafkaConsumer.Preparer.html#addFromBeginning(java.lang.String,%20int)">addFromBeginning(String, int)</a></span> - Method in interface org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a></dt> +<dd> +<div class="block">Consumes messages from the earliest message available.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillPreparer.html#addJVMOptions(java.lang.String)">addJVMOptions(String)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></dt> +<dd> +<div class="block">This methods adds extra JVM options that will be passed to the java command line for every runnable + of the application started through this <a href="./org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> instance.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/KafkaConsumer.Preparer.html#addLatest(java.lang.String,%20int)">addLatest(String, int)</a></span> - Method in interface org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a></dt> +<dd> +<div class="block">Consumes messages from the latest message.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ForwardingZKClientService.html#addListener(com.google.common.util.concurrent.Service.Listener,%20java.util.concurrent.Executor)">addListener(Service.Listener, Executor)</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ForwardingZKClientService.html" title="class in org.apache.twill.zookeeper">ForwardingZKClientService</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillController.html#addLogHandler(org.apache.twill.api.logging.LogHandler)">addLogHandler(LogHandler)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a></dt> +<dd> +<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> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillPreparer.html#addLogHandler(org.apache.twill.api.logging.LogHandler)">addLogHandler(LogHandler)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></dt> +<dd> +<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 an application log.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/Command.Builder.html#addOption(java.lang.String,%20java.lang.String)">addOption(String, String)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/Command.Builder.html" title="class in org.apache.twill.api">Command.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/Command.Builder.html#addOptions(java.util.Map)">addOptions(Map<String, String>)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/Command.Builder.html" title="class in org.apache.twill.api">Command.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillPreparer.html#addSecureStore(org.apache.twill.api.SecureStore)">addSecureStore(SecureStore)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></dt> +<dd> +<div class="block">Adds security credentials for the runtime environment to gives application access to resources.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/ServiceAnnouncer.html#announce(java.lang.String,%20int)">announce(String, int)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/ServiceAnnouncer.html" title="interface in org.apache.twill.api">ServiceAnnouncer</a></dt> +<dd> +<div class="block">Registers an endpoint that could be discovered by external party.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/ServiceAnnouncer.html#announce(java.lang.String,%20int,%20byte[])">announce(String, int, byte[])</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/ServiceAnnouncer.html" title="interface in org.apache.twill.api">ServiceAnnouncer</a></dt> +<dd> +<div class="block">Registers an endpoint that could be discovered by external party with a payload.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.AfterPlacementPolicy.html#anyOrder()">anyOrder()</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.AfterPlacementPolicy.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.AfterPlacementPolicy</a></dt> +<dd> +<div class="block">No particular execution order is needed.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.AfterRunnable.html#anyOrder()">anyOrder()</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.AfterRunnable.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.AfterRunnable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.PlacementPolicySetter.html#anyOrder()">anyOrder()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.PlacementPolicySetter.html" title="class in org.apache.twill.api">TwillSpecification.Builder.PlacementPolicySetter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.RunnableSetter.html#anyOrder()">anyOrder()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.RunnableSetter.html" title="class in org.apache.twill.api">TwillSpecification.Builder.RunnableSetter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/Location.html#append(java.lang.String)">append(String)</a></span> - Method in interface org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a></dt> +<dd> +<div class="block">Appends the child to the current <a href="./org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html#apply()">apply()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.MoreFile.html" title="class in org.apache.twill.api">TwillSpecification.Builder.MoreFile</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/ServiceController.html#awaitTerminated()">awaitTerminated()</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api">ServiceController</a></dt> +<dd> +<div class="block">Waits for termination of the remote service.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/ServiceController.html#awaitTerminated(long,%20java.util.concurrent.TimeUnit)">awaitTerminated(long, TimeUnit)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api">ServiceController</a></dt> +<dd> +<div class="block">Waits for termination of the remote service for no more than the given timeout limit.</div> +</dd> +</dl> +<a name="_B_"> +<!-- --> +</a> +<h2 class="title">B</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/twill/api/ResourceSpecification.html#BASIC">BASIC</a></span> - Static variable in interface org.apache.twill.api.<a href="./org/apache/twill/api/ResourceSpecification.html" title="interface in org.apache.twill.api">ResourceSpecification</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.FirstOrder.html#begin(java.lang.String,%20java.lang.String...)">begin(String, String...)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.FirstOrder.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.FirstOrder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.OrderSetter.html#begin(java.lang.String,%20java.lang.String...)">begin(String, String...)</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.OrderSetter.html" title="class in org.apache.twill.api">TwillSpecification.Builder.OrderSetter</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client"><span class="strong">BrokerInfo</span></a> - Class in <a href="./org/apache/twill/kafka/client/package-summary.html">org.apache.twill.kafka.client</a></dt> +<dd> +<div class="block">Represents broker information.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/BrokerInfo.html#BrokerInfo()">BrokerInfo()</a></span> - Constructor for class org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client">BrokerInfo</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/kafka/client/BrokerService.html" title="interface in org.apache.twill.kafka.client"><span class="strong">BrokerService</span></a> - Interface in <a href="./org/apache/twill/kafka/client/package-summary.html">org.apache.twill.kafka.client</a></dt> +<dd> +<div class="block">Service for providing information of kafka brokers.</div> +</dd> +<dt><a href="./org/apache/twill/kafka/client/BrokerService.BrokerChangeListener.html" title="class in org.apache.twill.kafka.client"><span class="strong">BrokerService.BrokerChangeListener</span></a> - Class in <a href="./org/apache/twill/kafka/client/package-summary.html">org.apache.twill.kafka.client</a></dt> +<dd> +<div class="block">Listener for changes in broker list.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/BrokerService.BrokerChangeListener.html#BrokerService.BrokerChangeListener()">BrokerService.BrokerChangeListener()</a></span> - Constructor for class org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/BrokerService.BrokerChangeListener.html" title="class in org.apache.twill.kafka.client">BrokerService.BrokerChangeListener</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/Command.Builder.html#build()">build()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/Command.Builder.html" title="class in org.apache.twill.api">Command.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/ResourceSpecification.Builder.Build.html#build()">build()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/ResourceSpecification.Builder.Build.html" title="class in org.apache.twill.api">ResourceSpecification.Builder.Build</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillRunnableSpecification.Builder.AfterConfigs.html#build()">build()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillRunnableSpecification.Builder.AfterConfigs.html" title="class in org.apache.twill.api">TwillRunnableSpecification.Builder.AfterConfigs</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.AfterOrder.html#build()">build()</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.AfterOrder.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.AfterOrder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillSpecification.Builder.OrderSetter.html#build()">build()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/TwillSpecification.Builder.OrderSetter.html" title="class in org.apache.twill.api">TwillSpecification.Builder.OrderSetter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClientService.Builder.html#build()">build()</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClientService.Builder.html" title="class in org.apache.twill.zookeeper">ZKClientService.Builder</a></dt> +<dd> +<div class="block">Creates an instance of <a href="./org/apache/twill/zookeeper/ZKClientService.html" title="interface in org.apache.twill.zookeeper"><code>ZKClientService</code></a> with the settings of this builder.</div> +</dd> +<dt><a href="./org/apache/twill/ext/BundledJarRunnable.html" title="class in org.apache.twill.ext"><span class="strong">BundledJarRunnable</span></a> - Class in <a href="./org/apache/twill/ext/package-summary.html">org.apache.twill.ext</a></dt> +<dd> +<div class="block">Uses <a href="./org/apache/twill/ext/BundledJarRunnable.html" title="class in org.apache.twill.ext"><code>BundledJarRunnable</code></a> to run a bundled jar.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/ext/BundledJarRunnable.html#BundledJarRunnable()">BundledJarRunnable()</a></span> - Constructor for class org.apache.twill.ext.<a href="./org/apache/twill/ext/BundledJarRunnable.html" title="class in org.apache.twill.ext">BundledJarRunnable</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/ext/BundledJarRunner.html" title="class in org.apache.twill.ext"><span class="strong">BundledJarRunner</span></a> - Class in <a href="./org/apache/twill/ext/package-summary.html">org.apache.twill.ext</a></dt> +<dd> +<div class="block">Runs a bundled jar specified by jarPath.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/ext/BundledJarRunner.html#BundledJarRunner(java.io.File,%20org.apache.twill.ext.BundledJarRunner.Arguments)">BundledJarRunner(File, BundledJarRunner.Arguments)</a></span> - Constructor for class org.apache.twill.ext.<a href="./org/apache/twill/ext/BundledJarRunner.html" title="class in org.apache.twill.ext">BundledJarRunner</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/ext/BundledJarRunner.Arguments.html" title="class in org.apache.twill.ext"><span class="strong">BundledJarRunner.Arguments</span></a> - Class in <a href="./org/apache/twill/ext/package-summary.html">org.apache.twill.ext</a></dt> +<dd> +<div class="block">Contains runtime arguments for <a href="./org/apache/twill/ext/BundledJarRunner.html" title="class in org.apache.twill.ext"><code>BundledJarRunner</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/ext/BundledJarRunner.Arguments.html#BundledJarRunner.Arguments(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String[])">BundledJarRunner.Arguments(String, String, String, String[])</a></span> - Constructor for class org.apache.twill.ext.<a href="./org/apache/twill/ext/BundledJarRunner.Arguments.html" title="class in org.apache.twill.ext">BundledJarRunner.Arguments</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/ext/BundledJarRunner.Arguments.Builder.html" title="class in org.apache.twill.ext"><span class="strong">BundledJarRunner.Arguments.Builder</span></a> - Class in <a href="./org/apache/twill/ext/package-summary.html">org.apache.twill.ext</a></dt> +<dd> +<div class="block">Builder for <a href="./org/apache/twill/ext/BundledJarRunner.Arguments.html" title="class in org.apache.twill.ext"><code>BundledJarRunner.Arguments</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/ext/BundledJarRunner.Arguments.Builder.html#BundledJarRunner.Arguments.Builder()">BundledJarRunner.Arguments.Builder()</a></span> - Constructor for class org.apache.twill.ext.<a href="./org/apache/twill/ext/BundledJarRunner.Arguments.Builder.html" title="class in org.apache.twill.ext">BundledJarRunner.Arguments.Builder</a></dt> +<dd> </dd> +</dl> +<a name="_C_"> +<!-- --> +</a> +<h2 class="title">C</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/twill/common/Cancellable.html#cancel()">cancel()</a></span> - Method in interface org.apache.twill.common.<a href="./org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common">Cancellable</a></dt> +<dd> +<div class="block">Attempts to cancel execution of this task.</div> +</dd> +<dt><a href="./org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common"><span class="strong">Cancellable</span></a> - Interface in <a href="./org/apache/twill/common/package-summary.html">org.apache.twill.common</a></dt> +<dd> +<div class="block">Something, usually a task, that can be cancelled.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/BrokerService.BrokerChangeListener.html#changed(org.apache.twill.kafka.client.BrokerService)">changed(BrokerService)</a></span> - Method in class org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/BrokerService.BrokerChangeListener.html" title="class in org.apache.twill.kafka.client">BrokerService.BrokerChangeListener</a></dt> +<dd> +<div class="block">Invoked when there is a change in the broker list.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillController.html#changeInstances(java.lang.String,%20int)">changeInstances(String, int)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a></dt> +<dd> +<div class="block">Changes the number of running instances of a given runnable.</div> +</dd> +<dt><a href="./org/apache/twill/api/ClassAcceptor.html" title="class in org.apache.twill.api"><span class="strong">ClassAcceptor</span></a> - Class in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">Class that can be used to determine if class can be accepted.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/ClassAcceptor.html#ClassAcceptor()">ClassAcceptor()</a></span> - Constructor for class org.apache.twill.api.<a href="./org/apache/twill/api/ClassAcceptor.html" title="class in org.apache.twill.api">ClassAcceptor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/discovery/ZKDiscoveryService.html#close()">close()</a></span> - Method in class org.apache.twill.discovery.<a href="./org/apache/twill/discovery/ZKDiscoveryService.html" title="class in org.apache.twill.discovery">ZKDiscoveryService</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/api/Command.html" title="interface in org.apache.twill.api"><span class="strong">Command</span></a> - Interface in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">Represents command objects.</div> +</dd> +<dt><a href="./org/apache/twill/api/Command.Builder.html" title="class in org.apache.twill.api"><span class="strong">Command.Builder</span></a> - Class in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">Builder for creating <a href="./org/apache/twill/api/Command.html" title="interface in org.apache.twill.api"><code>Command</code></a> object.</div> +</dd> +<dt><a href="./org/apache/twill/kafka/client/Compression.html" title="enum in org.apache.twill.kafka.client"><span class="strong">Compression</span></a> - Enum in <a href="./org/apache/twill/kafka/client/package-summary.html">org.apache.twill.kafka.client</a></dt> +<dd> +<div class="block">An Enum representing different compression codec options for publishing messages.</div> +</dd> +<dt><a href="./org/apache/twill/api/Configs.html" title="class in org.apache.twill.api"><span class="strong">Configs</span></a> - Class in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">Defines keys and default values constants being used for configuration.</div> +</dd> +<dt><a href="./org/apache/twill/api/Configs.Defaults.html" title="class in org.apache.twill.api"><span class="strong">Configs.Defaults</span></a> - Class in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">Defines default configuration values.</div> +</dd> +<dt><a href="./org/apache/twill/api/Configs.Keys.html" title="class in org.apache.twill.api"><span class="strong">Configs.Keys</span></a> - Class in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">Defines keys being used in configuration.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/AbstractTwillRunnable.html#configure()">configure()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/AbstractTwillRunnable.html" title="class in org.apache.twill.api">AbstractTwillRunnable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/EventHandler.html#configure()">configure()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/EventHandler.html" title="class in org.apache.twill.api">EventHandler</a></dt> +<dd> +<div class="block">Returns an <a href="./org/apache/twill/api/EventHandlerSpecification.html" title="interface in org.apache.twill.api"><code>EventHandlerSpecification</code></a> for configuring this handler class.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillApplication.html#configure()">configure()</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api">TwillApplication</a></dt> +<dd> +<div class="block">Invoked when launching the application on the client side.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillRunnable.html#configure()">configure()</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a></dt> +<dd> +<div class="block">Called at submission time.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/ext/BundledJarRunnable.html#configure()">configure()</a></span> - Method in class org.apache.twill.ext.<a href="./org/apache/twill/ext/BundledJarRunnable.html" title="class in org.apache.twill.ext">BundledJarRunnable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/KafkaConsumer.Preparer.html#consume(org.apache.twill.kafka.client.KafkaConsumer.MessageCallback)">consume(KafkaConsumer.MessageCallback)</a></span> - Method in interface org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a></dt> +<dd> +<div class="block">Starts the consumption as being configured by this <a href="./org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client"><code>KafkaConsumer.Preparer</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/discovery/ServiceDiscovered.html#contains(org.apache.twill.discovery.Discoverable)">contains(Discoverable)</a></span> - Method in interface org.apache.twill.discovery.<a href="./org/apache/twill/discovery/ServiceDiscovered.html" title="interface in org.apache.twill.discovery">ServiceDiscovered</a></dt> +<dd> +<div class="block">Checks if the given discoverable contains in the current discovery list.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/EventHandler.html#context">context</a></span> - Variable in class org.apache.twill.api.<a href="./org/apache/twill/api/EventHandler.html" title="class in org.apache.twill.api">EventHandler</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/FileContextLocationFactory.html#create(java.lang.String)">create(String)</a></span> - Method in class org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/FileContextLocationFactory.html" title="class in org.apache.twill.filesystem">FileContextLocationFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/FileContextLocationFactory.html#create(java.net.URI)">create(URI)</a></span> - Method in class org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/FileContextLocationFactory.html" title="class in org.apache.twill.filesystem">FileContextLocationFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/LocalLocationFactory.html#create(java.lang.String)">create(String)</a></span> - Method in class org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/LocalLocationFactory.html" title="class in org.apache.twill.filesystem">LocalLocationFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/LocalLocationFactory.html#create(java.net.URI)">create(URI)</a></span> - Method in class org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/LocalLocationFactory.html" title="class in org.apache.twill.filesystem">LocalLocationFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/LocationFactory.html#create(java.lang.String)">create(String)</a></span> - Method in interface org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></dt> +<dd> +<div class="block">Creates an instance of <a href="./org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a> of the given path.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/LocationFactory.html#create(java.net.URI)">create(URI)</a></span> - Method in interface org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></dt> +<dd> +<div class="block">Creates an instance of <a href="./org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a> based on <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net"><code>URI</code></a> <code>uri</code>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/yarn/YarnSecureStore.html#create(org.apache.hadoop.security.Credentials)">create(Credentials)</a></span> - Static method in class org.apache.twill.yarn.<a href="./org/apache/twill/yarn/YarnSecureStore.html" title="class in org.apache.twill.yarn">YarnSecureStore</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/AbstractZKClient.html#create(java.lang.String,%20byte[],%20org.apache.zookeeper.CreateMode)">create(String, byte[], CreateMode)</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/AbstractZKClient.html" title="class in org.apache.twill.zookeeper">AbstractZKClient</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/AbstractZKClient.html#create(java.lang.String,%20byte[],%20org.apache.zookeeper.CreateMode,%20boolean)">create(String, byte[], CreateMode, boolean)</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/AbstractZKClient.html" title="class in org.apache.twill.zookeeper">AbstractZKClient</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/AbstractZKClient.html#create(java.lang.String,%20byte[],%20org.apache.zookeeper.CreateMode,%20java.lang.Iterable)">create(String, byte[], CreateMode, Iterable<ACL>)</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/AbstractZKClient.html" title="class in org.apache.twill.zookeeper">AbstractZKClient</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ForwardingZKClient.html#create(java.lang.String,%20byte[],%20org.apache.zookeeper.CreateMode,%20boolean,%20java.lang.Iterable)">create(String, byte[], CreateMode, boolean, Iterable<ACL>)</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ForwardingZKClient.html" title="class in org.apache.twill.zookeeper">ForwardingZKClient</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClient.html#create(java.lang.String,%20byte[],%20org.apache.zookeeper.CreateMode)">create(String, byte[], CreateMode)</a></span> - Method in interface org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></dt> +<dd> +<div class="block">Creates a path in zookeeper.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClient.html#create(java.lang.String,%20byte[],%20org.apache.zookeeper.CreateMode,%20boolean)">create(String, byte[], CreateMode, boolean)</a></span> - Method in interface org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></dt> +<dd> +<div class="block">Creates a path in zookeeper.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClient.html#create(java.lang.String,%20byte[],%20org.apache.zookeeper.CreateMode,%20java.lang.Iterable)">create(String, byte[], CreateMode, Iterable<ACL>)</a></span> - Method in interface org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></dt> +<dd> +<div class="block">Creates a path in zookeeper.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClient.html#create(java.lang.String,%20byte[],%20org.apache.zookeeper.CreateMode,%20boolean,%20java.lang.Iterable)">create(String, byte[], CreateMode, boolean, Iterable<ACL>)</a></span> - Method in interface org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></dt> +<dd> +<div class="block">Creates a path in zookeeper, with given data and create mode.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/ext/BundledJarRunner.Arguments.Builder.html#createArguments()">createArguments()</a></span> - Method in class org.apache.twill.ext.<a href="./org/apache/twill/ext/BundledJarRunner.Arguments.Builder.html" title="class in org.apache.twill.ext">BundledJarRunner.Arguments.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/common/Threads.html#createDaemonThreadFactory(java.lang.String)">createDaemonThreadFactory(String)</a></span> - Static method in class org.apache.twill.common.<a href="./org/apache/twill/common/Threads.html" title="class in org.apache.twill.common">Threads</a></dt> +<dd> +<div class="block">Handy method to create <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ThreadFactory.html?is-external=true"; title="class or interface in java.util.concurrent"><code>ThreadFactory</code></a> that creates daemon threads with the given name format.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillContext.html#createLock(java.lang.String)">createLock(String)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillContext.html" title="interface in org.apache.twill.api">TwillContext</a></dt> +<dd> +<div class="block">Creates a <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html?is-external=true"; title="class or interface in java.util.concurrent.locks"><code>Lock</code></a> for performing locking mechanism within the same <a href="./org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api"><code>TwillApplication</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/Location.html#createNew()">createNew()</a></span> - Method in interface org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a></dt> +<dd> +<div class="block">Atomically creates a new, empty file named by this abstract pathname if and only if a file with this name + does not yet exist.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/Location.html#createNew(java.lang.String)">createNew(String)</a></span> - Method in interface org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a></dt> +<dd> +<div class="block">Atomically creates a new, empty file named by this abstract pathname if and only if a file with this name + does not yet exist.</div> +</dd> +</dl> +<a name="_D_"> +<!-- --> +</a> +<h2 class="title">D</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClientServices.html#delegate(org.apache.twill.zookeeper.ZKClient)">delegate(ZKClient)</a></span> - Static method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClientServices.html" title="class in org.apache.twill.zookeeper">ZKClientServices</a></dt> +<dd> +<div class="block">Creates a <a href="./org/apache/twill/zookeeper/ZKClientService.html" title="interface in org.apache.twill.zookeeper"><code>ZKClientService</code></a> from the given <a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper"><code>ZKClient</code></a> if the given <a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper"><code>ZKClient</code></a> is an instance of + <a href="./org/apache/twill/zookeeper/ZKClientService.html" title="interface in org.apache.twill.zookeeper"><code>ZKClientService</code></a> or is a <a href="./org/apache/twill/zookeeper/ForwardingZKClient.html" title="class in org.apache.twill.zookeeper"><code>ForwardingZKClient</code></a> that eventually trace back to a delegate of type + <a href="./org/apache/twill/zookeeper/ZKClientService.html" title="interface in org.apache.twill.zookeeper"><code>ZKClientService</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClientServices.html#delegate(org.apache.twill.zookeeper.ZKClient,%20org.apache.twill.zookeeper.ZKClientService)">delegate(ZKClient, ZKClientService)</a></span> - Static method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClientServices.html" title="class in org.apache.twill.zookeeper">ZKClientServices</a></dt> +<dd> +<div class="block">Creates a <a href="./org/apache/twill/zookeeper/ZKClientService.html" title="interface in org.apache.twill.zookeeper"><code>ZKClientService</code></a> that for all <a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper"><code>ZKClient</code></a> methods would be delegated to another + <a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper"><code>ZKClient</code></a>, while methods for <a href="./org/apache/twill/zookeeper/ZKClientService.html" title="interface in org.apache.twill.zookeeper"><code>ZKClientService</code></a> would be delegated to another <a href="./org/apache/twill/zookeeper/ZKClientService.html" title="interface in org.apache.twill.zookeeper"><code>ZKClientService</code></a>, + which the given <a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper"><code>ZKClient</code></a> and <a href="./org/apache/twill/zookeeper/ZKClientService.html" title="interface in org.apache.twill.zookeeper"><code>ZKClientService</code></a> could be different instances.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/Location.html#delete()">delete()</a></span> - Method in interface org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a></dt> +<dd> +<div class="block">Deletes the file or directory denoted by this abstract pathname.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/Location.html#delete(boolean)">delete(boolean)</a></span> - Method in interface org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a></dt> +<dd> +<div class="block">Deletes the file or directory denoted by this abstract pathname.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/AbstractZKClient.html#delete(java.lang.String)">delete(String)</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/AbstractZKClient.html" title="class in org.apache.twill.zookeeper">AbstractZKClient</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ForwardingZKClient.html#delete(java.lang.String,%20int)">delete(String, int)</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ForwardingZKClient.html" title="class in org.apache.twill.zookeeper">ForwardingZKClient</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClient.html#delete(java.lang.String)">delete(String)</a></span> - Method in interface org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></dt> +<dd> +<div class="block">Deletes the node of the given path without matching version.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClient.html#delete(java.lang.String,%20int)">delete(String, int)</a></span> - Method in interface org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></dt> +<dd> +<div class="block">Deletes the node of the given path that match the given version.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/AbstractTwillRunnable.html#destroy()">destroy()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/AbstractTwillRunnable.html" title="class in org.apache.twill.api">AbstractTwillRunnable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/EventHandler.html#destroy()">destroy()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/EventHandler.html" title="class in org.apache.twill.api">EventHandler</a></dt> +<dd> +<div class="block">Invoked by the application when shutting down.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillRunnable.html#destroy()">destroy()</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a></dt> +<dd> +<div class="block">Called when the <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Runnable.html?is-external=true#run()" title="class or interface in java.lang"><code>Runnable.run()</code></a> completed.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/ext/BundledJarRunnable.html#destroy()">destroy()</a></span> - Method in class org.apache.twill.ext.<a href="./org/apache/twill/ext/BundledJarRunnable.html" title="class in org.apache.twill.ext">BundledJarRunnable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillContext.html#discover(java.lang.String)">discover(String)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillContext.html" title="interface in org.apache.twill.api">TwillContext</a></dt> +<dd> +<div class="block">Discover service with the given name that is announced within the same <a href="./org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api"><code>TwillApplication</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/discovery/DiscoveryServiceClient.html#discover(java.lang.String)">discover(String)</a></span> - Method in interface org.apache.twill.discovery.<a href="./org/apache/twill/discovery/DiscoveryServiceClient.html" title="interface in org.apache.twill.discovery">DiscoveryServiceClient</a></dt> +<dd> +<div class="block">Discover service with the given name.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/discovery/InMemoryDiscoveryService.html#discover(java.lang.String)">discover(String)</a></span> - Method in class org.apache.twill.discovery.<a href="./org/apache/twill/discovery/InMemoryDiscoveryService.html" title="class in org.apache.twill.discovery">InMemoryDiscoveryService</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/discovery/ZKDiscoveryService.html#discover(java.lang.String)">discover(String)</a></span> - Method in class org.apache.twill.discovery.<a href="./org/apache/twill/discovery/ZKDiscoveryService.html" title="class in org.apache.twill.discovery">ZKDiscoveryService</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/discovery/Discoverable.html" title="class in org.apache.twill.discovery"><span class="strong">Discoverable</span></a> - Class in <a href="./org/apache/twill/discovery/package-summary.html">org.apache.twill.discovery</a></dt> +<dd> +<div class="block">Discoverable defines the attributes of service to be discovered.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/discovery/Discoverable.html#Discoverable(java.lang.String,%20java.net.InetSocketAddress,%20byte[])">Discoverable(String, InetSocketAddress, byte[])</a></span> - Constructor for class org.apache.twill.discovery.<a href="./org/apache/twill/discovery/Discoverable.html" title="class in org.apache.twill.discovery">Discoverable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/discovery/Discoverable.html#Discoverable(java.lang.String,%20java.net.InetSocketAddress)">Discoverable(String, InetSocketAddress)</a></span> - Constructor for class org.apache.twill.discovery.<a href="./org/apache/twill/discovery/Discoverable.html" title="class in org.apache.twill.discovery">Discoverable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillController.html#discoverService(java.lang.String)">discoverService(String)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a></dt> +<dd> +<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> +</dd> +<dt><a href="./org/apache/twill/discovery/DiscoveryService.html" title="interface in org.apache.twill.discovery"><span class="strong">DiscoveryService</span></a> - Interface in <a href="./org/apache/twill/discovery/package-summary.html">org.apache.twill.discovery</a></dt> +<dd> +<div class="block">DiscoveryService defines interface for registering <a href="./org/apache/twill/discovery/Discoverable.html" title="class in org.apache.twill.discovery"><code>Discoverable</code></a>.</div> +</dd> +<dt><a href="./org/apache/twill/discovery/DiscoveryServiceClient.html" title="interface in org.apache.twill.discovery"><span class="strong">DiscoveryServiceClient</span></a> - Interface in <a href="./org/apache/twill/discovery/package-summary.html">org.apache.twill.discovery</a></dt> +<dd> +<div class="block">Interface for <a href="./org/apache/twill/discovery/DiscoveryServiceClient.html" title="interface in org.apache.twill.discovery"><code>DiscoveryServiceClient</code></a> to discover services registered with <a href="./org/apache/twill/discovery/DiscoveryService.html" title="interface in org.apache.twill.discovery"><code>DiscoveryService</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/ext/BundledJarRunnable.html#doInitialize(org.apache.twill.api.TwillContext)">doInitialize(TwillContext)</a></span> - Method in class org.apache.twill.ext.<a href="./org/apache/twill/ext/BundledJarRunnable.html" title="class in org.apache.twill.ext">BundledJarRunnable</a></dt> +<dd> </dd> +</dl> +<a name="_E_"> +<!-- --> +</a> +<h2 class="title">E</h2> +<dl> +<dt><a href="./org/apache/twill/api/ElectionHandler.html" title="interface in org.apache.twill.api"><span class="strong">ElectionHandler</span></a> - Interface in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">Handles events of election/un-election of leader.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillContext.html#electLeader(java.lang.String,%20org.apache.twill.api.ElectionHandler)">electLeader(String, ElectionHandler)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillContext.html" title="interface in org.apache.twill.api">TwillContext</a></dt> +<dd> +<div class="block">Register to participate in a leader election by instances within the same <a href="./org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api"><code>TwillApplication</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillPreparer.html#enableDebugging(java.lang.String...)">enableDebugging(String...)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></dt> +<dd> +<div class="block">Enable debugging for runnables, without suspending the virtual machine to wait for the debugger.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillPreparer.html#enableDebugging(boolean,%20java.lang.String...)">enableDebugging(boolean, String...)</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></dt> +<dd> +<div class="block">Enable debugging for runnables.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/discovery/Discoverable.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.twill.discovery.<a href="./org/apache/twill/discovery/Discoverable.html" title="class in org.apache.twill.discovery">Discoverable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/ext/BundledJarRunner.Arguments.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.twill.ext.<a href="./org/apache/twill/ext/BundledJarRunner.Arguments.html" title="class in org.apache.twill.ext">BundledJarRunner.Arguments</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/BrokerInfo.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/BrokerInfo.html" title="class in org.apache.twill.kafka.client">BrokerInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/TopicPartition.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/TopicPartition.html" title="class in org.apache.twill.kafka.client">TopicPartition</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/api/EventHandler.html" title="class in org.apache.twill.api"><span class="strong">EventHandler</span></a> - Class in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">A callback handler for acting on application events related to <a href="./org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> lifecycle events.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/EventHandler.html#EventHandler()">EventHandler()</a></span> - Constructor for class org.apache.twill.api.<a href="./org/apache/twill/api/EventHandler.html" title="class in org.apache.twill.api">EventHandler</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/api/EventHandler.TimeoutAction.html" title="class in org.apache.twill.api"><span class="strong">EventHandler.TimeoutAction</span></a> - Class in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">Represents action to act upon runnable launch timeout.</div> +</dd> +<dt><a href="./org/apache/twill/api/EventHandler.TimeoutEvent.html" title="class in org.apache.twill.api"><span class="strong">EventHandler.TimeoutEvent</span></a> - Class in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">This class holds information about a launch timeout event.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/EventHandler.TimeoutEvent.html#EventHandler.TimeoutEvent(java.lang.String,%20int,%20int,%20long)">EventHandler.TimeoutEvent(String, int, int, long)</a></span> - Constructor for class org.apache.twill.api.<a href="./org/apache/twill/api/EventHandler.TimeoutEvent.html" title="class in org.apache.twill.api">EventHandler.TimeoutEvent</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/api/EventHandlerContext.html" title="interface in org.apache.twill.api"><span class="strong">EventHandlerContext</span></a> - Interface in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">Represents runtime context for <a href="./org/apache/twill/api/EventHandler.html" title="class in org.apache.twill.api"><code>EventHandler</code></a>.</div> +</dd> +<dt><a href="./org/apache/twill/api/EventHandlerSpecification.html" title="interface in org.apache.twill.api"><span class="strong">EventHandlerSpecification</span></a> - Interface in <a href="./org/apache/twill/api/package-summary.html">org.apache.twill.api</a></dt> +<dd> +<div class="block">Specification for <a href="./org/apache/twill/api/EventHandler.html" title="class in org.apache.twill.api"><code>EventHandler</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/Location.html#exists()">exists()</a></span> - Method in interface org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a></dt> +<dd> +<div class="block">Checks if the this location exists.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/AbstractZKClient.html#exists(java.lang.String)">exists(String)</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/AbstractZKClient.html" title="class in org.apache.twill.zookeeper">AbstractZKClient</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ForwardingZKClient.html#exists(java.lang.String,%20org.apache.zookeeper.Watcher)">exists(String, Watcher)</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ForwardingZKClient.html" title="class in org.apache.twill.zookeeper">ForwardingZKClient</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClient.html#exists(java.lang.String)">exists(String)</a></span> - Method in interface org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></dt> +<dd> +<div class="block">Checks if the path exists.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClient.html#exists(java.lang.String,%20org.apache.zookeeper.Watcher)">exists(String, Watcher)</a></span> - Method in interface org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></dt> +<dd> +<div class="block">Checks if the given path exists and leave a watcher on the node for watching creation/deletion/data changes + on the node.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/RetryStrategies.html#exponentialDelay(long,%20long,%20java.util.concurrent.TimeUnit)">exponentialDelay(long, long, TimeUnit)</a></span> - Static method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/RetryStrategies.html" title="class in org.apache.twill.zookeeper">RetryStrategies</a></dt> +<dd> +<div class="block">Creates a <a href="./org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a> that will increase delay exponentially between each retries.</div> +</dd> +</dl> +<a name="_F_"> +<!-- --> +</a> +<h2 class="title">F</h2> +<dl> +<dt><a href="./org/apache/twill/kafka/client/FetchedMessage.html" title="interface in org.apache.twill.kafka.client"><span class="strong">FetchedMessage</span></a> - Interface in <a href="./org/apache/twill/kafka/client/package-summary.html">org.apache.twill.kafka.client</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/Configs.Defaults.html#FILE_CONTEXT_CACHE_MAX_SIZE">FILE_CONTEXT_CACHE_MAX_SIZE</a></span> - Static variable in class org.apache.twill.api.<a href="./org/apache/twill/api/Configs.Defaults.html" title="class in org.apache.twill.api">Configs.Defaults</a></dt> +<dd> +<div class="block">Default size of the file context cache.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/Configs.Keys.html#FILE_CONTEXT_CACHE_MAX_SIZE">FILE_CONTEXT_CACHE_MAX_SIZE</a></span> - Static variable in class org.apache.twill.api.<a href="./org/apache/twill/api/Configs.Keys.html" title="class in org.apache.twill.api">Configs.Keys</a></dt> +<dd> +<div class="block">The maximum number of FileContext object cached by the FileContextLocationFactory.</div> +</dd> +<dt><a href="./org/apache/twill/filesystem/FileContextLocationFactory.html" title="class in org.apache.twill.filesystem"><span class="strong">FileContextLocationFactory</span></a> - Class in <a href="./org/apache/twill/filesystem/package-summary.html">org.apache.twill.filesystem</a></dt> +<dd> +<div class="block">A <a href="./org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem"><code>LocationFactory</code></a> implementation that uses <code>FileContext</code> to create <a href="./org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration)">FileContextLocationFactory(Configuration)</a></span> - Constructor for class org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/FileContextLocationFactory.html" title="class in org.apache.twill.filesystem">FileContextLocationFactory</a></dt> +<dd> +<div class="block">Same as <a href="./org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration,%20java.lang.String)"><code>FileContextLocationFactory(configuration, "/")</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration,%20java.lang.String)">FileContextLocationFactory(Configuration, String)</a></span> - Constructor for class org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/FileContextLocationFactory.html" title="class in org.apache.twill.filesystem">FileContextLocationFactory</a></dt> +<dd> +<div class="block">Creates a new instance.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.fs.FileContext,%20java.lang.String)">FileContextLocationFactory(Configuration, FileContext, String)</a></span> - Constructor for class org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/FileContextLocationFactory.html" title="class in org.apache.twill.filesystem">FileContextLocationFactory</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>Use <a href="./org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration)"><code>FileContextLocationFactory.FileContextLocationFactory(Configuration)</code></a> + or <a href="./org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration,%20java.lang.String)"><code>FileContextLocationFactory.FileContextLocationFactory(Configuration, String)</code></a> instead. The <code>FileContext</code> + provided to this method will only be used if the current user calling any methods of this class + matches with the <code>UserGroupInformation</code> of the <code>FileContext</code> instance.</i></div> +</div> +</dd> +<dt><a href="./org/apache/twill/launcher/FindFreePort.html" title="class in org.apache.twill.launcher"><span class="strong">FindFreePort</span></a> - Class in <a href="./org/apache/twill/launcher/package-summary.html">org.apache.twill.launcher</a></dt> +<dd> +<div class="block">Utility main class to find a free port on a machine.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/launcher/FindFreePort.html#FindFreePort()">FindFreePort()</a></span> - Constructor for class org.apache.twill.launcher.<a href="./org/apache/twill/launcher/FindFreePort.html" title="class in org.apache.twill.launcher">FindFreePort</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html#finished()">finished()</a></span> - Method in interface org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.MessageCallback</a></dt> +<dd> +<div class="block">Invoked when message consumption is stopped.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/RetryStrategies.html#fixDelay(long,%20java.util.concurrent.TimeUnit)">fixDelay(long, TimeUnit)</a></span> - Static method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/RetryStrategies.html" title="class in org.apache.twill.zookeeper">RetryStrategies</a></dt> +<dd> +<div class="block">Creates a <a href="./org/apache/twill/zookeeper/RetryStrategy.html" title="interface in org.apache.twill.zookeeper"><code>RetryStrategy</code></a> that imposes a fix delay between each retries.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/ElectionHandler.html#follower()">follower()</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/ElectionHandler.html" title="interface in org.apache.twill.api">ElectionHandler</a></dt> +<dd> +<div class="block">This method will get invoked when a participant is a follower in a + leader election process.</div> +</dd> +<dt><a href="./org/apache/twill/filesystem/ForwardingLocationFactory.html" title="class in org.apache.twill.filesystem"><span class="strong">ForwardingLocationFactory</span></a> - Class in <a href="./org/apache/twill/filesystem/package-summary.html">org.apache.twill.filesystem</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/filesystem/ForwardingLocationFactory.html#ForwardingLocationFactory(org.apache.twill.filesystem.LocationFactory)">ForwardingLocationFactory(LocationFactory)</a></span> - Constructor for class org.apache.twill.filesystem.<a href="./org/apache/twill/filesystem/ForwardingLocationFactory.html" title="class in org.apache.twill.filesystem">ForwardingLocationFactory</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/zookeeper/ForwardingZKClient.html" title="class in org.apache.twill.zookeeper"><span class="strong">ForwardingZKClient</span></a> - Class in <a href="./org/apache/twill/zookeeper/package-summary.html">org.apache.twill.zookeeper</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ForwardingZKClient.html#ForwardingZKClient(org.apache.twill.zookeeper.ZKClient)">ForwardingZKClient(ZKClient)</a></span> - Constructor for class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ForwardingZKClient.html" title="class in org.apache.twill.zookeeper">ForwardingZKClient</a></dt> +<dd> </dd> +<dt><a href="./org/apache/twill/zookeeper/ForwardingZKClientService.html" title="class in org.apache.twill.zookeeper"><span class="strong">ForwardingZKClientService</span></a> - Class in <a href="./org/apache/twill/zookeeper/package-summary.html">org.apache.twill.zookeeper</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ForwardingZKClientService.html#ForwardingZKClientService(org.apache.twill.zookeeper.ZKClientService)">ForwardingZKClientService(ZKClientService)</a></span> - Constructor for class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ForwardingZKClientService.html" title="class in org.apache.twill.zookeeper">ForwardingZKClientService</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/ext/BundledJarRunner.Arguments.Builder.html#from(org.apache.twill.ext.BundledJarRunner.Arguments)">from(BundledJarRunner.Arguments)</a></span> - Method in class org.apache.twill.ext.<a href="./org/apache/twill/ext/BundledJarRunner.Arguments.Builder.html" title="class in org.apache.twill.ext">BundledJarRunner.Arguments.Builder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/ext/BundledJarRunner.Arguments.html#fromArray(java.lang.String[])">fromArray(String[])</a></span> - Static method in class org.apache.twill.ext.<a href="./org/apache/twill/ext/BundledJarRunner.Arguments.html" title="class in org.apache.twill.ext">BundledJarRunner.Arguments</a></dt> +<dd> </dd> +</dl> +<a name="_G_"> +<!-- --> +</a> +<h2 class="title">G</h2> +<dl> +<dt><span class="strong"><a href="./org/apache/twill/api/Hosts.html#get()">get()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/Hosts.html" title="class in org.apache.twill.api">Hosts</a></dt> +<dd> +<div class="block">Get the list of hosts.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/Racks.html#get()">get()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/Racks.html" title="class in org.apache.twill.api">Racks</a></dt> +<dd> +<div class="block">Get the list of racks.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/kafka/client/KafkaPublisher.Ack.html#getAck()">getAck()</a></span> - Method in enum org.apache.twill.kafka.client.<a href="./org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a></dt> +<dd> +<div class="block">Returns the numerical ack number as understand by Kafka server.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ACLData.html#getACL()">getACL()</a></span> - Method in interface org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ACLData.html" title="interface in org.apache.twill.zookeeper">ACLData</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ForwardingZKClient.html#getACL(java.lang.String)">getACL(String)</a></span> - Method in class org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ForwardingZKClient.html" title="class in org.apache.twill.zookeeper">ForwardingZKClient</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/zookeeper/ZKClient.html#getACL(java.lang.String)">getACL(String)</a></span> - Method in interface org.apache.twill.zookeeper.<a href="./org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></dt> +<dd> +<div class="block">Retrieves the Stat and ACL being set at the given path.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/EventHandler.TimeoutEvent.html#getActualInstances()">getActualInstances()</a></span> - Method in class org.apache.twill.api.<a href="./org/apache/twill/api/EventHandler.TimeoutEvent.html" title="class in org.apache.twill.api">EventHandler.TimeoutEvent</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="./org/apache/twill/api/TwillContext.html#getApplicationArguments()">getApplicationArguments()</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/TwillContext.html" title="interface in org.apache.twill.api">TwillContext</a></dt> +<dd> +<div class="block">Returns the runtime arguments that are passed to the <a href="./org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api"><code>TwillApplication</code></a>.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/twill/api/ResourceReport.html#getApplicationId()">getApplicationId()</a></span> - Method in interface org.apache.twill.api.<a href="./org/apache/twill/api/ResourceReport.html" title="interface in org.apache.twill.api">ResourceReport</a></dt> +<dd> +<div class="block">Get the id of the application master.</div> +</dd> +
<TRUNCATED>
