http://git-wip-us.apache.org/repos/asf/twill/blob/49f35954/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaClient.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaClient.html b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaClient.html new file mode 100644 index 0000000..539f846 --- /dev/null +++ b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaClient.html @@ -0,0 +1,237 @@ +<!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 Aug 25 09:24:51 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KafkaClient (Apache Twill 0.12.0 API)</title> +<meta name="date" content="2017-08-25"> +<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="KafkaClient (Apache Twill 0.12.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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/KafkaClient.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/kafka/client/FetchedMessage.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/KafkaClientService.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaClient.html" target="_top">Frames</a></li> +<li><a href="KafkaClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.twill.kafka.client</div> +<h2 title="Interface KafkaClient" class="title">Interface KafkaClient</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../org/apache/twill/kafka/client/KafkaClientService.html" title="interface in org.apache.twill.kafka.client">KafkaClientService</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">KafkaClient</span></pre> +<div class="block">Represents a kafka client that can publish/subscribe to a Kafka server cluster.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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="../../../../../org/apache/twill/kafka/client/KafkaConsumer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaClient.html#getConsumer()">getConsumer</a></strong>()</code> +<div class="block">Creates a <a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.html" title="interface in org.apache.twill.kafka.client"><code>KafkaConsumer</code></a> for consuming messages.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.html" title="interface in org.apache.twill.kafka.client">KafkaPublisher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaClient.html#getPublisher(org.apache.twill.kafka.client.KafkaPublisher.Ack,%20org.apache.twill.kafka.client.Compression)">getPublisher</a></strong>(<a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a> ack, + <a href="../../../../../org/apache/twill/kafka/client/Compression.html" title="enum in org.apache.twill.kafka.client">Compression</a> compression)</code> +<div class="block">Creates a <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.html" title="interface in org.apache.twill.kafka.client"><code>KafkaPublisher</code></a> that is ready for publish.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPublisher(org.apache.twill.kafka.client.KafkaPublisher.Ack, org.apache.twill.kafka.client.Compression)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPublisher</h4> +<pre><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.html" title="interface in org.apache.twill.kafka.client">KafkaPublisher</a> getPublisher(<a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a> ack, + <a href="../../../../../org/apache/twill/kafka/client/Compression.html" title="enum in org.apache.twill.kafka.client">Compression</a> compression)</pre> +<div class="block">Creates a <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.html" title="interface in org.apache.twill.kafka.client"><code>KafkaPublisher</code></a> that is ready for publish.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ack</code> - Type of ack that the publisher would use for all it's publish.</dd><dd><code>compression</code> - The compression type for messages published through the returned publisher.</dd> +<dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.html" title="interface in org.apache.twill.kafka.client"><code>KafkaPublisher</code></a>.</dd></dl> +</li> +</ul> +<a name="getConsumer()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getConsumer</h4> +<pre><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer</a> getConsumer()</pre> +<div class="block">Creates a <a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.html" title="interface in org.apache.twill.kafka.client"><code>KafkaConsumer</code></a> for consuming messages.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.html" title="interface in org.apache.twill.kafka.client"><code>KafkaConsumer</code></a>.</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/KafkaClient.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/kafka/client/FetchedMessage.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/KafkaClientService.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaClient.html" target="_top">Frames</a></li> +<li><a href="KafkaClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2013-2016 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/twill/blob/49f35954/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaClientService.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaClientService.html b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaClientService.html new file mode 100644 index 0000000..0213eb1 --- /dev/null +++ b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaClientService.html @@ -0,0 +1,209 @@ +<!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 Aug 25 09:24:51 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KafkaClientService (Apache Twill 0.12.0 API)</title> +<meta name="date" content="2017-08-25"> +<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="KafkaClientService (Apache Twill 0.12.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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/KafkaClientService.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/kafka/client/KafkaClient.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaClientService.html" target="_top">Frames</a></li> +<li><a href="KafkaClientService.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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.kafka.client</div> +<h2 title="Interface KafkaClientService" class="title">Interface KafkaClientService</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/twill/kafka/client/KafkaClient.html" title="interface in org.apache.twill.kafka.client">KafkaClient</a>, com.google.common.util.concurrent.Service</dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">KafkaClientService</span> +extends <a href="../../../../../org/apache/twill/kafka/client/KafkaClient.html" title="interface in org.apache.twill.kafka.client">KafkaClient</a>, com.google.common.util.concurrent.Service</pre> +<div class="block">A <a href="../../../../../org/apache/twill/kafka/client/KafkaClient.html" title="interface in org.apache.twill.kafka.client"><code>KafkaClient</code></a> that extends <code>Service</code> to provide lifecycle management.</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_com.google.common.util.concurrent.Service"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service</h3> +<code>com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State</code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.twill.kafka.client.KafkaClient"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.twill.kafka.client.<a href="../../../../../org/apache/twill/kafka/client/KafkaClient.html" title="interface in org.apache.twill.kafka.client">KafkaClient</a></h3> +<code><a href="../../../../../org/apache/twill/kafka/client/KafkaClient.html#getConsumer()">getConsumer</a>, <a href="../../../../../org/apache/twill/kafka/client/KafkaClient.html#getPublisher(org.apache.twill.kafka.client.KafkaPublisher.Ack,%20org.apache.twill.kafka.client.Compression)">getPublisher</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.google.common.util.concurrent.Service"> +<!-- --> +</a> +<h3>Methods inherited from interface com.google.common.util.concurrent.Service</h3> +<code>addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, start, startAndWait, startAsync, state, stop, stopAndWait, stopAsync</code></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/KafkaClientService.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/kafka/client/KafkaClient.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaClientService.html" target="_top">Frames</a></li> +<li><a href="KafkaClientService.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2013-2016 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/twill/blob/49f35954/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html new file mode 100644 index 0000000..7be3361 --- /dev/null +++ b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html @@ -0,0 +1,236 @@ +<!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 Aug 25 09:24:51 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KafkaConsumer.MessageCallback (Apache Twill 0.12.0 API)</title> +<meta name="date" content="2017-08-25"> +<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="KafkaConsumer.MessageCallback (Apache Twill 0.12.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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/KafkaConsumer.MessageCallback.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/kafka/client/KafkaConsumer.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html" target="_top">Frames</a></li> +<li><a href="KafkaConsumer.MessageCallback.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.twill.kafka.client</div> +<h2 title="Interface KafkaConsumer.MessageCallback" class="title">Interface KafkaConsumer.MessageCallback</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">KafkaConsumer.MessageCallback</span></pre> +<div class="block">Callback for receiving new messages.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html#finished()">finished</a></strong>()</code> +<div class="block">Invoked when message consumption is stopped.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html#onReceived(java.util.Iterator)">onReceived</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<a href="../../../../../org/apache/twill/kafka/client/FetchedMessage.html" title="interface in org.apache.twill.kafka.client">FetchedMessage</a>> messages)</code> +<div class="block">Invoked when new messages is available.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="onReceived(java.util.Iterator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onReceived</h4> +<pre>long onReceived(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<a href="../../../../../org/apache/twill/kafka/client/FetchedMessage.html" title="interface in org.apache.twill.kafka.client">FetchedMessage</a>> messages)</pre> +<div class="block">Invoked when new messages is available.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>messages</code> - Iterator of new messages. The <a href="../../../../../org/apache/twill/kafka/client/FetchedMessage.html" title="interface in org.apache.twill.kafka.client"><code>FetchedMessage</code></a> instance maybe reused in the Iterator + and across different invocation.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The offset of the message to be fetched next.</dd></dl> +</li> +</ul> +<a name="finished()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>finished</h4> +<pre>void finished()</pre> +<div class="block">Invoked when message consumption is stopped. When this method is invoked, + no more <a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html#onReceived(java.util.Iterator)"><code>onReceived(java.util.Iterator)</code></a> will get triggered.</div> +</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/KafkaConsumer.MessageCallback.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/kafka/client/KafkaConsumer.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html" target="_top">Frames</a></li> +<li><a href="KafkaConsumer.MessageCallback.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2013-2016 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/twill/blob/49f35954/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaConsumer.Preparer.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaConsumer.Preparer.html b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaConsumer.Preparer.html new file mode 100644 index 0000000..b45eecf --- /dev/null +++ b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaConsumer.Preparer.html @@ -0,0 +1,281 @@ +<!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 Aug 25 09:24:51 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KafkaConsumer.Preparer (Apache Twill 0.12.0 API)</title> +<meta name="date" content="2017-08-25"> +<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="KafkaConsumer.Preparer (Apache Twill 0.12.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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/KafkaConsumer.Preparer.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/kafka/client/KafkaConsumer.MessageCallback.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" target="_top">Frames</a></li> +<li><a href="KafkaConsumer.Preparer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.twill.kafka.client</div> +<h2 title="Interface KafkaConsumer.Preparer" class="title">Interface KafkaConsumer.Preparer</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">KafkaConsumer.Preparer</span></pre> +<div class="block">A builder for preparing message consumption.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html#add(java.lang.String,%20int,%20long)">add</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> topic, + int partition, + long offset)</code> +<div class="block">Consumes messages from a given offset.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html#addFromBeginning(java.lang.String,%20int)">addFromBeginning</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> topic, + int partition)</code> +<div class="block">Consumes messages from the earliest message available.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html#addLatest(java.lang.String,%20int)">addLatest</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> topic, + int partition)</code> +<div class="block">Consumes messages from the latest message.</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/kafka/client/KafkaConsumer.Preparer.html#consume(org.apache.twill.kafka.client.KafkaConsumer.MessageCallback)">consume</a></strong>(<a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.MessageCallback</a> callback)</code> +<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> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="add(java.lang.String, int, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a> add(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> topic, + int partition, + long offset)</pre> +<div class="block">Consumes messages from a given offset. If the given offset is invalid, it'll start consuming from the + latest offset.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - Topic to consume from.</dd><dd><code>partition</code> - Partition in the topic to consume from.</dd><dd><code>offset</code> - Offset to starts with.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client"><code>KafkaConsumer.Preparer</code></a> instance.</dd></dl> +</li> +</ul> +<a name="addFromBeginning(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addFromBeginning</h4> +<pre><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a> addFromBeginning(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> topic, + int partition)</pre> +<div class="block">Consumes messages from the earliest message available.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - Topic to consume from.</dd><dd><code>partition</code> - Partition in the topic to consume from.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client"><code>KafkaConsumer.Preparer</code></a> instance.</dd></dl> +</li> +</ul> +<a name="addLatest(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addLatest</h4> +<pre><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a> addLatest(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> topic, + int partition)</pre> +<div class="block">Consumes messages from the latest message.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>topic</code> - Topic to consume from.</dd><dd><code>partition</code> - Partition in the topic to consume from.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client"><code>KafkaConsumer.Preparer</code></a> instance.</dd></dl> +</li> +</ul> +<a name="consume(org.apache.twill.kafka.client.KafkaConsumer.MessageCallback)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>consume</h4> +<pre><a href="../../../../../org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common">Cancellable</a> consume(<a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.MessageCallback</a> callback)</pre> +<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> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>callback</code> - The <a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html" title="interface in org.apache.twill.kafka.client"><code>KafkaConsumer.MessageCallback</code></a> for receiving new messages.</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 message consumption.</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/KafkaConsumer.Preparer.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/kafka/client/KafkaConsumer.MessageCallback.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" target="_top">Frames</a></li> +<li><a href="KafkaConsumer.Preparer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2013-2016 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/twill/blob/49f35954/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaConsumer.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaConsumer.html b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaConsumer.html new file mode 100644 index 0000000..e68f6ee --- /dev/null +++ b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaConsumer.html @@ -0,0 +1,240 @@ +<!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 Aug 25 09:24:51 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KafkaConsumer (Apache Twill 0.12.0 API)</title> +<meta name="date" content="2017-08-25"> +<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="KafkaConsumer (Apache Twill 0.12.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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/KafkaConsumer.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/kafka/client/KafkaClientService.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaConsumer.html" target="_top">Frames</a></li> +<li><a href="KafkaConsumer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.twill.kafka.client</div> +<h2 title="Interface KafkaConsumer" class="title">Interface KafkaConsumer</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">KafkaConsumer</span></pre> +<div class="block">A consumer for consuming (reading) messages published to a Kafka server 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> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.MessageCallback</a></strong></code> +<div class="block">Callback for receiving new messages.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a></strong></code> +<div class="block">A builder for preparing message consumption.</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"> </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="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.html#prepare()">prepare</a></strong>()</code> +<div class="block">Prepares for message consumption.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="prepare()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>prepare</h4> +<pre><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaConsumer.Preparer</a> prepare()</pre> +<div class="block">Prepares for message consumption.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.Preparer.html" title="interface in org.apache.twill.kafka.client"><code>KafkaConsumer.Preparer</code></a> to setup details about message consumption.</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/KafkaConsumer.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/kafka/client/KafkaClientService.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/KafkaConsumer.MessageCallback.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaConsumer.html" target="_top">Frames</a></li> +<li><a href="KafkaConsumer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2013-2016 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/twill/blob/49f35954/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaPublisher.Ack.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaPublisher.Ack.html b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaPublisher.Ack.html new file mode 100644 index 0000000..a059314 --- /dev/null +++ b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaPublisher.Ack.html @@ -0,0 +1,363 @@ +<!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 Aug 25 09:24:51 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KafkaPublisher.Ack (Apache Twill 0.12.0 API)</title> +<meta name="date" content="2017-08-25"> +<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="KafkaPublisher.Ack (Apache Twill 0.12.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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/KafkaPublisher.Ack.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/kafka/client/KafkaPublisher.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Preparer.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaPublisher.Ack.html" target="_top">Frames</a></li> +<li><a href="KafkaPublisher.Ack.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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.kafka.client</div> +<h2 title="Enum KafkaPublisher.Ack" class="title">Enum KafkaPublisher.Ack</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.twill.kafka.client.KafkaPublisher.Ack</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a>></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.html" title="interface in org.apache.twill.kafka.client">KafkaPublisher</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">KafkaPublisher.Ack</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a>></pre> +<div class="block">Represents the desired level of publish acknowledgment.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html#ALL_RECEIVED">ALL_RECEIVED</a></strong></code> +<div class="block">Waits for all replicas received data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html#FIRE_AND_FORGET">FIRE_AND_FORGET</a></strong></code> +<div class="block">Not wait for ack.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html#LEADER_RECEIVED">LEADER_RECEIVED</a></strong></code> +<div class="block">Waits for the leader received data.</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"> </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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html#getAck()">getAck</a></strong>()</code> +<div class="block">Returns the numerical ack number as understand by Kafka server.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html#valueOf(java.lang.String)">valueOf</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/ api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,%20java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/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"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="FIRE_AND_FORGET"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FIRE_AND_FORGET</h4> +<pre>public static final <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a> FIRE_AND_FORGET</pre> +<div class="block">Not wait for ack.</div> +</li> +</ul> +<a name="LEADER_RECEIVED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LEADER_RECEIVED</h4> +<pre>public static final <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a> LEADER_RECEIVED</pre> +<div class="block">Waits for the leader received data.</div> +</li> +</ul> +<a name="ALL_RECEIVED"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ALL_RECEIVED</h4> +<pre>public static final <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a> ALL_RECEIVED</pre> +<div class="block">Waits for all replicas received data.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (KafkaPublisher.Ack c : KafkaPublisher.Ack.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client">KafkaPublisher.Ack</a> valueOf(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true"; title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="getAck()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAck</h4> +<pre>public int getAck()</pre> +<div class="block">Returns the numerical ack number as understand by Kafka server.</div> +</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/KafkaPublisher.Ack.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/kafka/client/KafkaPublisher.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Preparer.html" title="interface in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaPublisher.Ack.html" target="_top">Frames</a></li> +<li><a href="KafkaPublisher.Ack.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2013-2016 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/twill/blob/49f35954/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaPublisher.Preparer.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaPublisher.Preparer.html b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaPublisher.Preparer.html new file mode 100644 index 0000000..948b3fd --- /dev/null +++ b/src/site/resources/apidocs-0.12.0/org/apache/twill/kafka/client/KafkaPublisher.Preparer.html @@ -0,0 +1,243 @@ +<!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 Aug 25 09:24:51 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KafkaPublisher.Preparer (Apache Twill 0.12.0 API)</title> +<meta name="date" content="2017-08-25"> +<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="KafkaPublisher.Preparer (Apache Twill 0.12.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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/KafkaPublisher.Preparer.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/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/TopicPartition.html" title="class in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaPublisher.Preparer.html" target="_top">Frames</a></li> +<li><a href="KafkaPublisher.Preparer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.twill.kafka.client</div> +<h2 title="Interface KafkaPublisher.Preparer" class="title">Interface KafkaPublisher.Preparer</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.html" title="interface in org.apache.twill.kafka.client">KafkaPublisher</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">KafkaPublisher.Preparer</span></pre> +<div class="block">A Preparer for preparing to publish messages to a given topic. An instance of this class could be reused + to send more messages after <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Preparer.html#send()"><code>send()</code></a> is called.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaPublisher.Preparer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Preparer.html#add(java.nio.ByteBuffer,%20java.lang.Object)">add</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true"; title="class or interface in java.nio">ByteBuffer</a> message, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> partitionKey)</code> +<div class="block">Adds the given message to the message set, partitioned with the given partition key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Preparer.html#send()">send</a></strong>()</code> +<div class="block">Sends all the messages being added through the <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Preparer.html#add(java.nio.ByteBuffer,%20java.lang.Object)"><code>add(java.nio.ByteBuffer, java.lang.Object)</code></a> method.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="add(java.nio.ByteBuffer, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre><a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Preparer.html" title="interface in org.apache.twill.kafka.client">KafkaPublisher.Preparer</a> add(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true"; title="class or interface in java.nio">ByteBuffer</a> message, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> partitionKey)</pre> +<div class="block">Adds the given message to the message set, partitioned with the given partition key.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - Remaining bytes in the ByteBuffer will be used as message payload. This method would + consume the ByteBuffer, meaning after this method returns, the remaining bytes in the + ByteBuffer would be <code>0</code>.</dd><dd><code>partitionKey</code> - Key for computing the partition Id to publish to. The <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang"><code>Object.hashCode()</code></a> method + will be invoke to compute the id.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Preparer.html" title="interface in org.apache.twill.kafka.client"><code>KafkaPublisher.Preparer</code></a> instance.</dd></dl> +</li> +</ul> +<a name="send()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>send</h4> +<pre>com.google.common.util.concurrent.ListenableFuture<<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a>> send()</pre> +<div class="block">Sends all the messages being added through the <a href="../../../../../org/apache/twill/kafka/client/KafkaPublisher.Preparer.html#add(java.nio.ByteBuffer,%20java.lang.Object)"><code>add(java.nio.ByteBuffer, java.lang.Object)</code></a> method.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>A <code>ListenableFuture</code> that will be completed when the send action is done. If publish is succeeded, + it returns number of messages published, otherwise the failure reason will be carried in the future. + The <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Future.html?is-external=true#cancel(boolean)" title="class or interface in java.util.concurrent"><code>Future.cancel(boolean)</code></a> method has no effect on the publish action.</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/KafkaPublisher.Preparer.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/kafka/client/KafkaPublisher.Ack.html" title="enum in org.apache.twill.kafka.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/twill/kafka/client/TopicPartition.html" title="class in org.apache.twill.kafka.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/twill/kafka/client/KafkaPublisher.Preparer.html" target="_top">Frames</a></li> +<li><a href="KafkaPublisher.Preparer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2013-2016 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
