| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CommonKafkaSpoutConfig.Builder (Storm 2.4.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CommonKafkaSpoutConfig.Builder (Storm 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/storm/kafka/spout/internal/ConsumerFactory.html" title="interface in org.apache.storm.kafka.spout.internal"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" target="_top">Frames</a></li> |
| <li><a href="CommonKafkaSpoutConfig.Builder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.storm.kafka.spout.internal</div> |
| <h2 title="Class CommonKafkaSpoutConfig.Builder" class="title">Class CommonKafkaSpoutConfig.Builder<K,V,T extends CommonKafkaSpoutConfig.Builder<K,V,T>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.storm.kafka.spout.internal.CommonKafkaSpoutConfig.Builder<K,V,T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>, <a href="../../../../../../org/apache/storm/kafka/spout/trident/KafkaTridentSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout.trident">KafkaTridentSpoutConfig.Builder</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig</a><<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.html" title="type parameter in CommonKafkaSpoutConfig">K</a>,<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.html" title="type parameter in CommonKafkaSpoutConfig">V</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract static class <span class="typeNameLabel">CommonKafkaSpoutConfig.Builder<K,V,T extends CommonKafkaSpoutConfig.Builder<K,V,T>></span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#Builder-java.lang.String-java.util.regex.Pattern-">Builder</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bootstrapServers, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a> topics)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#Builder-java.lang.String-java.util.Set-">Builder</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bootstrapServers, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> topics)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#Builder-java.lang.String-java.lang.String...-">Builder</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bootstrapServers, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... topics)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#Builder-java.lang.String-org.apache.storm.kafka.spout.subscription.TopicFilter-org.apache.storm.kafka.spout.subscription.ManualPartitioner-">Builder</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bootstrapServers, |
| <a href="../../../../../../org/apache/storm/kafka/spout/subscription/TopicFilter.html" title="interface in org.apache.storm.kafka.spout.subscription">TopicFilter</a> topicFilter, |
| <a href="../../../../../../org/apache/storm/kafka/spout/subscription/ManualPartitioner.html" title="interface in org.apache.storm.kafka.spout.subscription">ManualPartitioner</a> topicPartitioner)</code> |
| <div class="block">Create a KafkaSpoutConfig builder with default property values and no key/value deserializers.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig</a><<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#build--">build</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#getKafkaProps--">getKafkaProps</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setFirstPollOffsetStrategy-org.apache.storm.kafka.spout.FirstPollOffsetStrategy-">setFirstPollOffsetStrategy</a></span>(<a href="../../../../../../org/apache/storm/kafka/spout/FirstPollOffsetStrategy.html" title="enum in org.apache.storm.kafka.spout">FirstPollOffsetStrategy</a> firstPollOffsetStrategy)</code> |
| <div class="block">Sets the offset used by the Kafka spout in the first poll to Kafka broker upon process start.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setPartitionRefreshPeriodMs-long-">setPartitionRefreshPeriodMs</a></span>(long partitionRefreshPeriodMs)</code> |
| <div class="block">Sets partition refresh period in milliseconds.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setPollTimeoutMs-long-">setPollTimeoutMs</a></span>(long pollTimeoutMs)</code> |
| <div class="block">Specifies the time, in milliseconds, spent waiting in poll if data is not available.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setProp-java.util.Map-">setProp</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> props)</code> |
| <div class="block">Set multiple <code>KafkaConsumer</code> properties.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setProp-java.util.Properties-">setProp</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props)</code> |
| <div class="block">Set multiple <code>KafkaConsumer</code> properties.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setProp-java.lang.String-java.lang.Object-">setProp</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Set a <code>KafkaConsumer</code> property.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setRecordTranslator-org.apache.storm.kafka.spout.Func-org.apache.storm.tuple.Fields-">setRecordTranslator</a></span>(<a href="../../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>> func, |
| <a href="../../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code> |
| <div class="block">Configure a translator with tuples to be emitted on the default stream.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setRecordTranslator-org.apache.storm.kafka.spout.Func-org.apache.storm.tuple.Fields-java.lang.String-">setRecordTranslator</a></span>(<a href="../../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>> func, |
| <a href="../../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stream)</code> |
| <div class="block">Configure a translator with tuples to be emitted to a given stream.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setRecordTranslator-org.apache.storm.kafka.spout.RecordTranslator-">setRecordTranslator</a></span>(<a href="../../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</a>> translator)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setStartTimeStamp-long-">setStartTimeStamp</a></span>(long startTimeStamp)</code> |
| <div class="block">Specifies the startTimeStamp if the first poll strategy is TIMESTAMP or UNCOMMITTED_TIMESTAMP.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Builder-java.lang.String-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>public Builder(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bootstrapServers, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... topics)</pre> |
| </li> |
| </ul> |
| <a name="Builder-java.lang.String-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>public Builder(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bootstrapServers, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> topics)</pre> |
| </li> |
| </ul> |
| <a name="Builder-java.lang.String-java.util.regex.Pattern-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>public Builder(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bootstrapServers, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a> topics)</pre> |
| </li> |
| </ul> |
| <a name="Builder-java.lang.String-org.apache.storm.kafka.spout.subscription.TopicFilter-org.apache.storm.kafka.spout.subscription.ManualPartitioner-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>public Builder(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bootstrapServers, |
| <a href="../../../../../../org/apache/storm/kafka/spout/subscription/TopicFilter.html" title="interface in org.apache.storm.kafka.spout.subscription">TopicFilter</a> topicFilter, |
| <a href="../../../../../../org/apache/storm/kafka/spout/subscription/ManualPartitioner.html" title="interface in org.apache.storm.kafka.spout.subscription">ManualPartitioner</a> topicPartitioner)</pre> |
| <div class="block"><p>Create a KafkaSpoutConfig builder with default property values and no key/value deserializers.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setProp-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProp</h4> |
| <pre>public <a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a> setProp(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block"><p>Set a <code>KafkaConsumer</code> property.</p></div> |
| </li> |
| </ul> |
| <a name="setProp-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProp</h4> |
| <pre>public <a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a> setProp(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> props)</pre> |
| <div class="block"><p>Set multiple <code>KafkaConsumer</code> properties.</p></div> |
| </li> |
| </ul> |
| <a name="setProp-java.util.Properties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProp</h4> |
| <pre>public <a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a> setProp(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> props)</pre> |
| <div class="block"><p>Set multiple <code>KafkaConsumer</code> properties.</p></div> |
| </li> |
| </ul> |
| <a name="setPollTimeoutMs-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPollTimeoutMs</h4> |
| <pre>public <a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a> setPollTimeoutMs(long pollTimeoutMs)</pre> |
| <div class="block"><p>Specifies the time, in milliseconds, spent waiting in poll if data is not available. Default is 200ms.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pollTimeoutMs</code> - time in ms</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFirstPollOffsetStrategy-org.apache.storm.kafka.spout.FirstPollOffsetStrategy-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFirstPollOffsetStrategy</h4> |
| <pre>public <a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a> setFirstPollOffsetStrategy(<a href="../../../../../../org/apache/storm/kafka/spout/FirstPollOffsetStrategy.html" title="enum in org.apache.storm.kafka.spout">FirstPollOffsetStrategy</a> firstPollOffsetStrategy)</pre> |
| <div class="block"><p>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="../../../../../../org/apache/storm/kafka/spout/FirstPollOffsetStrategy.html" title="enum in org.apache.storm.kafka.spout"><code>FirstPollOffsetStrategy</code></a></p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>firstPollOffsetStrategy</code> - Offset used by Kafka spout first poll</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRecordTranslator-org.apache.storm.kafka.spout.RecordTranslator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRecordTranslator</h4> |
| <pre>public <a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a> setRecordTranslator(<a href="../../../../../../org/apache/storm/kafka/spout/RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</a>> translator)</pre> |
| </li> |
| </ul> |
| <a name="setRecordTranslator-org.apache.storm.kafka.spout.Func-org.apache.storm.tuple.Fields-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRecordTranslator</h4> |
| <pre>public <a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a> setRecordTranslator(<a href="../../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>> func, |
| <a href="../../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</pre> |
| <div class="block"><p>Configure a translator with tuples to be emitted on the default stream.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>this to be able to chain configuration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRecordTranslator-org.apache.storm.kafka.spout.Func-org.apache.storm.tuple.Fields-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRecordTranslator</h4> |
| <pre>public <a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a> setRecordTranslator(<a href="../../../../../../org/apache/storm/kafka/spout/Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</a>>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>>> func, |
| <a href="../../../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stream)</pre> |
| <div class="block"><p>Configure a translator with tuples to be emitted to a given stream.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>this to be able to chain configuration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPartitionRefreshPeriodMs-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPartitionRefreshPeriodMs</h4> |
| <pre>public <a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a> setPartitionRefreshPeriodMs(long partitionRefreshPeriodMs)</pre> |
| <div class="block"><p>Sets partition refresh period in milliseconds. This is how often Kafka will be polled to check for new topics and/or new partitions.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>partitionRefreshPeriodMs</code> - time in milliseconds</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder (this)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStartTimeStamp-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStartTimeStamp</h4> |
| <pre>public <a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">T</a> setStartTimeStamp(long startTimeStamp)</pre> |
| <div class="block"><p>Specifies the startTimeStamp if the first poll strategy is TIMESTAMP or UNCOMMITTED_TIMESTAMP.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startTimeStamp</code> - time in ms</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getKafkaProps--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKafkaProps</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getKafkaProps()</pre> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public abstract <a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig</a><<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">K</a>,<a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="type parameter in CommonKafkaSpoutConfig.Builder">V</a>> build()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><script type="text/javascript" src="../../../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/storm/kafka/spout/internal/ConsumerFactory.html" title="interface in org.apache.storm.kafka.spout.internal"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" target="_top">Frames</a></li> |
| <li><a href="CommonKafkaSpoutConfig.Builder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |