blob: c158423e6cacd11e46170dba59cd90fe4a78e574 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Class org.apache.storm.kafka.spout.KafkaSpoutMessageId (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, class: KafkaSpoutMessageId">
<meta name="generator" content="javadoc/ClassUseWriter">
<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="class-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><a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">Class</a></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 Class org.apache.storm.kafka.spout.KafkaSpoutMessageId" class="title">Uses of Class<br>org.apache.storm.kafka.spout.KafkaSpoutMessageId</h1>
</div>
<div class="caption"><span>Packages that use <a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</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.kafka.spout">org.apache.storm.kafka.spout</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.internal">org.apache.storm.kafka.spout.internal</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.storm.kafka.spout">
<h2>Uses of <a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a> in <a href="../package-summary.html">org.apache.storm.kafka.spout</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.storm.kafka.spout</a> that return <a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">KafkaSpoutRetryExponentialBackoff.</span><code><a href="../KafkaSpoutRetryExponentialBackoff.html#getMessageId(org.apache.kafka.common.TopicPartition,long)" class="member-name-link">getMessageId</a><wbr>(org.apache.kafka.common.TopicPartition&nbsp;tp,
long&nbsp;offset)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaSpoutRetryService.</span><code><a href="../KafkaSpoutRetryService.html#getMessageId(org.apache.kafka.common.TopicPartition,long)" class="member-name-link">getMessageId</a><wbr>(org.apache.kafka.common.TopicPartition&nbsp;topicPartition,
long&nbsp;offset)</code></div>
<div class="col-last odd-row-color">
<div class="block">Gets the <a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout"><code>KafkaSpoutMessageId</code></a> for the record on the given topic partition and offset.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.storm.kafka.spout</a> with parameters of type <a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><span class="type-name-label">KafkaSpoutRetryExponentialBackoff.</span><code><a href="../KafkaSpoutRetryExponentialBackoff.html#isReady(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">isReady</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaSpoutRetryService.</span><code><a href="../KafkaSpoutRetryService.html#isReady(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">isReady</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last odd-row-color">
<div class="block">Checks if a specific failed <a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout"><code>KafkaSpoutMessageId</code></a> is ready to be retried,
i.e is scheduled and has retry time that is less than current time.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><span class="type-name-label">KafkaSpoutRetryExponentialBackoff.</span><code><a href="../KafkaSpoutRetryExponentialBackoff.html#isScheduled(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">isScheduled</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaSpoutRetryService.</span><code><a href="../KafkaSpoutRetryService.html#isScheduled(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">isScheduled</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last odd-row-color">
<div class="block">Checks if a specific failed <a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout"><code>KafkaSpoutMessageId</code></a> is scheduled to be retried.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">EmptyKafkaTupleListener.</span><code><a href="../EmptyKafkaTupleListener.html#onAck(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">onAck</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaTupleListener.</span><code><a href="../KafkaTupleListener.html#onAck(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">onAck</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last odd-row-color">
<div class="block">Called when a tuple is acked.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">EmptyKafkaTupleListener.</span><code><a href="../EmptyKafkaTupleListener.html#onEmit(java.util.List,org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">onEmit</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;tuple,
<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaTupleListener.</span><code><a href="../KafkaTupleListener.html#onEmit(java.util.List,org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">onEmit</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;tuple,
<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last odd-row-color">
<div class="block">Called when the tuple is emitted and auto commit is disabled.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">EmptyKafkaTupleListener.</span><code><a href="../EmptyKafkaTupleListener.html#onMaxRetryReached(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">onMaxRetryReached</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaTupleListener.</span><code><a href="../KafkaTupleListener.html#onMaxRetryReached(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">onMaxRetryReached</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last odd-row-color">
<div class="block">Called when the maximum number of retries have been reached.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">EmptyKafkaTupleListener.</span><code><a href="../EmptyKafkaTupleListener.html#onRetry(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">onRetry</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaTupleListener.</span><code><a href="../KafkaTupleListener.html#onRetry(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">onRetry</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last odd-row-color">
<div class="block">Called when the Kafka spout sets a record for retry.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><span class="type-name-label">KafkaSpoutRetryExponentialBackoff.</span><code><a href="../KafkaSpoutRetryExponentialBackoff.html#remove(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">remove</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaSpoutRetryService.</span><code><a href="../KafkaSpoutRetryService.html#remove(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">remove</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last odd-row-color">
<div class="block">Removes a message from the list of messages scheduled for retrial.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><span class="type-name-label">KafkaSpoutRetryExponentialBackoff.</span><code><a href="../KafkaSpoutRetryExponentialBackoff.html#schedule(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">schedule</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaSpoutRetryService.</span><code><a href="../KafkaSpoutRetryService.html#schedule(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">schedule</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last odd-row-color">
<div class="block">Schedules this <a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout"><code>KafkaSpoutMessageId</code></a> if not yet scheduled, or
updates retry time if it has already been scheduled.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.kafka.spout.internal">
<h2>Uses of <a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a> in <a href="../internal/package-summary.html">org.apache.storm.kafka.spout.internal</a></h2>
<div class="caption"><span>Methods in <a href="../internal/package-summary.html">org.apache.storm.kafka.spout.internal</a> with parameters of type <a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">OffsetManager.</span><code><a href="../internal/OffsetManager.html#addToAckMsgs(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">addToAckMsgs</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">OffsetManager.</span><code><a href="../internal/OffsetManager.html#contains(org.apache.storm.kafka.spout.KafkaSpoutMessageId)" class="member-name-link">contains</a><wbr>(<a href="../KafkaSpoutMessageId.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutMessageId</a>&nbsp;msgId)</code></div>
<div class="col-last odd-row-color">&nbsp;</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>