| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Converter (kafka 3.0.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.kafka.connect.storage, interface: Converter"> |
| <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.5.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 data = {"i0":6,"i1":18,"i2":6,"i3":6,"i4":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "alt-color"; |
| var rowColor = "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="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="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" 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.kafka.connect.storage</a></div> |
| <h1 title="Interface Converter" class="title">Interface Converter</h1> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="StringConverter.html" title="class in org.apache.kafka.connect.storage">StringConverter</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="type-name-label">Converter</span></pre> |
| <div class="block">The Converter interface provides support for translating between Kafka Connect's runtime data format |
| and byte[]. Internally, this likely includes an intermediate step to the format used by the serialization |
| layer (e.g. JsonNode, GenericRecord, Message).</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div class="member-summary" id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="table-tab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t5" class="table-tab" onclick="show(16);">Default Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <table class="summary-table" aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="col-first" scope="col">Modifier and Type</th> |
| <th class="col-second" scope="col">Method</th> |
| <th class="col-last" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="alt-color" id="i0"> |
| <td class="col-first"><code>void</code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#configure(java.util.Map,boolean)">configure</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,​?> configs, |
| boolean isKey)</code></th> |
| <td class="col-last"> |
| <div class="block">Configure this class.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i1"> |
| <td class="col-first"><code>default byte[]</code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#fromConnectData(java.lang.String,org.apache.kafka.common.header.Headers,org.apache.kafka.connect.data.Schema,java.lang.Object)">fromConnectData</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| <a href="../../common/header/Headers.html" title="interface in org.apache.kafka.common.header">Headers</a> headers, |
| <a href="../data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> schema, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></th> |
| <td class="col-last"> |
| <div class="block">Convert a Kafka Connect data object to a native object for serialization, |
| potentially using the supplied topic and headers in the record as necessary.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i2"> |
| <td class="col-first"><code>byte[]</code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#fromConnectData(java.lang.String,org.apache.kafka.connect.data.Schema,java.lang.Object)">fromConnectData</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| <a href="../data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> schema, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></th> |
| <td class="col-last"> |
| <div class="block">Convert a Kafka Connect data object to a native object for serialization.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i3"> |
| <td class="col-first"><code><a href="../data/SchemaAndValue.html" title="class in org.apache.kafka.connect.data">SchemaAndValue</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#toConnectData(java.lang.String,byte%5B%5D)">toConnectData</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| byte[] value)</code></th> |
| <td class="col-last"> |
| <div class="block">Convert a native object to a Kafka Connect data object.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i4"> |
| <td class="col-first"><code>default <a href="../data/SchemaAndValue.html" title="class in org.apache.kafka.connect.data">SchemaAndValue</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#toConnectData(java.lang.String,org.apache.kafka.common.header.Headers,byte%5B%5D)">toConnectData</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| <a href="../../common/header/Headers.html" title="interface in org.apache.kafka.common.header">Headers</a> headers, |
| byte[] value)</code></th> |
| <td class="col-last"> |
| <div class="block">Convert a native object to a Kafka Connect data object, |
| potentially using the supplied topic and headers in the record as necessary.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="configure(java.util.Map,boolean)"> |
| <h3>configure</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="member-name">configure</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,​?> configs, |
| boolean isKey)</span></div> |
| <div class="block">Configure this class.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>configs</code> - configs in key/value pairs</dd> |
| <dd><code>isKey</code> - whether is for key or value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fromConnectData(java.lang.String,org.apache.kafka.connect.data.Schema,java.lang.Object)"> |
| <h3>fromConnectData</h3> |
| <div class="member-signature"><span class="return-type">byte[]</span> <span class="member-name">fromConnectData</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| <a href="../data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> schema, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</span></div> |
| <div class="block">Convert a Kafka Connect data object to a native object for serialization.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topic</code> - the topic associated with the data</dd> |
| <dd><code>schema</code> - the schema for the value</dd> |
| <dd><code>value</code> - the value to convert</dd> |
| <dt>Returns:</dt> |
| <dd>the serialized value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fromConnectData(java.lang.String,org.apache.kafka.common.header.Headers,org.apache.kafka.connect.data.Schema,java.lang.Object)"> |
| <h3>fromConnectData</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">byte[]</span> <span class="member-name">fromConnectData</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| <a href="../../common/header/Headers.html" title="interface in org.apache.kafka.common.header">Headers</a> headers, |
| <a href="../data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> schema, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</span></div> |
| <div class="block">Convert a Kafka Connect data object to a native object for serialization, |
| potentially using the supplied topic and headers in the record as necessary. |
| |
| <p>Connect uses this method directly, and for backward compatibility reasons this method |
| by default will call the <a href="#fromConnectData(java.lang.String,org.apache.kafka.connect.data.Schema,java.lang.Object)"><code>fromConnectData(String, Schema, Object)</code></a> method. |
| Override this method to make use of the supplied headers.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topic</code> - the topic associated with the data</dd> |
| <dd><code>headers</code> - the headers associated with the data; any changes done to the headers |
| are applied to the message sent to the broker</dd> |
| <dd><code>schema</code> - the schema for the value</dd> |
| <dd><code>value</code> - the value to convert</dd> |
| <dt>Returns:</dt> |
| <dd>the serialized value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toConnectData(java.lang.String,byte[])"> |
| <h3>toConnectData</h3> |
| <div class="member-signature"><span class="return-type"><a href="../data/SchemaAndValue.html" title="class in org.apache.kafka.connect.data">SchemaAndValue</a></span> <span class="member-name">toConnectData</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| byte[] value)</span></div> |
| <div class="block">Convert a native object to a Kafka Connect data object.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topic</code> - the topic associated with the data</dd> |
| <dd><code>value</code> - the value to convert</dd> |
| <dt>Returns:</dt> |
| <dd>an object containing the <a href="../data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a> and the converted value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toConnectData(java.lang.String,org.apache.kafka.common.header.Headers,byte[])"> |
| <h3>toConnectData</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="../data/SchemaAndValue.html" title="class in org.apache.kafka.connect.data">SchemaAndValue</a></span> <span class="member-name">toConnectData</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| <a href="../../common/header/Headers.html" title="interface in org.apache.kafka.common.header">Headers</a> headers, |
| byte[] value)</span></div> |
| <div class="block">Convert a native object to a Kafka Connect data object, |
| potentially using the supplied topic and headers in the record as necessary. |
| |
| <p>Connect uses this method directly, and for backward compatibility reasons this method |
| by default will call the <a href="#toConnectData(java.lang.String,byte%5B%5D)"><code>toConnectData(String, byte[])</code></a> method. |
| Override this method to make use of the supplied headers.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topic</code> - the topic associated with the data</dd> |
| <dd><code>headers</code> - the headers associated with the data</dd> |
| <dd><code>value</code> - the value to convert</dd> |
| <dt>Returns:</dt> |
| <dd>an object containing the <a href="../data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a> and the converted value</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottom-nav" id="navbar.bottom"> |
| <div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar.bottom.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="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="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <span class="skip-nav" id="skip.navbar.bottom"> |
| <!-- --> |
| </span></nav> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
