blob: bcecad2cc5f2623435ebe509936abcf0aadcbe06 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Class org.apache.storm.kafka.spout.KafkaSpoutConfig.Builder (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: KafkaSpoutConfig, class: Builder">
<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="../KafkaSpoutConfig.Builder.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.KafkaSpoutConfig.Builder" class="title">Uses of Class<br>org.apache.storm.kafka.spout.KafkaSpoutConfig.Builder</h1>
</div>
<div class="caption"><span>Packages that use <a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</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>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.storm.kafka.spout">
<h2>Uses of <a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</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="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</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>static <a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">KafkaSpoutConfig.</span><code><a href="../KafkaSpoutConfig.html#builder(java.lang.String,java.lang.String...)" class="member-name-link">builder</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;bootstrapServers,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;topics)</code></div>
<div class="col-last even-row-color">
<div class="block">Factory method that creates a Builder with String key/value deserializers.</div>
</div>
<div class="col-first odd-row-color"><code>static <a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaSpoutConfig.</span><code><a href="../KafkaSpoutConfig.html#builder(java.lang.String,java.util.regex.Pattern)" class="member-name-link">builder</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;bootstrapServers,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html" title="class or interface in java.util.regex" class="external-link">Pattern</a>&nbsp;topics)</code></div>
<div class="col-last odd-row-color">
<div class="block">Factory method that creates a Builder with String key/value deserializers.</div>
</div>
<div class="col-first even-row-color"><code>static <a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">KafkaSpoutConfig.</span><code><a href="../KafkaSpoutConfig.html#builder(java.lang.String,java.util.Set)" class="member-name-link">builder</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;bootstrapServers,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;topics)</code></div>
<div class="col-last even-row-color">
<div class="block">Factory method that creates a Builder with String key/value deserializers.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<wbr><a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaSpoutConfig.Builder.</span><code><a href="../KafkaSpoutConfig.Builder.html#setEmitNullTuples(boolean)" class="member-name-link">setEmitNullTuples</a><wbr>(boolean&nbsp;emitNullTuples)</code></div>
<div class="col-last odd-row-color">
<div class="block">Specifies if the spout should emit null tuples to the component downstream, or rather not emit and directly ack them.</div>
</div>
<div class="col-first even-row-color"><code><a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<wbr><a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">KafkaSpoutConfig.Builder.</span><code><a href="../KafkaSpoutConfig.Builder.html#setGroupId(java.lang.String)" class="member-name-link">setGroupId</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;groupId)</code></div>
<div class="col-last even-row-color">
<div class="block">Specifies the group id.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<wbr><a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaSpoutConfig.Builder.</span><code><a href="../KafkaSpoutConfig.Builder.html#setMaxUncommittedOffsets(int)" class="member-name-link">setMaxUncommittedOffsets</a><wbr>(int&nbsp;maxUncommittedOffsets)</code></div>
<div class="col-last odd-row-color">
<div class="block">Defines the max number of polled offsets (records) that can be pending commit, before another poll can take place.</div>
</div>
<div class="col-first even-row-color"><code><a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<wbr><a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">KafkaSpoutConfig.Builder.</span><code><a href="../KafkaSpoutConfig.Builder.html#setMetricsTimeBucketSizeInSecs(int)" class="member-name-link">setMetricsTimeBucketSizeInSecs</a><wbr>(int&nbsp;metricsTimeBucketSizeInSecs)</code></div>
<div class="col-last even-row-color">
<div class="block">The time period that metrics data in bucketed into.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<wbr><a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaSpoutConfig.Builder.</span><code><a href="../KafkaSpoutConfig.Builder.html#setOffsetCommitPeriodMs(long)" class="member-name-link">setOffsetCommitPeriodMs</a><wbr>(long&nbsp;offsetCommitPeriodMs)</code></div>
<div class="col-last odd-row-color">
<div class="block">Specifies the period, in milliseconds, the offset commit task is periodically called.</div>
</div>
<div class="col-first even-row-color"><code><a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<wbr><a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">KafkaSpoutConfig.Builder.</span><code><a href="../KafkaSpoutConfig.Builder.html#setProcessingGuarantee(org.apache.storm.kafka.spout.KafkaSpoutConfig.ProcessingGuarantee)" class="member-name-link">setProcessingGuarantee</a><wbr>(<a href="../KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a>&nbsp;processingGuarantee)</code></div>
<div class="col-last even-row-color">
<div class="block">Specifies which processing guarantee the spout should offer.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<wbr><a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaSpoutConfig.Builder.</span><code><a href="../KafkaSpoutConfig.Builder.html#setRetry(org.apache.storm.kafka.spout.KafkaSpoutRetryService)" class="member-name-link">setRetry</a><wbr>(<a href="../KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutRetryService</a>&nbsp;retryService)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sets the retry service for the spout to use.</div>
</div>
<div class="col-first even-row-color"><code><a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<wbr><a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">KafkaSpoutConfig.Builder.</span><code><a href="../KafkaSpoutConfig.Builder.html#setTupleListener(org.apache.storm.kafka.spout.KafkaTupleListener)" class="member-name-link">setTupleListener</a><wbr>(<a href="../KafkaTupleListener.html" title="interface in org.apache.storm.kafka.spout">KafkaTupleListener</a>&nbsp;tupleListener)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets the tuple listener for the spout to use.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<wbr><a href="../KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">KafkaSpoutConfig.Builder.</span><code><a href="../KafkaSpoutConfig.Builder.html#setTupleTrackingEnforced(boolean)" class="member-name-link">setTupleTrackingEnforced</a><wbr>(boolean&nbsp;tupleTrackingEnforced)</code></div>
<div class="col-last odd-row-color">
<div class="block">Specifies whether the spout should require Storm to track emitted tuples when using a <a href="../KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><code>KafkaSpoutConfig.ProcessingGuarantee</code></a> other than
<a href="../KafkaSpoutConfig.ProcessingGuarantee.html#AT_LEAST_ONCE"><code>KafkaSpoutConfig.ProcessingGuarantee.AT_LEAST_ONCE</code></a>.</div>
</div>
</div>
<div class="caption"><span>Constructors in <a href="../package-summary.html">org.apache.storm.kafka.spout</a> with parameters of type <a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../KafkaSpoutConfig.html#%3Cinit%3E(org.apache.storm.kafka.spout.KafkaSpoutConfig.Builder)" class="member-name-link">KafkaSpoutConfig</a><wbr>(<a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<a href="../KafkaSpoutConfig.html" title="type parameter in KafkaSpoutConfig">K</a>,<wbr><a href="../KafkaSpoutConfig.html" title="type parameter in KafkaSpoutConfig">V</a>&gt;&nbsp;builder)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new KafkaSpoutConfig using a Builder.</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>