blob: 73f1d124a3681658e626ba0a0c42e162559f8955 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>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="declaration: package: org.apache.storm.kafka.spout">
<meta name="generator" content="javadoc/PackageWriterImpl">
<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-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
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 class="nav-bar-cell1-rev">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#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li>Description&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</a></li>
</ul>
</div>
<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="Package org.apache.storm.kafka.spout" class="title">Package org.apache.storm.kafka.spout</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.storm.kafka.spout</span></div>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</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="internal/package-summary.html">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="metrics2/package-summary.html">org.apache.storm.kafka.spout.metrics2</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="subscription/package-summary.html">org.apache.storm.kafka.spout.subscription</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="trident/package-summary.html">org.apache.storm.kafka.spout.trident</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a>&lt;K,<wbr>V&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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 class-summary class-summary-tab2"><a href="DefaultRecordTranslator.html" title="class in org.apache.storm.kafka.spout">DefaultRecordTranslator</a>&lt;K,<wbr>V&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="EmptyKafkaTupleListener.html" title="class in org.apache.storm.kafka.spout">EmptyKafkaTupleListener</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="FirstPollOffsetStrategy.html" title="enum in org.apache.storm.kafka.spout">FirstPollOffsetStrategy</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">
<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 class-summary class-summary-tab1"><a href="Func.html" title="interface in org.apache.storm.kafka.spout">Func</a>&lt;V,<wbr>R&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A simple interface to allow compatibility with non java 8
code bases.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KafkaSpout.html" title="class in org.apache.storm.kafka.spout">KafkaSpout</a>&lt;K,<wbr>V&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="KafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig</a>&lt;K,<wbr>V&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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 odd-row-color class-summary class-summary-tab2"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;K,<wbr>V&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<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 class-summary class-summary-tab2"><a href="KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="KafkaSpoutRetryExponentialBackoff.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutRetryExponentialBackoff</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Implementation of <a href="KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout"><code>KafkaSpoutRetryService</code></a> using the exponential backoff formula.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KafkaSpoutRetryExponentialBackoff.TimeInterval.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutRetryExponentialBackoff.TimeInterval</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutRetryService</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Represents the logic that manages the retrial of failed tuples.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KafkaSpoutTestBolt.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutTestBolt</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="KafkaSpoutTopologyMainNamedTopics.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutTopologyMainNamedTopics</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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 odd-row-color class-summary class-summary-tab2"><a href="KafkaSpoutTopologyMainWildcardTopics.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutTopologyMainWildcardTopics</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">This example is similar to <a href="KafkaSpoutTopologyMainNamedTopics.html" title="class in org.apache.storm.kafka.spout"><code>KafkaSpoutTopologyMainNamedTopics</code></a>, but demonstrates subscribing to Kafka topics with a regex.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="KafkaTuple.html" title="class in org.apache.storm.kafka.spout">KafkaTuple</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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 class-summary class-summary-tab1"><a href="KafkaTupleListener.html" title="interface in org.apache.storm.kafka.spout">KafkaTupleListener</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">The KafkaTupleListener handles state changes of a kafka tuple inside a KafkaSpout.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a>&lt;K,<wbr>V&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Translate a <code>ConsumerRecord</code> to a tuple.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SimpleRecordTranslator.html" title="class in org.apache.storm.kafka.spout">SimpleRecordTranslator</a>&lt;K,<wbr>V&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TopicPartitionComparator.html" title="class in org.apache.storm.kafka.spout">TopicPartitionComparator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Singleton comparator of TopicPartitions.</div>
</div>
</div>
</div>
</div>
</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>