| <!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>KafkaSpoutConfig.Builder (Storm 2.0.0-SNAPSHOT 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="KafkaSpoutConfig.Builder (Storm 2.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Consumer.html" title="interface in org.apache.storm.kafka.spout"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" target="_top">Frames</a></li> |
| <li><a href="KafkaSpoutConfig.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</div> |
| <h2 title="Class KafkaSpoutConfig.Builder" class="title">Class KafkaSpoutConfig.Builder<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/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.KafkaSpoutConfig.Builder<K,V></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig</a><<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.html" title="type parameter in KafkaSpoutConfig">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.html" title="type parameter in KafkaSpoutConfig">V</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <span class="typeNameLabel">KafkaSpoutConfig.Builder<K,V></span> |
| extends <a href="http://docs.oracle.com/javase/7/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/KafkaSpoutConfig.Builder.html#Builder-java.util.Map-org.apache.storm.kafka.spout.KafkaSpoutStreams-org.apache.storm.kafka.spout.KafkaSpoutTuplesBuilder-">Builder</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> kafkaProps, |
| <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutStreams.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutStreams</a> kafkaSpoutStreams, |
| <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutTuplesBuilder.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutTuplesBuilder</a><<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>> tuplesBuilder)</code> |
| <div class="block">Please refer to javadoc in <code>#Builder(Map, KafkaSpoutStreams, KafkaSpoutTuplesBuilder, KafkaSpoutRetryService)</code>.<p/> This constructor uses by the default the following implementation for <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout"><code>KafkaSpoutRetryService</code></a>:<p/> <code>new KafkaSpoutRetryExponentialBackoff(TimeInterval.seconds(0), TimeInterval.milliSeconds(2), |
| DEFAULT_MAX_RETRIES, TimeInterval.seconds(10)))</code></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#Builder-java.util.Map-org.apache.storm.kafka.spout.KafkaSpoutStreams-org.apache.storm.kafka.spout.KafkaSpoutTuplesBuilder-org.apache.storm.kafka.spout.KafkaSpoutRetryService-">Builder</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> kafkaProps, |
| <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutStreams.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutStreams</a> kafkaSpoutStreams, |
| <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutTuplesBuilder.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutTuplesBuilder</a><<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>> tuplesBuilder, |
| <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutRetryService</a> retryService)</code> |
| <div class="block">KafkaSpoutConfig defines the required configuration to connect a consumer to a consumer group, as well as the subscribing topics The optional configuration can be specified using the set methods of this builder</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="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><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig</a><<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#build--">build</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setFirstPollOffsetStrategy-org.apache.storm.kafka.spout.KafkaSpoutConfig.FirstPollOffsetStrategy-">setFirstPollOffsetStrategy</a></span>(<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.FirstPollOffsetStrategy.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.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="i2" class="altColor"> |
| <td class="colFirst"><code><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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setKeyDeserializer-org.apache.kafka.common.serialization.Deserializer-">setKeyDeserializer</a></span>(org.apache.kafka.common.serialization.Deserializer<<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>> keyDeserializer)</code> |
| <div class="block">Specifying this key deserializer overrides the property key.deserializer</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setMaxRetries-int-">setMaxRetries</a></span>(int maxRetries)</code> |
| <div class="block">Defines the max number of retrials in case of tuple failure.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setMaxUncommittedOffsets-int-">setMaxUncommittedOffsets</a></span>(int maxUncommittedOffsets)</code> |
| <div class="block">Defines the max number of polled offsets (records) that can be pending commit, before another poll can take place.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setOffsetCommitPeriodMs-long-">setOffsetCommitPeriodMs</a></span>(long offsetCommitPeriodMs)</code> |
| <div class="block">Specifies the period, in milliseconds, the offset commit task is periodically called.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.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="i7" class="rowColor"> |
| <td class="colFirst"><code><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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setValueDeserializer-org.apache.kafka.common.serialization.Deserializer-">setValueDeserializer</a></span>(org.apache.kafka.common.serialization.Deserializer<<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>> valueDeserializer)</code> |
| <div class="block">Specifying this value deserializer overrides the property value.deserializer</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/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.util.Map-org.apache.storm.kafka.spout.KafkaSpoutStreams-org.apache.storm.kafka.spout.KafkaSpoutTuplesBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>public Builder(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> kafkaProps, |
| <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutStreams.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutStreams</a> kafkaSpoutStreams, |
| <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutTuplesBuilder.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutTuplesBuilder</a><<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>> tuplesBuilder)</pre> |
| <div class="block"><p>Please refer to javadoc in <code>#Builder(Map, KafkaSpoutStreams, KafkaSpoutTuplesBuilder, KafkaSpoutRetryService)</code>.<p/> This constructor uses by the default the following implementation for <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout"><code>KafkaSpoutRetryService</code></a>:<p/> <code>new KafkaSpoutRetryExponentialBackoff(TimeInterval.seconds(0), TimeInterval.milliSeconds(2), |
| DEFAULT_MAX_RETRIES, TimeInterval.seconds(10)))</code></p></div> |
| </li> |
| </ul> |
| <a name="Builder-java.util.Map-org.apache.storm.kafka.spout.KafkaSpoutStreams-org.apache.storm.kafka.spout.KafkaSpoutTuplesBuilder-org.apache.storm.kafka.spout.KafkaSpoutRetryService-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>public Builder(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> kafkaProps, |
| <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutStreams.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutStreams</a> kafkaSpoutStreams, |
| <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutTuplesBuilder.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutTuplesBuilder</a><<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>> tuplesBuilder, |
| <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutRetryService</a> retryService)</pre> |
| <div class="block"><p>KafkaSpoutConfig defines the required configuration to connect a consumer to a consumer group, as well as the subscribing topics The optional configuration can be specified using the set methods of this builder</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>kafkaProps</code> - properties defining consumer connection to Kafka broker as specified in @see <a href="http://kafka.apache.org/090/javadoc/index.html?org/apache/kafka/clients/consumer/KafkaConsumer.html">KafkaConsumer</a></dd> |
| <dd><code>kafkaSpoutStreams</code> - streams to where the tuples are emitted for each tuple. Multiple topics can emit in the same stream.</dd> |
| <dd><code>tuplesBuilder</code> - logic to build tuples from <code>ConsumerRecord</code>s.</dd> |
| <dd><code>retryService</code> - logic that manages the retrial of failed tuples</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="setKeyDeserializer-org.apache.kafka.common.serialization.Deserializer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKeyDeserializer</h4> |
| <pre>public <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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>> setKeyDeserializer(org.apache.kafka.common.serialization.Deserializer<<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>> keyDeserializer)</pre> |
| <div class="block"><p>Specifying this key deserializer overrides the property key.deserializer</p></div> |
| </li> |
| </ul> |
| <a name="setValueDeserializer-org.apache.kafka.common.serialization.Deserializer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueDeserializer</h4> |
| <pre>public <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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>> setValueDeserializer(org.apache.kafka.common.serialization.Deserializer<<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>> valueDeserializer)</pre> |
| <div class="block"><p>Specifying this value deserializer overrides the property value.deserializer</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/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</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 2s</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pollTimeoutMs</code> - time in ms</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOffsetCommitPeriodMs-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOffsetCommitPeriodMs</h4> |
| <pre>public <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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>> setOffsetCommitPeriodMs(long offsetCommitPeriodMs)</pre> |
| <div class="block"><p>Specifies the period, in milliseconds, the offset commit task is periodically called. Default is 15s.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>offsetCommitPeriodMs</code> - time in ms</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxRetries-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxRetries</h4> |
| <pre>public <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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>> setMaxRetries(int maxRetries)</pre> |
| <div class="block"><p>Defines the max number of retrials in case of tuple failure. The default is to retry forever, which means that no new records are committed until the previous polled records have been acked. This guarantees at once delivery of all the previously polled records. By specifying a finite value for maxRetries, the user decides to sacrifice guarantee of delivery for the previous polled records in favor of processing more records.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxRetries</code> - max number of retrials</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxUncommittedOffsets-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxUncommittedOffsets</h4> |
| <pre>public <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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>> setMaxUncommittedOffsets(int maxUncommittedOffsets)</pre> |
| <div class="block"><p>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 bellow the threshold. The default is <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.html#DEFAULT_MAX_UNCOMMITTED_OFFSETS"><code>KafkaSpoutConfig.DEFAULT_MAX_UNCOMMITTED_OFFSETS</code></a>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxUncommittedOffsets</code> - max number of records that can be be pending commit</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFirstPollOffsetStrategy-org.apache.storm.kafka.spout.KafkaSpoutConfig.FirstPollOffsetStrategy-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFirstPollOffsetStrategy</h4> |
| <pre>public <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/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>> setFirstPollOffsetStrategy(<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.FirstPollOffsetStrategy.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.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/KafkaSpoutConfig.FirstPollOffsetStrategy.html" title="enum in org.apache.storm.kafka.spout"><code>KafkaSpoutConfig.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="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig</a><<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.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/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">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/KafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Consumer.html" title="interface in org.apache.storm.kafka.spout"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" target="_top">Frames</a></li> |
| <li><a href="KafkaSpoutConfig.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 © 2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
