Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / current / javadocs / org / apache / storm / kafka / spout / class-use / KafkaSpoutConfig.Builder.html
blob: 8fbbb33f902c6e16fcd45377214ae1cf06c68e84 [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>Uses of Class org.apache.storm.kafka.spout.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="Uses of Class org.apache.storm.kafka.spout.KafkaSpoutConfig.Builder (Storm 2.4.0 API)";
}
}
catch(err) {
}
//-->
</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><a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">Class</a></li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/storm/kafka/spout/class-use/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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.apache.storm.kafka.spout.KafkaSpoutConfig.Builder" class="title">Uses of Class<br>org.apache.storm.kafka.spout.KafkaSpoutConfig.Builder</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.storm.kafka.spout">org.apache.storm.kafka.spout</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.apache.storm.kafka.spout">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a> in <a href="../../../../../../org/apache/storm/kafka/spout/package-summary.html">org.apache.storm.kafka.spout</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../org/apache/storm/kafka/spout/package-summary.html">org.apache.storm.kafka.spout</a> that return <a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</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>,<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;</code></td>
<td class="colLast"><span class="typeNameLabel">KafkaSpoutConfig.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.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>
<div class="block">Factory method that creates a Builder with String key/value deserializers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</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>,<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;</code></td>
<td class="colLast"><span class="typeNameLabel">KafkaSpoutConfig.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.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>
<div class="block">Factory method that creates a Builder with String key/value deserializers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</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>,<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;</code></td>
<td class="colLast"><span class="typeNameLabel">KafkaSpoutConfig.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.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>
<div class="block">Factory method that creates a Builder with String key/value deserializers.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">KafkaSpoutConfig.Builder.</span><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 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"><span class="typeNameLabel">KafkaSpoutConfig.Builder.</span><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 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"><span class="typeNameLabel">KafkaSpoutConfig.Builder.</span><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 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"><span class="typeNameLabel">KafkaSpoutConfig.Builder.</span><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 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"><span class="typeNameLabel">KafkaSpoutConfig.Builder.</span><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 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"><span class="typeNameLabel">KafkaSpoutConfig.Builder.</span><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 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"><span class="typeNameLabel">KafkaSpoutConfig.Builder.</span><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 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"><span class="typeNameLabel">KafkaSpoutConfig.Builder.</span><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>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation">
<caption><span>Constructors in <a href="../../../../../../org/apache/storm/kafka/spout/package-summary.html">org.apache.storm.kafka.spout</a> with parameters of type <a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.html#KafkaSpoutConfig-org.apache.storm.kafka.spout.KafkaSpoutConfig.Builder-">KafkaSpoutConfig</a></span>(<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.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;&nbsp;builder)</code>
<div class="block">Creates a new KafkaSpoutConfig using a Builder.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= 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><a href="../../../../../../org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">Class</a></li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/storm/kafka/spout/class-use/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>
<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>