Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / current / javadocs / org / apache / storm / kafka / spout / package-use.html
blob: 5a4a3c34a0c62d73fc39d8cb7246b396c00b414c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Package org.apache.storm.kafka.spout (Storm 2.4.0 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="Uses of Package org.apache.storm.kafka.spout (Storm 2.4.0 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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/kafka/spout/package-use.html" target="_top">Frames</a></li>
<li><a href="package-use.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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="Uses of Package org.apache.storm.kafka.spout" class="title">Uses of Package<br>org.apache.storm.kafka.spout</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../org/apache/storm/kafka/spout/package-summary.html">org.apache.storm.kafka.spout</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.storm.flux.examples">org.apache.storm.flux.examples</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.apache.storm.kafka.spout">org.apache.storm.kafka.spout</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.storm.kafka.spout.internal">org.apache.storm.kafka.spout.internal</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.apache.storm.sql.kafka">org.apache.storm.sql.kafka</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.storm.flux.examples">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../../org/apache/storm/kafka/spout/package-summary.html">org.apache.storm.kafka.spout</a> used by <a href="../../../../../org/apache/storm/flux/examples/package-summary.html">org.apache.storm.flux.examples</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/Func.html#org.apache.storm.flux.examples">Func</a>
<div class="block">A simple interface to allow compatibility with non java 8 code bases.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/RecordTranslator.html#org.apache.storm.flux.examples">RecordTranslator</a>
<div class="block">Translate a <code>ConsumerRecord</code> to a tuple.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.storm.kafka.spout">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../../org/apache/storm/kafka/spout/package-summary.html">org.apache.storm.kafka.spout</a> used by <a href="../../../../../org/apache/storm/kafka/spout/package-summary.html">org.apache.storm.kafka.spout</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/ByTopicRecordTranslator.html#org.apache.storm.kafka.spout">ByTopicRecordTranslator</a>
<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="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/FirstPollOffsetStrategy.html#org.apache.storm.kafka.spout">FirstPollOffsetStrategy</a>
<div class="block">Defines how the spout seeks the offset to be used in the first poll to Kafka upon topology deployment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/Func.html#org.apache.storm.kafka.spout">Func</a>
<div class="block">A simple interface to allow compatibility with non java 8 code bases.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/KafkaSpoutConfig.html#org.apache.storm.kafka.spout">KafkaSpoutConfig</a>
<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="altColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/KafkaSpoutConfig.Builder.html#org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/KafkaSpoutConfig.ProcessingGuarantee.html#org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a>
<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>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/KafkaSpoutMessageId.html#org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/KafkaSpoutRetryExponentialBackoff.TimeInterval.html#org.apache.storm.kafka.spout">KafkaSpoutRetryExponentialBackoff.TimeInterval</a>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/KafkaSpoutRetryService.html#org.apache.storm.kafka.spout">KafkaSpoutRetryService</a>
<div class="block">Represents the logic that manages the retrial of failed tuples.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/KafkaSpoutTopologyMainNamedTopics.html#org.apache.storm.kafka.spout">KafkaSpoutTopologyMainNamedTopics</a>
<div class="block">This example sets up 3 topologies to put data in Kafka via the KafkaBolt, and shows how to set up a topology that reads from some Kafka topics using the KafkaSpout.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/KafkaTuple.html#org.apache.storm.kafka.spout">KafkaTuple</a>
<div class="block">A list of Values in a tuple that can be routed to a given stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/KafkaTupleListener.html#org.apache.storm.kafka.spout">KafkaTupleListener</a>
<div class="block">The KafkaTupleListener handles state changes of a kafka tuple inside a KafkaSpout.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/RecordTranslator.html#org.apache.storm.kafka.spout">RecordTranslator</a>
<div class="block">Translate a <code>ConsumerRecord</code> to a tuple.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/TopicPartitionComparator.html#org.apache.storm.kafka.spout">TopicPartitionComparator</a>
<div class="block">Singleton comparator of TopicPartitions.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.storm.kafka.spout.internal">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../../org/apache/storm/kafka/spout/package-summary.html">org.apache.storm.kafka.spout</a> used by <a href="../../../../../org/apache/storm/kafka/spout/internal/package-summary.html">org.apache.storm.kafka.spout.internal</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/FirstPollOffsetStrategy.html#org.apache.storm.kafka.spout.internal">FirstPollOffsetStrategy</a>
<div class="block">Defines how the spout seeks the offset to be used in the first poll to Kafka upon topology deployment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/Func.html#org.apache.storm.kafka.spout.internal">Func</a>
<div class="block">A simple interface to allow compatibility with non java 8 code bases.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/KafkaSpoutConfig.ProcessingGuarantee.html#org.apache.storm.kafka.spout.internal">KafkaSpoutConfig.ProcessingGuarantee</a>
<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>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/KafkaSpoutMessageId.html#org.apache.storm.kafka.spout.internal">KafkaSpoutMessageId</a>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/RecordTranslator.html#org.apache.storm.kafka.spout.internal">RecordTranslator</a>
<div class="block">Translate a <code>ConsumerRecord</code> to a tuple.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.storm.sql.kafka">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../../org/apache/storm/kafka/spout/package-summary.html">org.apache.storm.kafka.spout</a> used by <a href="../../../../../org/apache/storm/sql/kafka/package-summary.html">org.apache.storm.sql.kafka</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/Func.html#org.apache.storm.sql.kafka">Func</a>
<div class="block">A simple interface to allow compatibility with non java 8 code bases.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/storm/kafka/spout/class-use/RecordTranslator.html#org.apache.storm.sql.kafka">RecordTranslator</a>
<div class="block">Translate a <code>ConsumerRecord</code> to a tuple.</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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/storm/kafka/spout/package-use.html" target="_top">Frames</a></li>
<li><a href="package-use.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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 &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>