| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>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="declaration: package: org.apache.storm.kafka.spout, class: KafkaSpoutConfig, class: Builder"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <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-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><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/KafkaSpoutConfig.Builder.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.kafka.spout</a></div> |
| <h1 title="Class KafkaSpoutConfig.Builder" class="title">Class KafkaSpoutConfig.Builder<K,<wbr>V></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a> |
| <div class="inheritance"><a href="internal/CommonKafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout.internal">org.apache.storm.kafka.spout.internal.CommonKafkaSpoutConfig.Builder</a><K,<wbr>V,<wbr><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><K,<wbr>V>> |
| <div class="inheritance">org.apache.storm.kafka.spout.KafkaSpoutConfig.Builder<K,<wbr>V></div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="KafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig</a><<a href="KafkaSpoutConfig.html" title="type parameter in KafkaSpoutConfig">K</a>,<wbr><a href="KafkaSpoutConfig.html" title="type parameter in KafkaSpoutConfig">V</a>></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">KafkaSpoutConfig.Builder<K,<wbr>V></span> |
| <span class="extends-implements">extends <a href="internal/CommonKafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig.Builder</a><K,<wbr>V,<wbr><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><K,<wbr>V>></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(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> 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>... topics)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(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> 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> topics)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(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> 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><<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>> topics)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.storm.kafka.spout.subscription.TopicFilter,org.apache.storm.kafka.spout.subscription.ManualPartitioner)" 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> bootstrapServers, |
| <a href="subscription/TopicFilter.html" title="interface in org.apache.storm.kafka.spout.subscription">TopicFilter</a> topicFilter, |
| <a href="subscription/ManualPartitioner.html" title="interface in org.apache.storm.kafka.spout.subscription">ManualPartitioner</a> topicPartitioner)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Create a KafkaSpoutConfig builder with default property values and no key/value deserializers.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig</a><<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>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEmitNullTuples(boolean)" class="member-name-link">setEmitNullTuples</a><wbr>(boolean emitNullTuples)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> groupId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specifies the group id.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxUncommittedOffsets(int)" class="member-name-link">setMaxUncommittedOffsets</a><wbr>(int maxUncommittedOffsets)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMetricsTimeBucketSizeInSecs(int)" class="member-name-link">setMetricsTimeBucketSizeInSecs</a><wbr>(int metricsTimeBucketSizeInSecs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The time period that metrics data in bucketed into.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOffsetCommitPeriodMs(long)" class="member-name-link">setOffsetCommitPeriodMs</a><wbr>(long offsetCommitPeriodMs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specifies the period, in milliseconds, the offset commit task is periodically called.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> processingGuarantee)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specifies which processing guarantee the spout should offer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> retryService)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the retry service for the spout to use.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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> tupleListener)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the tuple listener for the spout to use.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTupleTrackingEnforced(boolean)" class="member-name-link">setTupleTrackingEnforced</a><wbr>(boolean tupleTrackingEnforced)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.kafka.spout.internal.CommonKafkaSpoutConfig.Builder">Methods inherited from class org.apache.storm.kafka.spout.internal.<a href="internal/CommonKafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig.Builder</a></h3> |
| <code><a href="internal/CommonKafkaSpoutConfig.Builder.html#getKafkaProps()">getKafkaProps</a>, <a href="internal/CommonKafkaSpoutConfig.Builder.html#setFirstPollOffsetStrategy(org.apache.storm.kafka.spout.FirstPollOffsetStrategy)">setFirstPollOffsetStrategy</a>, <a href="internal/CommonKafkaSpoutConfig.Builder.html#setPartitionRefreshPeriodMs(long)">setPartitionRefreshPeriodMs</a>, <a href="internal/CommonKafkaSpoutConfig.Builder.html#setPollTimeoutMs(long)">setPollTimeoutMs</a>, <a href="internal/CommonKafkaSpoutConfig.Builder.html#setProp(java.lang.String,java.lang.Object)">setProp</a>, <a href="internal/CommonKafkaSpoutConfig.Builder.html#setProp(java.util.Map)">setProp</a>, <a href="internal/CommonKafkaSpoutConfig.Builder.html#setProp(java.util.Properties)">setProp</a>, <a href="internal/CommonKafkaSpoutConfig.Builder.html#setRecordTranslator(org.apache.storm.kafka.spout.Func,org.apache.storm.tuple.Fields)">setRecordTranslator</a>, <a href="internal/CommonKafkaSpoutConfig.Builder.html#setRecordTranslator(org.apache.storm.kafka.spout.Func,org.apache.storm.tuple.Fields,java.lang.String)">setRecordTranslator</a>, <a href="internal/CommonKafkaSpoutConfig.Builder.html#setRecordTranslator(org.apache.storm.kafka.spout.RecordTranslator)">setRecordTranslator</a>, <a href="internal/CommonKafkaSpoutConfig.Builder.html#setStartTimeStamp(long)">setStartTimeStamp</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.lang.String...)"> |
| <h3>Builder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Builder</span><wbr><span class="parameters">(<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> 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>... topics)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.util.Set)"> |
| <h3>Builder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Builder</span><wbr><span class="parameters">(<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> 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><<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>> topics)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.util.regex.Pattern)"> |
| <h3>Builder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Builder</span><wbr><span class="parameters">(<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> 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> topics)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,org.apache.storm.kafka.spout.subscription.TopicFilter,org.apache.storm.kafka.spout.subscription.ManualPartitioner)"> |
| <h3>Builder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Builder</span><wbr><span class="parameters">(<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> bootstrapServers, |
| <a href="subscription/TopicFilter.html" title="interface in org.apache.storm.kafka.spout.subscription">TopicFilter</a> topicFilter, |
| <a href="subscription/ManualPartitioner.html" title="interface in org.apache.storm.kafka.spout.subscription">ManualPartitioner</a> topicPartitioner)</span></div> |
| <div class="block">Create a KafkaSpoutConfig builder with default property values and no key/value deserializers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bootstrapServers</code> - The bootstrap servers the consumer will use</dd> |
| <dd><code>topicFilter</code> - The topic filter defining which topics and partitions the spout will read</dd> |
| <dd><code>topicPartitioner</code> - The topic partitioner defining which topics and partitions are assinged to each spout task</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setOffsetCommitPeriodMs(long)"> |
| <h3>setOffsetCommitPeriodMs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></span> <span class="element-name">setOffsetCommitPeriodMs</span><wbr><span class="parameters">(long offsetCommitPeriodMs)</span></div> |
| <div class="block">Specifies the period, in milliseconds, the offset commit task is periodically called. Default is 15s. |
| |
| <p>This setting only has an effect if the configured <a href="KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><code>KafkaSpoutConfig.ProcessingGuarantee</code></a> is <a href="KafkaSpoutConfig.ProcessingGuarantee.html#AT_LEAST_ONCE"><code>KafkaSpoutConfig.ProcessingGuarantee.AT_LEAST_ONCE</code></a> or |
| <a href="KafkaSpoutConfig.ProcessingGuarantee.html#NO_GUARANTEE"><code>KafkaSpoutConfig.ProcessingGuarantee.NO_GUARANTEE</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>offsetCommitPeriodMs</code> - time in ms</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setGroupId(java.lang.String)"> |
| <h3>setGroupId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></span> <span class="element-name">setGroupId</span><wbr><span class="parameters">(<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> groupId)</span></div> |
| <div class="block">Specifies the group id.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>groupId</code> - the group id</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMaxUncommittedOffsets(int)"> |
| <h3>setMaxUncommittedOffsets</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></span> <span class="element-name">setMaxUncommittedOffsets</span><wbr><span class="parameters">(int maxUncommittedOffsets)</span></div> |
| <div class="block">Defines the max number of polled offsets (records) that can be pending commit, before another poll can take place. |
| Once this limit is reached, no more offsets (records) can be polled until the next successful commit(s) sets the number |
| of pending offsets below the threshold. The default is <a href="KafkaSpoutConfig.html#DEFAULT_MAX_UNCOMMITTED_OFFSETS"><code>KafkaSpoutConfig.DEFAULT_MAX_UNCOMMITTED_OFFSETS</code></a>. |
| This limit is per partition and may in some cases be exceeded, |
| but each partition cannot exceed this limit by more than maxPollRecords - 1. |
| |
| <p>This setting only has an effect if the configured <a href="KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><code>KafkaSpoutConfig.ProcessingGuarantee</code></a> is <a href="KafkaSpoutConfig.ProcessingGuarantee.html#AT_LEAST_ONCE"><code>KafkaSpoutConfig.ProcessingGuarantee.AT_LEAST_ONCE</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>maxUncommittedOffsets</code> - max number of records that can be be pending commit</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRetry(org.apache.storm.kafka.spout.KafkaSpoutRetryService)"> |
| <h3>setRetry</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></span> <span class="element-name">setRetry</span><wbr><span class="parameters">(<a href="KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutRetryService</a> retryService)</span></div> |
| <div class="block">Sets the retry service for the spout to use. |
| |
| <p>This setting only has an effect if the configured <a href="KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><code>KafkaSpoutConfig.ProcessingGuarantee</code></a> is <a href="KafkaSpoutConfig.ProcessingGuarantee.html#AT_LEAST_ONCE"><code>KafkaSpoutConfig.ProcessingGuarantee.AT_LEAST_ONCE</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>retryService</code> - the new retry service</dd> |
| <dt>Returns:</dt> |
| <dd>the builder (this).</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTupleListener(org.apache.storm.kafka.spout.KafkaTupleListener)"> |
| <h3>setTupleListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></span> <span class="element-name">setTupleListener</span><wbr><span class="parameters">(<a href="KafkaTupleListener.html" title="interface in org.apache.storm.kafka.spout">KafkaTupleListener</a> tupleListener)</span></div> |
| <div class="block">Sets the tuple listener for the spout to use.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>tupleListener</code> - the tuple listener</dd> |
| <dt>Returns:</dt> |
| <dd>the builder (this).</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEmitNullTuples(boolean)"> |
| <h3>setEmitNullTuples</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></span> <span class="element-name">setEmitNullTuples</span><wbr><span class="parameters">(boolean emitNullTuples)</span></div> |
| <div class="block">Specifies if the spout should emit null tuples to the component downstream, or rather not emit and directly ack them. By default |
| this parameter is set to false, which means that null tuples are not emitted.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>emitNullTuples</code> - sets if null tuples should or not be emitted downstream</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProcessingGuarantee(org.apache.storm.kafka.spout.KafkaSpoutConfig.ProcessingGuarantee)"> |
| <h3>setProcessingGuarantee</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></span> <span class="element-name">setProcessingGuarantee</span><wbr><span class="parameters">(<a href="KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a> processingGuarantee)</span></div> |
| <div class="block">Specifies which processing guarantee the spout should offer. Refer to the documentation for <a href="KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><code>KafkaSpoutConfig.ProcessingGuarantee</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>processingGuarantee</code> - The processing guarantee the spout should offer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTupleTrackingEnforced(boolean)"> |
| <h3>setTupleTrackingEnforced</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></span> <span class="element-name">setTupleTrackingEnforced</span><wbr><span class="parameters">(boolean tupleTrackingEnforced)</span></div> |
| <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>. The spout will always track emitted tuples when offering at-least-once guarantees |
| regardless of this setting. This setting is false by default. |
| |
| <p>Enabling tracking can be useful even in cases where reliability is not a concern, because it allows |
| <a href="../../Config.html#TOPOLOGY_MAX_SPOUT_PENDING"><code>Config.TOPOLOGY_MAX_SPOUT_PENDING</code></a> to have an effect, and enables some spout metrics (e.g. complete-latency) that would |
| otherwise be disabled.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>tupleTrackingEnforced</code> - true if Storm should track emitted tuples, false otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMetricsTimeBucketSizeInSecs(int)"> |
| <h3>setMetricsTimeBucketSizeInSecs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>></span> <span class="element-name">setMetricsTimeBucketSizeInSecs</span><wbr><span class="parameters">(int metricsTimeBucketSizeInSecs)</span></div> |
| <div class="block">The time period that metrics data in bucketed into.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>metricsTimeBucketSizeInSecs</code> - time in seconds</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="build()"> |
| <h3>build</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig</a><<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>></span> <span class="element-name">build</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="internal/CommonKafkaSpoutConfig.Builder.html#build()">build</a></code> in class <code><a href="internal/CommonKafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig.Builder</a><<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>,<wbr><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<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>>></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
