| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ByTopicRecordTranslator (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: ByTopicRecordTranslator"> |
| <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/ByTopicRecordTranslator.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>Nested | </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>Field | </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 ByTopicRecordTranslator" class="title">Class ByTopicRecordTranslator<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">org.apache.storm.kafka.spout.ByTopicRecordTranslator<K,<wbr>V></div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - the key of the incoming Records</dd> |
| <dd><code>V</code> - the value of the incoming Records</dd> |
| </dl> |
| <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>, <code><a href="Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<K,<wbr>V>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>>></code>, <code><a href="RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><K,<wbr>V></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ByTopicRecordTranslator<K,<wbr>V></span> |
| <span class="extends-implements">extends <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> |
| implements <a href="RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><K,<wbr>V></span></div> |
| <div class="block">Based off of a given Kafka topic a ConsumerRecord came from it will be translated to a Storm tuple |
| and emitted to a given stream.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../serialized-form.html#org.apache.storm.kafka.spout.ByTopicRecordTranslator">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.storm.kafka.spout.RecordTranslator">Fields inherited from interface org.apache.storm.kafka.spout.<a href="RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a></h3> |
| <code><a href="RecordTranslator.html#DEFAULT_STREAM">DEFAULT_STREAM</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.Func,org.apache.storm.tuple.Fields)" class="member-name-link">ByTopicRecordTranslator</a><wbr>(<a href="Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>>> func, |
| <a href="../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Create a simple record translator that will use func to extract the fields of the tuple, |
| named by fields, and emit them to the default stream.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.storm.kafka.spout.Func,org.apache.storm.tuple.Fields,java.lang.String)" class="member-name-link">ByTopicRecordTranslator</a><wbr>(<a href="Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>>> func, |
| <a href="../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields, |
| <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> stream)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Create a simple record translator that will use func to extract the fields of the tuple, |
| named by fields, and emit them to stream.</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.storm.kafka.spout.RecordTranslator)" class="member-name-link">ByTopicRecordTranslator</a><wbr>(<a href="RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> defaultTranslator)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Create a record translator with the given default translator.</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-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-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#apply(org.apache.kafka.clients.consumer.ConsumerRecord)" class="member-name-link">apply</a><wbr>(org.apache.kafka.clients.consumer.ConsumerRecord<<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> record)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Translate the ConsumerRecord into a list of objects that can be emitted.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#forTopic(java.lang.String,org.apache.storm.kafka.spout.Func,org.apache.storm.tuple.Fields)" class="member-name-link">forTopic</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> topic, |
| <a href="Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>>> func, |
| <a href="../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configure a translator for a given topic with tuples to be emitted to the default stream.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#forTopic(java.lang.String,org.apache.storm.kafka.spout.Func,org.apache.storm.tuple.Fields,java.lang.String)" class="member-name-link">forTopic</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> topic, |
| <a href="Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>>> func, |
| <a href="../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields, |
| <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> stream)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configure a translator for a given topic.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#forTopic(java.lang.String,org.apache.storm.kafka.spout.RecordTranslator)" class="member-name-link">forTopic</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> topic, |
| <a href="RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> translator)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configure a translator for a given kafka topic.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFieldsFor(java.lang.String)" class="member-name-link">getFieldsFor</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> stream)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the fields associated with a stream.</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/util/List.html" title="class or interface in java.util" class="external-link">List</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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#streams()" class="member-name-link">streams</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the list of streams this translator will handle.</div> |
| </div> |
| </div> |
| </div> |
| </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#toString()" title="class or interface in java.lang" class="external-link">toString</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"> |
| <!-- ========= 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.Func,org.apache.storm.tuple.Fields,java.lang.String)"> |
| <h3>ByTopicRecordTranslator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ByTopicRecordTranslator</span><wbr><span class="parameters">(<a href="Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>>> func, |
| <a href="../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields, |
| <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> stream)</span></div> |
| <div class="block">Create a simple record translator that will use func to extract the fields of the tuple, |
| named by fields, and emit them to stream. This will handle all topics not explicitly set |
| elsewhere.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>func</code> - extracts and turns them into a list of objects to be emitted</dd> |
| <dd><code>fields</code> - the names of the fields extracted</dd> |
| <dd><code>stream</code> - the stream to emit these fields on.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.storm.kafka.spout.Func,org.apache.storm.tuple.Fields)"> |
| <h3>ByTopicRecordTranslator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ByTopicRecordTranslator</span><wbr><span class="parameters">(<a href="Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>>> func, |
| <a href="../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</span></div> |
| <div class="block">Create a simple record translator that will use func to extract the fields of the tuple, |
| named by fields, and emit them to the default stream. This will handle all topics not explicitly set |
| elsewhere.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>func</code> - extracts and turns them into a list of objects to be emitted</dd> |
| <dd><code>fields</code> - the names of the fields extracted</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.storm.kafka.spout.RecordTranslator)"> |
| <h3>ByTopicRecordTranslator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ByTopicRecordTranslator</span><wbr><span class="parameters">(<a href="RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> defaultTranslator)</span></div> |
| <div class="block">Create a record translator with the given default translator.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>defaultTranslator</code> - a translator that will be used for all topics not explicitly set |
| with one of the variants of <a href="#forTopic(java.lang.String,org.apache.storm.kafka.spout.RecordTranslator)"><code>forTopic(java.lang.String, org.apache.storm.kafka.spout.RecordTranslator)</code></a>.</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="forTopic(java.lang.String,org.apache.storm.kafka.spout.Func,org.apache.storm.tuple.Fields)"> |
| <h3>forTopic</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></span> <span class="element-name">forTopic</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> topic, |
| <a href="Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>>> func, |
| <a href="../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</span></div> |
| <div class="block">Configure a translator for a given topic with tuples to be emitted to the default stream.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topic</code> - the topic this should be used for</dd> |
| <dd><code>func</code> - extracts and turns them into a list of objects to be emitted</dd> |
| <dd><code>fields</code> - the names of the fields extracted</dd> |
| <dt>Returns:</dt> |
| <dd>this to be able to chain configuration</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the topic is already registered to another translator</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Fields for the stream this emits to do not match |
| any already configured Fields for the same stream</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="forTopic(java.lang.String,org.apache.storm.kafka.spout.Func,org.apache.storm.tuple.Fields,java.lang.String)"> |
| <h3>forTopic</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></span> <span class="element-name">forTopic</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> topic, |
| <a href="Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><org.apache.kafka.clients.consumer.ConsumerRecord<<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>>> func, |
| <a href="../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields, |
| <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> stream)</span></div> |
| <div class="block">Configure a translator for a given topic.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topic</code> - the topic this should be used for</dd> |
| <dd><code>func</code> - extracts and turns them into a list of objects to be emitted</dd> |
| <dd><code>fields</code> - the names of the fields extracted</dd> |
| <dd><code>stream</code> - the stream to emit the tuples to.</dd> |
| <dt>Returns:</dt> |
| <dd>this to be able to chain configuration</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the topic is already registered to another translator</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Fields for the stream this emits to do not match |
| any already configured Fields for the same stream</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="forTopic(java.lang.String,org.apache.storm.kafka.spout.RecordTranslator)"> |
| <h3>forTopic</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ByTopicRecordTranslator.html" title="class in org.apache.storm.kafka.spout">ByTopicRecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></span> <span class="element-name">forTopic</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> topic, |
| <a href="RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> translator)</span></div> |
| <div class="block">Configure a translator for a given kafka topic.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topic</code> - the topic this translator should handle</dd> |
| <dd><code>translator</code> - the translator itself</dd> |
| <dt>Returns:</dt> |
| <dd>this to be able to chain configuration</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the topic is already registered to another translator</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Fields for the stream this emits to do not match |
| any already configured Fields for the same stream</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="apply(org.apache.kafka.clients.consumer.ConsumerRecord)"> |
| <h3>apply</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>></span> <span class="element-name">apply</span><wbr><span class="parameters">(org.apache.kafka.clients.consumer.ConsumerRecord<<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>> record)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RecordTranslator.html#apply(org.apache.kafka.clients.consumer.ConsumerRecord)">RecordTranslator</a></code></span></div> |
| <div class="block">Translate the ConsumerRecord into a list of objects that can be emitted.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Func.html#apply(V)">apply</a></code> in interface <code><a href="Func.html" title="interface in org.apache.storm.kafka.spout">Func</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RecordTranslator.html#apply(org.apache.kafka.clients.consumer.ConsumerRecord)">apply</a></code> in interface <code><a href="RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>record</code> - the record to translate</dd> |
| <dt>Returns:</dt> |
| <dd>the objects in the tuple. Return a <a href="KafkaTuple.html" title="class in org.apache.storm.kafka.spout"><code>KafkaTuple</code></a> |
| if you want to route the tuple to a non-default stream. |
| Return <code>null</code> to discard an invalid <code>ConsumerRecord</code> |
| if <a href="KafkaSpoutConfig.Builder.html#setEmitNullTuples(boolean)"><code>KafkaSpoutConfig.Builder.setEmitNullTuples(boolean)</code></a> is set to <code>false</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFieldsFor(java.lang.String)"> |
| <h3>getFieldsFor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a></span> <span class="element-name">getFieldsFor</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> stream)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RecordTranslator.html#getFieldsFor(java.lang.String)">RecordTranslator</a></code></span></div> |
| <div class="block">Get the fields associated with a stream. The streams passed in are |
| returned by the <a href="RecordTranslator.html#streams()"><code>RecordTranslator.streams()</code></a> method.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RecordTranslator.html#getFieldsFor(java.lang.String)">getFieldsFor</a></code> in interface <code><a href="RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the stream the fields are for</dd> |
| <dt>Returns:</dt> |
| <dd>the fields for that stream.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="streams()"> |
| <h3>streams</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/util/List.html" title="class or interface in java.util" class="external-link">List</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>></span> <span class="element-name">streams</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RecordTranslator.html#streams()">RecordTranslator</a></code></span></div> |
| <div class="block">Get the list of streams this translator will handle.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RecordTranslator.html#streams()">streams</a></code> in interface <code><a href="RecordTranslator.html" title="interface in org.apache.storm.kafka.spout">RecordTranslator</a><<a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">K</a>,<wbr><a href="ByTopicRecordTranslator.html" title="type parameter in ByTopicRecordTranslator">V</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the list of streams that this will handle.</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> |
