| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.storm.kafka.spout (Storm 1.2.2 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.storm.kafka.spout (Storm 1.2.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/storm/kafka/monitor/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/storm/kafka/spout/internal/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/kafka/spout/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.storm.kafka.spout</h1> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><V,R></td> |
| <td class="colLast"> |
| <div class="block">A simple interface to allow compatibility with non java 8 code bases</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutRetryService</a></td> |
| <td class="colLast"> |
| <div class="block">Represents the logic that manages the retrial of failed tuples.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/KafkaTupleListener.html" title="interface in org.apache.storm.kafka.spout">KafkaTupleListener</a></td> |
| <td class="colLast"> |
| <div class="block">The KafkaTupleListener handles state changes of a kafka tuple inside a KafkaSpout.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/ManualPartitioner.html" title="interface in org.apache.storm.kafka.spout">ManualPartitioner</a></td> |
| <td class="colLast"> |
| <div class="block">A function used to assign partitions to this spout.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">Translate a <code>ConsumerRecord</code> to a tuple.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/SerializableDeserializer.html" title="interface in org.apache.storm.kafka.spout">SerializableDeserializer</a><T></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Avoid using this class.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/TopicFilter.html" title="interface in org.apache.storm.kafka.spout">TopicFilter</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">Based off of a given Kafka topic a ConsumerRecord came from it will be translated to a Storm tuple and emitted to a given stream</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/DefaultRecordTranslator.html" title="class in org.apache.storm.kafka.spout">DefaultRecordTranslator</a><K,V></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/EmptyKafkaTupleListener.html" title="class in org.apache.storm.kafka.spout">EmptyKafkaTupleListener</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpout.html" title="class in org.apache.storm.kafka.spout">KafkaSpout</a><K,V></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">KafkaSpoutConfig defines the required configuration to connect a consumer to a consumer group, as well as the subscribing topics</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><K,V></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutRetryExponentialBackoff.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutRetryExponentialBackoff</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout"><code>KafkaSpoutRetryService</code></a> using the exponential backoff formula.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutRetryExponentialBackoff.TimeInterval.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutRetryExponentialBackoff.TimeInterval</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/KafkaTuple.html" title="class in org.apache.storm.kafka.spout">KafkaTuple</a></td> |
| <td class="colLast"> |
| <div class="block">A list of Values in a tuple that can be routed to a given stream.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/ManualPartitionSubscription.html" title="class in org.apache.storm.kafka.spout">ManualPartitionSubscription</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/NamedSubscription.html" title="class in org.apache.storm.kafka.spout">NamedSubscription</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Please use <a href="../../../../../org/apache/storm/kafka/spout/ManualPartitionSubscription.html" title="class in org.apache.storm.kafka.spout"><code>ManualPartitionSubscription</code></a> with <a href="../../../../../org/apache/storm/kafka/spout/NamedTopicFilter.html" title="class in org.apache.storm.kafka.spout"><code>NamedTopicFilter</code></a> instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/NamedTopicFilter.html" title="class in org.apache.storm.kafka.spout">NamedTopicFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Filter that returns all partitions for the specified topics.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/PatternSubscription.html" title="class in org.apache.storm.kafka.spout">PatternSubscription</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Please use <a href="../../../../../org/apache/storm/kafka/spout/ManualPartitionSubscription.html" title="class in org.apache.storm.kafka.spout"><code>ManualPartitionSubscription</code></a> with <a href="../../../../../org/apache/storm/kafka/spout/PatternTopicFilter.html" title="class in org.apache.storm.kafka.spout"><code>PatternTopicFilter</code></a> instead</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/PatternTopicFilter.html" title="class in org.apache.storm.kafka.spout">PatternTopicFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Filter that returns all partitions for topics matching the given <a href="http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex"><code>Pattern</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/RoundRobinManualPartitioner.html" title="class in org.apache.storm.kafka.spout">RoundRobinManualPartitioner</a></td> |
| <td class="colLast"> |
| <div class="block">Assign partitions in a round robin fashion for all spouts, not just the ones that are alive.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/SimpleRecordTranslator.html" title="class in org.apache.storm.kafka.spout">SimpleRecordTranslator</a><K,V></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/Subscription.html" title="class in org.apache.storm.kafka.spout">Subscription</a></td> |
| <td class="colLast"> |
| <div class="block">A subscription to kafka.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/TopicPartitionComparator.html" title="class in org.apache.storm.kafka.spout">TopicPartitionComparator</a></td> |
| <td class="colLast"> |
| <div class="block">Singleton comparator of TopicPartitions.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.FirstPollOffsetStrategy.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.FirstPollOffsetStrategy</a></td> |
| <td class="colLast"> |
| <div class="block">Defines how the <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpout.html" title="class in org.apache.storm.kafka.spout"><code>KafkaSpout</code></a> seeks the offset to be used in the first poll to Kafka upon topology deployment.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a></td> |
| <td class="colLast"> |
| <div class="block">This enum controls when the tuple with the <code>ConsumerRecord</code> for an offset is marked as processed, i.e.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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 class="aboutLanguage"><script type="text/javascript" src="../../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/storm/kafka/monitor/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/storm/kafka/spout/internal/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/kafka/spout/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |