blob: 789b791fc7c93ee09a4901453eac6ce215186afe [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Package org.apache.storm.kafka.spout (Storm 2.6.2 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="use: package: org.apache.storm.kafka.spout">
<meta name="generator" content="javadoc/PackageUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="package-use-page">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="nav-bar-cell1-rev">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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<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="caption"><span>Packages that use <a href="package-summary.html">org.apache.storm.kafka.spout</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.storm.flux.examples">org.apache.storm.flux.examples</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.storm.kafka.spout">org.apache.storm.kafka.spout</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="#org.apache.storm.kafka.spout.internal">org.apache.storm.kafka.spout.internal</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.storm.sql.kafka">org.apache.storm.sql.kafka</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<section class="package-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.storm.flux.examples">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.storm.kafka.spout</a> used by <a href="../../flux/examples/package-summary.html">org.apache.storm.flux.examples</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/Func.html#org.apache.storm.flux.examples">Func</a></div>
<div class="col-last even-row-color">
<div class="block">A simple interface to allow compatibility with non java 8
code bases.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/RecordTranslator.html#org.apache.storm.flux.examples">RecordTranslator</a></div>
<div class="col-last odd-row-color">
<div class="block">Translate a <code>ConsumerRecord</code> to a tuple.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.kafka.spout">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.storm.kafka.spout</a> used by <a href="package-summary.html">org.apache.storm.kafka.spout</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/ByTopicRecordTranslator.html#org.apache.storm.kafka.spout">ByTopicRecordTranslator</a></div>
<div class="col-last even-row-color">
<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>
</div>
<div class="col-first odd-row-color"><a href="class-use/FirstPollOffsetStrategy.html#org.apache.storm.kafka.spout">FirstPollOffsetStrategy</a></div>
<div class="col-last odd-row-color">
<div class="block">Defines how the spout seeks the offset to be used in the first poll to Kafka upon topology deployment.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/Func.html#org.apache.storm.kafka.spout">Func</a></div>
<div class="col-last even-row-color">
<div class="block">A simple interface to allow compatibility with non java 8
code bases.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/KafkaSpoutConfig.html#org.apache.storm.kafka.spout">KafkaSpoutConfig</a></div>
<div class="col-last odd-row-color">
<div class="block">KafkaSpoutConfig defines the required configuration to connect a consumer to a consumer group, as well as the subscribing topics.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/KafkaSpoutConfig.Builder.html#org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="class-use/KafkaSpoutConfig.ProcessingGuarantee.html#org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a></div>
<div class="col-last odd-row-color">
<div class="block">This enum controls when the tuple with the <code>ConsumerRecord</code> for an offset is marked as processed,
i.e. when the offset can be committed to Kafka.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/KafkaSpoutMessageId.html#org.apache.storm.kafka.spout">KafkaSpoutMessageId</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="class-use/KafkaSpoutRetryExponentialBackoff.TimeInterval.html#org.apache.storm.kafka.spout">KafkaSpoutRetryExponentialBackoff.TimeInterval</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="class-use/KafkaSpoutRetryService.html#org.apache.storm.kafka.spout">KafkaSpoutRetryService</a></div>
<div class="col-last even-row-color">
<div class="block">Represents the logic that manages the retrial of failed tuples.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/KafkaSpoutTopologyMainNamedTopics.html#org.apache.storm.kafka.spout">KafkaSpoutTopologyMainNamedTopics</a></div>
<div class="col-last odd-row-color">
<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>
</div>
<div class="col-first even-row-color"><a href="class-use/KafkaTuple.html#org.apache.storm.kafka.spout">KafkaTuple</a></div>
<div class="col-last even-row-color">
<div class="block">A list of Values in a tuple that can be routed
to a given stream: <a href="RecordTranslator.html#apply(org.apache.kafka.clients.consumer.ConsumerRecord)"><code>RecordTranslator.apply(org.apache.kafka.clients.consumer.ConsumerRecord&lt;K, V&gt;)</code></a>.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/KafkaTupleListener.html#org.apache.storm.kafka.spout">KafkaTupleListener</a></div>
<div class="col-last odd-row-color">
<div class="block">The KafkaTupleListener handles state changes of a kafka tuple inside a KafkaSpout.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/RecordTranslator.html#org.apache.storm.kafka.spout">RecordTranslator</a></div>
<div class="col-last even-row-color">
<div class="block">Translate a <code>ConsumerRecord</code> to a tuple.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/TopicPartitionComparator.html#org.apache.storm.kafka.spout">TopicPartitionComparator</a></div>
<div class="col-last odd-row-color">
<div class="block">Singleton comparator of TopicPartitions.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.kafka.spout.internal">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.storm.kafka.spout</a> used by <a href="internal/package-summary.html">org.apache.storm.kafka.spout.internal</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/FirstPollOffsetStrategy.html#org.apache.storm.kafka.spout.internal">FirstPollOffsetStrategy</a></div>
<div class="col-last even-row-color">
<div class="block">Defines how the spout seeks the offset to be used in the first poll to Kafka upon topology deployment.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/Func.html#org.apache.storm.kafka.spout.internal">Func</a></div>
<div class="col-last odd-row-color">
<div class="block">A simple interface to allow compatibility with non java 8
code bases.</div>
</div>
<div class="col-first even-row-color"><a href="class-use/KafkaSpoutConfig.ProcessingGuarantee.html#org.apache.storm.kafka.spout.internal">KafkaSpoutConfig.ProcessingGuarantee</a></div>
<div class="col-last even-row-color">
<div class="block">This enum controls when the tuple with the <code>ConsumerRecord</code> for an offset is marked as processed,
i.e. when the offset can be committed to Kafka.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/KafkaSpoutMessageId.html#org.apache.storm.kafka.spout.internal">KafkaSpoutMessageId</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="class-use/RecordTranslator.html#org.apache.storm.kafka.spout.internal">RecordTranslator</a></div>
<div class="col-last even-row-color">
<div class="block">Translate a <code>ConsumerRecord</code> to a tuple.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.sql.kafka">
<div class="caption"><span>Classes in <a href="package-summary.html">org.apache.storm.kafka.spout</a> used by <a href="../../sql/kafka/package-summary.html">org.apache.storm.sql.kafka</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="class-use/Func.html#org.apache.storm.sql.kafka">Func</a></div>
<div class="col-last even-row-color">
<div class="block">A simple interface to allow compatibility with non java 8
code bases.</div>
</div>
<div class="col-first odd-row-color"><a href="class-use/RecordTranslator.html#org.apache.storm.sql.kafka">RecordTranslator</a></div>
<div class="col-last odd-row-color">
<div class="block">Translate a <code>ConsumerRecord</code> to a tuple.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>