| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>KafkaSpoutConfig (Storm 2.6.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.storm.kafka.spout, class: KafkaSpoutConfig"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/KafkaSpoutConfig.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.kafka.spout</a></div> |
| <h1 title="Class KafkaSpoutConfig" class="title">Class KafkaSpoutConfig<K,<wbr>V></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="internal/CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal">org.apache.storm.kafka.spout.internal.CommonKafkaSpoutConfig</a><K,<wbr>V> |
| <div class="inheritance">org.apache.storm.kafka.spout.KafkaSpoutConfig<K,<wbr>V></div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">KafkaSpoutConfig<K,<wbr>V></span> |
| <span class="extends-implements">extends <a href="internal/CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig</a><K,<wbr>V></span></div> |
| <div class="block">KafkaSpoutConfig defines the required configuration to connect a consumer to a consumer group, as well as the subscribing topics.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../serialized-form.html#org.apache.storm.kafka.spout.KafkaSpoutConfig">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="KafkaSpoutConfig.Builder.html" class="type-name-link" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<a href="KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">K</a>,<wbr><a href="KafkaSpoutConfig.Builder.html" title="type parameter in KafkaSpoutConfig.Builder">V</a>></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static enum </code></div> |
| <div class="col-second odd-row-color"><code><a href="KafkaSpoutConfig.ProcessingGuarantee.html" class="type-name-link" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">This enum controls when the tuple with the <code>ConsumerRecord</code> for an offset is marked as processed, |
| i.e. when the offset can be committed to Kafka.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_MAX_RETRIES" class="member-name-link">DEFAULT_MAX_RETRIES</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_MAX_UNCOMMITTED_OFFSETS" class="member-name-link">DEFAULT_MAX_UNCOMMITTED_OFFSETS</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_METRICS_TIME_BUCKET_SIZE_SECONDS" class="member-name-link">DEFAULT_METRICS_TIME_BUCKET_SIZE_SECONDS</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_OFFSET_COMMIT_PERIOD_MS" class="member-name-link">DEFAULT_OFFSET_COMMIT_PERIOD_MS</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_PROCESSING_GUARANTEE" class="member-name-link">DEFAULT_PROCESSING_GUARANTEE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutRetryService</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_RETRY_SERVICE" class="member-name-link">DEFAULT_RETRY_SERVICE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="KafkaTupleListener.html" title="interface in org.apache.storm.kafka.spout">KafkaTupleListener</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_TUPLE_LISTENER" class="member-name-link">DEFAULT_TUPLE_LISTENER</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final org.slf4j.Logger</code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.storm.kafka.spout.internal.CommonKafkaSpoutConfig">Fields inherited from class org.apache.storm.kafka.spout.internal.<a href="internal/CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig</a></h3> |
| <code><a href="internal/CommonKafkaSpoutConfig.html#DEFAULT_FIRST_POLL_OFFSET_STRATEGY">DEFAULT_FIRST_POLL_OFFSET_STRATEGY</a>, <a href="internal/CommonKafkaSpoutConfig.html#DEFAULT_PARTITION_REFRESH_PERIOD_MS">DEFAULT_PARTITION_REFRESH_PERIOD_MS</a>, <a href="internal/CommonKafkaSpoutConfig.html#DEFAULT_POLL_TIMEOUT_MS">DEFAULT_POLL_TIMEOUT_MS</a>, <a href="internal/CommonKafkaSpoutConfig.html#DEFAULT_START_TS">DEFAULT_START_TS</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.storm.kafka.spout.KafkaSpoutConfig.Builder)" class="member-name-link">KafkaSpoutConfig</a><wbr>(<a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<a href="KafkaSpoutConfig.html" title="type parameter in KafkaSpoutConfig">K</a>,<wbr><a href="KafkaSpoutConfig.html" title="type parameter in KafkaSpoutConfig">V</a>> builder)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new KafkaSpoutConfig using a Builder.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder(java.lang.String,java.lang.String...)" class="member-name-link">builder</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> bootstrapServers, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>... topics)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Factory method that creates a Builder with String key/value deserializers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder(java.lang.String,java.util.regex.Pattern)" class="member-name-link">builder</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> bootstrapServers, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html" title="class or interface in java.util.regex" class="external-link">Pattern</a> topics)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Factory method that creates a Builder with String key/value deserializers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder(java.lang.String,java.util.Set)" class="member-name-link">builder</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> bootstrapServers, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> topics)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Factory method that creates a Builder with String key/value deserializers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConsumerGroupId()" class="member-name-link">getConsumerGroupId</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxUncommittedOffsets()" class="member-name-link">getMaxUncommittedOffsets</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMetricsTimeBucketSizeInSecs()" class="member-name-link">getMetricsTimeBucketSizeInSecs</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOffsetsCommitPeriodMs()" class="member-name-link">getOffsetsCommitPeriodMs</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getProcessingGuarantee()" class="member-name-link">getProcessingGuarantee</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutRetryService</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRetryService()" class="member-name-link">getRetryService</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaTupleListener.html" title="interface in org.apache.storm.kafka.spout">KafkaTupleListener</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTupleListener()" class="member-name-link">getTupleListener</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmitNullTuples()" class="member-name-link">isEmitNullTuples</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isTupleTrackingEnforced()" class="member-name-link">isTupleTrackingEnforced</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setConsumerGroupId(java.lang.String)" class="member-name-link">setConsumerGroupId</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> groupId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.kafka.spout.internal.CommonKafkaSpoutConfig">Methods inherited from class org.apache.storm.kafka.spout.internal.<a href="internal/CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig</a></h3> |
| <code><a href="internal/CommonKafkaSpoutConfig.html#getFirstPollOffsetStrategy()">getFirstPollOffsetStrategy</a>, <a href="internal/CommonKafkaSpoutConfig.html#getKafkaProps()">getKafkaProps</a>, <a href="internal/CommonKafkaSpoutConfig.html#getPartitionRefreshPeriodMs()">getPartitionRefreshPeriodMs</a>, <a href="internal/CommonKafkaSpoutConfig.html#getPollTimeoutMs()">getPollTimeoutMs</a>, <a href="internal/CommonKafkaSpoutConfig.html#getStartTimeStamp()">getStartTimeStamp</a>, <a href="internal/CommonKafkaSpoutConfig.html#getTopicFilter()">getTopicFilter</a>, <a href="internal/CommonKafkaSpoutConfig.html#getTopicPartitioner()">getTopicPartitioner</a>, <a href="internal/CommonKafkaSpoutConfig.html#getTranslator()">getTranslator</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="DEFAULT_OFFSET_COMMIT_PERIOD_MS"> |
| <h3>DEFAULT_OFFSET_COMMIT_PERIOD_MS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">long</span> <span class="element-name">DEFAULT_OFFSET_COMMIT_PERIOD_MS</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.storm.kafka.spout.KafkaSpoutConfig.DEFAULT_OFFSET_COMMIT_PERIOD_MS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_MAX_RETRIES"> |
| <h3>DEFAULT_MAX_RETRIES</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_MAX_RETRIES</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.storm.kafka.spout.KafkaSpoutConfig.DEFAULT_MAX_RETRIES">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_MAX_UNCOMMITTED_OFFSETS"> |
| <h3>DEFAULT_MAX_UNCOMMITTED_OFFSETS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_MAX_UNCOMMITTED_OFFSETS</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.storm.kafka.spout.KafkaSpoutConfig.DEFAULT_MAX_UNCOMMITTED_OFFSETS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_RETRY_SERVICE"> |
| <h3>DEFAULT_RETRY_SERVICE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutRetryService</a></span> <span class="element-name">DEFAULT_RETRY_SERVICE</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_PROCESSING_GUARANTEE"> |
| <h3>DEFAULT_PROCESSING_GUARANTEE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a></span> <span class="element-name">DEFAULT_PROCESSING_GUARANTEE</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_TUPLE_LISTENER"> |
| <h3>DEFAULT_TUPLE_LISTENER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="KafkaTupleListener.html" title="interface in org.apache.storm.kafka.spout">KafkaTupleListener</a></span> <span class="element-name">DEFAULT_TUPLE_LISTENER</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOG"> |
| <h3>LOG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name">LOG</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_METRICS_TIME_BUCKET_SIZE_SECONDS"> |
| <h3>DEFAULT_METRICS_TIME_BUCKET_SIZE_SECONDS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_METRICS_TIME_BUCKET_SIZE_SECONDS</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.storm.kafka.spout.KafkaSpoutConfig.DEFAULT_METRICS_TIME_BUCKET_SIZE_SECONDS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.storm.kafka.spout.KafkaSpoutConfig.Builder)"> |
| <h3>KafkaSpoutConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">KafkaSpoutConfig</span><wbr><span class="parameters">(<a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<a href="KafkaSpoutConfig.html" title="type parameter in KafkaSpoutConfig">K</a>,<wbr><a href="KafkaSpoutConfig.html" title="type parameter in KafkaSpoutConfig">V</a>> builder)</span></div> |
| <div class="block">Creates a new KafkaSpoutConfig using a Builder.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>builder</code> - The Builder to construct the KafkaSpoutConfig from</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="builder(java.lang.String,java.lang.String...)"> |
| <h3>builder</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">builder</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> bootstrapServers, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>... topics)</span></div> |
| <div class="block">Factory method that creates a Builder with String key/value deserializers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bootstrapServers</code> - The bootstrap servers for the consumer</dd> |
| <dd><code>topics</code> - The topics to subscribe to</dd> |
| <dt>Returns:</dt> |
| <dd>The new builder</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="builder(java.lang.String,java.util.Set)"> |
| <h3>builder</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">builder</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> bootstrapServers, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> topics)</span></div> |
| <div class="block">Factory method that creates a Builder with String key/value deserializers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bootstrapServers</code> - The bootstrap servers for the consumer</dd> |
| <dd><code>topics</code> - The topics to subscribe to</dd> |
| <dt>Returns:</dt> |
| <dd>The new builder</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="builder(java.lang.String,java.util.regex.Pattern)"> |
| <h3>builder</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KafkaSpoutConfig.Builder.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutConfig.Builder</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">builder</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> bootstrapServers, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html" title="class or interface in java.util.regex" class="external-link">Pattern</a> topics)</span></div> |
| <div class="block">Factory method that creates a Builder with String key/value deserializers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bootstrapServers</code> - The bootstrap servers for the consumer</dd> |
| <dd><code>topics</code> - The topic pattern to subscribe to</dd> |
| <dt>Returns:</dt> |
| <dd>The new builder</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOffsetsCommitPeriodMs()"> |
| <h3>getOffsetsCommitPeriodMs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getOffsetsCommitPeriodMs</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProcessingGuarantee()"> |
| <h3>getProcessingGuarantee</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaSpoutConfig.ProcessingGuarantee.html" title="enum in org.apache.storm.kafka.spout">KafkaSpoutConfig.ProcessingGuarantee</a></span> <span class="element-name">getProcessingGuarantee</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isTupleTrackingEnforced()"> |
| <h3>isTupleTrackingEnforced</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isTupleTrackingEnforced</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConsumerGroupId()"> |
| <h3>getConsumerGroupId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getConsumerGroupId</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setConsumerGroupId(java.lang.String)"> |
| <h3>setConsumerGroupId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setConsumerGroupId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> groupId)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxUncommittedOffsets()"> |
| <h3>getMaxUncommittedOffsets</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxUncommittedOffsets</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRetryService()"> |
| <h3>getRetryService</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaSpoutRetryService.html" title="interface in org.apache.storm.kafka.spout">KafkaSpoutRetryService</a></span> <span class="element-name">getRetryService</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTupleListener()"> |
| <h3>getTupleListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaTupleListener.html" title="interface in org.apache.storm.kafka.spout">KafkaTupleListener</a></span> <span class="element-name">getTupleListener</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEmitNullTuples()"> |
| <h3>isEmitNullTuples</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmitNullTuples</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMetricsTimeBucketSizeInSecs()"> |
| <h3>getMetricsTimeBucketSizeInSecs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMetricsTimeBucketSizeInSecs</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="internal/CommonKafkaSpoutConfig.html#toString()">toString</a></code> in class <code><a href="internal/CommonKafkaSpoutConfig.html" title="class in org.apache.storm.kafka.spout.internal">CommonKafkaSpoutConfig</a><<a href="KafkaSpoutConfig.html" title="type parameter in KafkaSpoutConfig">K</a>,<wbr><a href="KafkaSpoutConfig.html" title="type parameter in KafkaSpoutConfig">V</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
