| <!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>KafkaConsumer.Preparer (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="KafkaConsumer.Preparer (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><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> |
