blob: 7fe3bf7b7383d06ddc48e777fe42f014d01b03f4 [file] [log] [blame]
<!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.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="KafkaSpoutConfig.Builder (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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&lt;K,V&gt;</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><a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout.internal">org.apache.storm.kafka.spout.internal.CommonKafkaSpoutConfig.Builder</a>&lt;K,V,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;K,V&gt;&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.storm.kafka.spout.KafkaSpoutConfig.Builder&lt;K,V&gt;</li>
</ul>
</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>&lt;<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>&gt;</dd>
</dl>
<hr>
<br>
<pre>public static class <span class="typeNameLabel">KafkaSpoutConfig.Builder&lt;K,V&gt;</span>
extends <a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig.Builder</a>&lt;K,V,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;K,V&gt;&gt;</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">&nbsp;</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.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>&nbsp;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>&nbsp;topics)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.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>&nbsp;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>&lt;<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>&gt;&nbsp;topics)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.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>&nbsp;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>...&nbsp;topics)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.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>&nbsp;bootstrapServers,
<a href="../../../../../org/apache/storm/kafka/spout/subscription/TopicFilter.html" title="interface in org.apache.storm.kafka.spout.subscription">TopicFilter</a>&nbsp;topicFilter,
<a href="../../../../../org/apache/storm/kafka/spout/subscription/ManualPartitioner.html" title="interface in org.apache.storm.kafka.spout.subscription">ManualPartitioner</a>&nbsp;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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#build--">build</a></span>()</code>&nbsp;</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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setEmitNullTuples-boolean-">setEmitNullTuples</a></span>(boolean&nbsp;emitNullTuples)</code>
<div class="block">Specifies if the spout should emit null tuples to the component downstream, or rather not emit and directly ack them.</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>&lt;<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>&gt;</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&nbsp;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="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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setMetricsTimeBucketSizeInSecs-int-">setMetricsTimeBucketSizeInSecs</a></span>(int&nbsp;metricsTimeBucketSizeInSecs)</code>
<div class="block">The time period that metrics data in bucketed into.</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>&lt;<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>&gt;</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&nbsp;offsetCommitPeriodMs)</code>
<div class="block">Specifies the period, in milliseconds, the offset commit task is periodically called.</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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setProcessingGuarantee-org.apache.storm.kafka.spout.KafkaSpoutConfig.ProcessingGuarantee-">setProcessingGuarantee</a></span>(<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a>&nbsp;processingGuarantee)</code>
<div class="block">Specifies which processing guarantee the spout should offer.</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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setRetry-org.apache.storm.kafka.spout.KafkaSpoutRetryService-">setRetry</a></span>(<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutRetryService</a>&nbsp;retryService)</code>
<div class="block">Sets the retry service for the spout to use.</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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setTupleListener-org.apache.storm.kafka.spout.KafkaTupleListener-">setTupleListener</a></span>(<a href="../../../../../org/apache/storm/kafka/spout/KafkaTupleListener.html" title="interface in org.apache.storm.kafka.spout">KafkaTupleListener</a>&nbsp;tupleListener)</code>
<div class="block">Sets the tuple listener for the spout to use.</div>
</td>
</tr>
<tr id="i8" 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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setTupleTrackingEnforced-boolean-">setTupleTrackingEnforced</a></span>(boolean&nbsp;tupleTrackingEnforced)</code>
<div class="block">Specifies whether the spout should require Storm to track emitted tuples when using a <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><code>KafkaSpoutConfig.ProcessingGuarantee</code></a> other than <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html#AT_LEAST_ONCE"><code>KafkaSpoutConfig.ProcessingGuarantee.AT_LEAST_ONCE</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.kafka.spout.internal.CommonKafkaSpoutConfig.Builder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.storm.kafka.spout.internal.<a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig.Builder</a></h3>
<code><a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#getKafkaProps--">getKafkaProps</a>, <a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setFirstPollOffsetStrategy-org.apache.storm.kafka.spout.FirstPollOffsetStrategy-">setFirstPollOffsetStrategy</a>, <a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setPartitionRefreshPeriodMs-long-">setPartitionRefreshPeriodMs</a>, <a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setPollTimeoutMs-long-">setPollTimeoutMs</a>, <a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setProp-java.util.Map-">setProp</a>, <a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setProp-java.util.Properties-">setProp</a>, <a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setProp-java.lang.String-java.lang.Object-">setProp</a>, <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>, <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>, <a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setRecordTranslator-org.apache.storm.kafka.spout.RecordTranslator-">setRecordTranslator</a>, <a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#setStartTimeStamp-long-">setStartTimeStamp</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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&nbsp;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>&nbsp;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>...&nbsp;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&nbsp;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>&nbsp;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>&lt;<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>&gt;&nbsp;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&nbsp;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>&nbsp;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>&nbsp;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&nbsp;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>&nbsp;bootstrapServers,
<a href="../../../../../org/apache/storm/kafka/spout/subscription/TopicFilter.html" title="interface in org.apache.storm.kafka.spout.subscription">TopicFilter</a>&nbsp;topicFilter,
<a href="../../../../../org/apache/storm/kafka/spout/subscription/ManualPartitioner.html" title="interface in org.apache.storm.kafka.spout.subscription">ManualPartitioner</a>&nbsp;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="setOffsetCommitPeriodMs-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOffsetCommitPeriodMs</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<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>&gt;&nbsp;setOffsetCommitPeriodMs(long&nbsp;offsetCommitPeriodMs)</pre>
<div class="block"><p>Specifies the period, in milliseconds, the offset commit task is periodically called. Default is 15s.</p><p><p>This setting only has an effect if the configured <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><code>KafkaSpoutConfig.ProcessingGuarantee</code></a> is <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html#AT_LEAST_ONCE"><code>KafkaSpoutConfig.ProcessingGuarantee.AT_LEAST_ONCE</code></a> or <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html#NO_GUARANTEE"><code>KafkaSpoutConfig.ProcessingGuarantee.NO_GUARANTEE</code></a>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offsetCommitPeriodMs</code> - time in ms</dd>
</dl>
</li>
</ul>
<a name="setMaxUncommittedOffsets-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxUncommittedOffsets</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<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>&gt;&nbsp;setMaxUncommittedOffsets(int&nbsp;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 below 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>. This limit is per partition and may in some cases be exceeded, but each partition cannot exceed this limit by more than maxPollRecords - 1.</p><p><p>This setting only has an effect if the configured <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><code>KafkaSpoutConfig.ProcessingGuarantee</code></a> is <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html#AT_LEAST_ONCE"><code>KafkaSpoutConfig.ProcessingGuarantee.AT_LEAST_ONCE</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="setRetry-org.apache.storm.kafka.spout.KafkaSpoutRetryService-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRetry</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<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>&gt;&nbsp;setRetry(<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutRetryService</a>&nbsp;retryService)</pre>
<div class="block"><p>Sets the retry service for the spout to use.</p><p><p>This setting only has an effect if the configured <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><code>KafkaSpoutConfig.ProcessingGuarantee</code></a> is <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html#AT_LEAST_ONCE"><code>KafkaSpoutConfig.ProcessingGuarantee.AT_LEAST_ONCE</code></a>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>retryService</code> - the new retry service</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the builder (this).</dd>
</dl>
</li>
</ul>
<a name="setTupleListener-org.apache.storm.kafka.spout.KafkaTupleListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTupleListener</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<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>&gt;&nbsp;setTupleListener(<a href="../../../../../org/apache/storm/kafka/spout/KafkaTupleListener.html" title="interface in org.apache.storm.kafka.spout">KafkaTupleListener</a>&nbsp;tupleListener)</pre>
<div class="block"><p>Sets the tuple listener for the spout to use.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tupleListener</code> - the tuple listener</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the builder (this).</dd>
</dl>
</li>
</ul>
<a name="setEmitNullTuples-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEmitNullTuples</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<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>&gt;&nbsp;setEmitNullTuples(boolean&nbsp;emitNullTuples)</pre>
<div class="block"><p>Specifies if the spout should emit null tuples to the component downstream, or rather not emit and directly ack them. By default this parameter is set to false, which means that null tuples are not emitted.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>emitNullTuples</code> - sets if null tuples should or not be emitted downstream</dd>
</dl>
</li>
</ul>
<a name="setProcessingGuarantee-org.apache.storm.kafka.spout.KafkaSpoutConfig.ProcessingGuarantee-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProcessingGuarantee</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<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>&gt;&nbsp;setProcessingGuarantee(<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a>&nbsp;processingGuarantee)</pre>
<div class="block"><p>Specifies which processing guarantee the spout should offer. Refer to the documentation for <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><code>KafkaSpoutConfig.ProcessingGuarantee</code></a>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>processingGuarantee</code> - The processing guarantee the spout should offer.</dd>
</dl>
</li>
</ul>
<a name="setTupleTrackingEnforced-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTupleTrackingEnforced</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<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>&gt;&nbsp;setTupleTrackingEnforced(boolean&nbsp;tupleTrackingEnforced)</pre>
<div class="block"><p>Specifies whether the spout should require Storm to track emitted tuples when using a <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><code>KafkaSpoutConfig.ProcessingGuarantee</code></a> other than <a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html#AT_LEAST_ONCE"><code>KafkaSpoutConfig.ProcessingGuarantee.AT_LEAST_ONCE</code></a>. The spout will always track emitted tuples when offering at-least-once guarantees regardless of this setting. This setting is false by default.</p><p><p>Enabling tracking can be useful even in cases where reliability is not a concern, because it allows <a href="../../../../../org/apache/storm/Config.html#TOPOLOGY_MAX_SPOUT_PENDING"><code>Config.TOPOLOGY_MAX_SPOUT_PENDING</code></a> to have an effect, and enables some spout metrics (e.g. complete-latency) that would otherwise be disabled.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tupleTrackingEnforced</code> - true if Storm should track emitted tuples, false otherwise</dd>
</dl>
</li>
</ul>
<a name="setMetricsTimeBucketSizeInSecs-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMetricsTimeBucketSizeInSecs</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<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>&gt;&nbsp;setMetricsTimeBucketSizeInSecs(int&nbsp;metricsTimeBucketSizeInSecs)</pre>
<div class="block"><p>The time period that metrics data in bucketed into.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>metricsTimeBucketSizeInSecs</code> - time in seconds</dd>
</dl>
</li>
</ul>
<a name="build--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig</a>&lt;<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>&gt;&nbsp;build()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html#build--">build</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/storm/kafka/spout/internal/CommonKafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig.Builder</a>&lt;<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>,<a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a>&lt;<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>&gt;&gt;</code></dd>
</dl>
</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&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>