| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>CommonKafkaSpoutConfig.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.internal, class: CommonKafkaSpoutConfig, 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/CommonKafkaSpoutConfig.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.internal</a></div> |
| <h1 title="Class CommonKafkaSpoutConfig.Builder" class="title">Class CommonKafkaSpoutConfig.Builder<K,<wbr>V,<wbr>T extends CommonKafkaSpoutConfig.Builder<K,<wbr>V,<wbr>T>></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">org.apache.storm.kafka.spout.internal.CommonKafkaSpoutConfig.Builder<K,<wbr>V,<wbr>T></div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a></code>, <code><a href="../trident/KafkaTridentSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout.trident">KafkaTridentSpoutConfig.Builder</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig</a><<a href="CommonKafkaSpoutConfig.html" title="type parameter in CommonKafkaSpoutConfig">K</a>,<wbr><a href="CommonKafkaSpoutConfig.html" title="type parameter in CommonKafkaSpoutConfig">V</a>></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract static class </span><span class="element-name type-name-label">CommonKafkaSpoutConfig.Builder<K,<wbr>V,<wbr>T extends CommonKafkaSpoutConfig.Builder<K,<wbr>V,<wbr>T>></span> |
| <span class="extends-implements">extends <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></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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>abstract <a href="CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig</a><<a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<wbr><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<wbr><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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKafkaProps()" class="member-name-link">getKafkaProps</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFirstPollOffsetStrategy(org.apache.storm.kafka.spout.FirstPollOffsetStrategy)" class="member-name-link">setFirstPollOffsetStrategy</a><wbr>(<a href="../FirstPollOffsetStrategy.html" title="enum in org.apache.storm.kafka.spout">FirstPollOffsetStrategy</a> firstPollOffsetStrategy)</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 offset used by the Kafka spout in the first poll to Kafka broker upon process start.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPartitionRefreshPeriodMs(long)" class="member-name-link">setPartitionRefreshPeriodMs</a><wbr>(long partitionRefreshPeriodMs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets partition refresh period in milliseconds.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPollTimeoutMs(long)" class="member-name-link">setPollTimeoutMs</a><wbr>(long pollTimeoutMs)</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 time, in milliseconds, spent waiting in poll if data is not available.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setProp(java.lang.String,java.lang.Object)" class="member-name-link">setProp</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> key, |
| <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> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set a <code>KafkaConsumer</code> property.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setProp(java.util.Map)" class="member-name-link">setProp</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<wbr><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>> props)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set multiple <code>KafkaConsumer</code> properties.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setProp(java.util.Properties)" class="member-name-link">setProp</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> props)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set multiple <code>KafkaConsumer</code> properties.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRecordTranslator(org.apache.storm.kafka.spout.Func,org.apache.storm.tuple.Fields)" class="member-name-link">setRecordTranslator</a><wbr>(<a href="../Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<wbr><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</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><<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>>> func, |
| <a href="../../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configure a translator with tuples to be emitted on the default stream.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRecordTranslator(org.apache.storm.kafka.spout.Func,org.apache.storm.tuple.Fields,java.lang.String)" class="member-name-link">setRecordTranslator</a><wbr>(<a href="../Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<wbr><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</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><<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>>> func, |
| <a href="../../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields, |
| <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> stream)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configure a translator with tuples to be emitted to a given stream.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRecordTranslator(org.apache.storm.kafka.spout.RecordTranslator)" class="member-name-link">setRecordTranslator</a><wbr>(<a href="../RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<wbr><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</a>> translator)</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="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStartTimeStamp(long)" class="member-name-link">setStartTimeStamp</a><wbr>(long startTimeStamp)</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 startTimeStamp if the first poll strategy is TIMESTAMP or UNCOMMITTED_TIMESTAMP.</div> |
| </div> |
| </div> |
| </div> |
| </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="setProp(java.lang.String,java.lang.Object)"> |
| <h3>setProp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></span> <span class="element-name">setProp</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> key, |
| <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> value)</span></div> |
| <div class="block">Set a <code>KafkaConsumer</code> property.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProp(java.util.Map)"> |
| <h3>setProp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></span> <span class="element-name">setProp</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<wbr><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>> props)</span></div> |
| <div class="block">Set multiple <code>KafkaConsumer</code> properties.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProp(java.util.Properties)"> |
| <h3>setProp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></span> <span class="element-name">setProp</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> props)</span></div> |
| <div class="block">Set multiple <code>KafkaConsumer</code> properties.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPollTimeoutMs(long)"> |
| <h3>setPollTimeoutMs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></span> <span class="element-name">setPollTimeoutMs</span><wbr><span class="parameters">(long pollTimeoutMs)</span></div> |
| <div class="block">Specifies the time, in milliseconds, spent waiting in poll if data is not available. Default is 200ms.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pollTimeoutMs</code> - time in ms</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFirstPollOffsetStrategy(org.apache.storm.kafka.spout.FirstPollOffsetStrategy)"> |
| <h3>setFirstPollOffsetStrategy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></span> <span class="element-name">setFirstPollOffsetStrategy</span><wbr><span class="parameters">(<a href="../FirstPollOffsetStrategy.html" title="enum in org.apache.storm.kafka.spout">FirstPollOffsetStrategy</a> firstPollOffsetStrategy)</span></div> |
| <div class="block">Sets the offset used by the Kafka spout in the first poll to Kafka broker upon process start. Please refer to to the |
| documentation in <a href="../FirstPollOffsetStrategy.html" title="enum in org.apache.storm.kafka.spout"><code>FirstPollOffsetStrategy</code></a></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>firstPollOffsetStrategy</code> - Offset used by Kafka spout first poll</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRecordTranslator(org.apache.storm.kafka.spout.RecordTranslator)"> |
| <h3>setRecordTranslator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></span> <span class="element-name">setRecordTranslator</span><wbr><span class="parameters">(<a href="../RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<wbr><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</a>> translator)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRecordTranslator(org.apache.storm.kafka.spout.Func,org.apache.storm.tuple.Fields)"> |
| <h3>setRecordTranslator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></span> <span class="element-name">setRecordTranslator</span><wbr><span class="parameters">(<a href="../Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<wbr><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</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><<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>>> func, |
| <a href="../../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</span></div> |
| <div class="block">Configure a translator with tuples to be emitted on the default stream.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>func</code> - extracts and turns a Kafka ConsumerRecord into a list of objects to be emitted</dd> |
| <dd><code>fields</code> - the names of the fields extracted</dd> |
| <dt>Returns:</dt> |
| <dd>this to be able to chain configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRecordTranslator(org.apache.storm.kafka.spout.Func,org.apache.storm.tuple.Fields,java.lang.String)"> |
| <h3>setRecordTranslator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></span> <span class="element-name">setRecordTranslator</span><wbr><span class="parameters">(<a href="../Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<wbr><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</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><<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>>> func, |
| <a href="../../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields, |
| <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> stream)</span></div> |
| <div class="block">Configure a translator with tuples to be emitted to a given stream.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>func</code> - extracts and turns a Kafka ConsumerRecord into a list of objects to be emitted</dd> |
| <dd><code>fields</code> - the names of the fields extracted</dd> |
| <dd><code>stream</code> - the stream to emit the tuples on</dd> |
| <dt>Returns:</dt> |
| <dd>this to be able to chain configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPartitionRefreshPeriodMs(long)"> |
| <h3>setPartitionRefreshPeriodMs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></span> <span class="element-name">setPartitionRefreshPeriodMs</span><wbr><span class="parameters">(long partitionRefreshPeriodMs)</span></div> |
| <div class="block">Sets partition refresh period in milliseconds. This is how often Kafka will be polled to check for new topics and/or new |
| partitions.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>partitionRefreshPeriodMs</code> - time in milliseconds</dd> |
| <dt>Returns:</dt> |
| <dd>the builder (this)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStartTimeStamp(long)"> |
| <h3>setStartTimeStamp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></span> <span class="element-name">setStartTimeStamp</span><wbr><span class="parameters">(long startTimeStamp)</span></div> |
| <div class="block">Specifies the startTimeStamp if the first poll strategy is TIMESTAMP or UNCOMMITTED_TIMESTAMP.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>startTimeStamp</code> - time in ms</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getKafkaProps()"> |
| <h3>getKafkaProps</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<wbr><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>></span> <span class="element-name">getKafkaProps</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="build()"> |
| <h3>build</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig</a><<a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<wbr><a href="CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</a>></span> <span class="element-name">build</span>()</div> |
| </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> |