| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>StringConverter (kafka 3.6.1 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.kafka.connect.storage, class: StringConverter"> |
| <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 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="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>Field | </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.kafka.connect.storage</a></div> |
| <h1 title="Class StringConverter" class="title">Class StringConverter</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/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.kafka.connect.storage.StringConverter</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/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="../../common/Configurable.html" title="interface in org.apache.kafka.common">Configurable</a></code>, <code><a href="../components/Versioned.html" title="interface in org.apache.kafka.connect.components">Versioned</a></code>, <code><a href="Converter.html" title="interface in org.apache.kafka.connect.storage">Converter</a></code>, <code><a href="HeaderConverter.html" title="interface in org.apache.kafka.connect.storage">HeaderConverter</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">StringConverter</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="Converter.html" title="interface in org.apache.kafka.connect.storage">Converter</a>, <a href="HeaderConverter.html" title="interface in org.apache.kafka.connect.storage">HeaderConverter</a>, <a href="../components/Versioned.html" title="interface in org.apache.kafka.connect.components">Versioned</a></span></div> |
| <div class="block"><a href="Converter.html" title="interface in org.apache.kafka.connect.storage"><code>Converter</code></a> and <a href="HeaderConverter.html" title="interface in org.apache.kafka.connect.storage"><code>HeaderConverter</code></a> implementation that only supports serializing to strings. When converting Kafka Connect |
| data to bytes, the schema will be ignored and <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link"><code>Object.toString()</code></a> will always be invoked to convert the data to a String. |
| When converting from bytes to Kafka Connect format, the converter will only ever return an optional string schema and |
| a string or null. |
| <p> |
| Encoding configuration is identical to <a href="../../common/serialization/StringSerializer.html" title="class in org.apache.kafka.common.serialization"><code>StringSerializer</code></a> and <a href="../../common/serialization/StringDeserializer.html" title="class in org.apache.kafka.common.serialization"><code>StringDeserializer</code></a>, but for convenience |
| this class can also be configured to use the same encoding for both encoding and decoding with the |
| <a href="StringConverterConfig.html#ENCODING_CONFIG"><code>converter.encoding</code></a> setting. |
| <p> |
| This implementation currently does nothing with the topic names or header keys.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== 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()" class="member-name-link">StringConverter</a>()</code></div> |
| <div class="col-last even-row-color"> </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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</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="../../common/config/ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#config()" class="member-name-link">config</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configuration specification for this converter.</div> |
| </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="#configure(java.util.Map)" class="member-name-link">configure</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/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/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> configs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configure this class with the given key-value pairs</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configure(java.util.Map,boolean)" class="member-name-link">configure</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/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/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> configs, |
| boolean isKey)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configure this class.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fromConnectData(java.lang.String,org.apache.kafka.connect.data.Schema,java.lang.Object)" class="member-name-link">fromConnectData</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/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/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Convert a Kafka Connect data object to a native object for serialization.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fromConnectHeader(java.lang.String,java.lang.String,org.apache.kafka.connect.data.Schema,java.lang.Object)" class="member-name-link">fromConnectHeader</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> headerKey, |
| <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/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Convert the <a href="../header/Header.html" title="interface in org.apache.kafka.connect.header"><code>Header</code></a>'s <a href="../header/Header.html#value()"><code>value</code></a> into its byte array representation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../data/SchemaAndValue.html" title="class in org.apache.kafka.connect.data">SchemaAndValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toConnectData(java.lang.String,byte%5B%5D)" class="member-name-link">toConnectData</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| byte[] value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Convert a native object to a Kafka Connect data object for deserialization.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../data/SchemaAndValue.html" title="class in org.apache.kafka.connect.data">SchemaAndValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toConnectHeader(java.lang.String,java.lang.String,byte%5B%5D)" class="member-name-link">toConnectHeader</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> headerKey, |
| byte[] value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Convert the header name and byte array value into a <a href="../header/Header.html" title="interface in org.apache.kafka.connect.header"><code>Header</code></a> object.</div> |
| </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/17/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-tab2 method-summary-table-tab4"><code><a href="#version()" class="member-name-link">version</a>()</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 version of this component.</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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.kafka.connect.storage.Converter">Methods inherited from interface org.apache.kafka.connect.storage.<a href="Converter.html" title="interface in org.apache.kafka.connect.storage">Converter</a></h3> |
| <code><a href="Converter.html#fromConnectData(java.lang.String,org.apache.kafka.common.header.Headers,org.apache.kafka.connect.data.Schema,java.lang.Object)">fromConnectData</a>, <a href="Converter.html#toConnectData(java.lang.String,org.apache.kafka.common.header.Headers,byte%5B%5D)">toConnectData</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>()"> |
| <h3>StringConverter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StringConverter</span>()</div> |
| </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="version()"> |
| <h3>version</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/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">version</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../components/Versioned.html#version()">Versioned</a></code></span></div> |
| <div class="block">Get the version of this component.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../components/Versioned.html#version()">version</a></code> in interface <code><a href="../components/Versioned.html" title="interface in org.apache.kafka.connect.components">Versioned</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the version, formatted as a String. The version may not be <code>null</code> or empty.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="config()"> |
| <h3>config</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../common/config/ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">config</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Converter.html#config()">Converter</a></code></span></div> |
| <div class="block">Configuration specification for this converter.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Converter.html#config()">config</a></code> in interface <code><a href="Converter.html" title="interface in org.apache.kafka.connect.storage">Converter</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HeaderConverter.html#config()">config</a></code> in interface <code><a href="HeaderConverter.html" title="interface in org.apache.kafka.connect.storage">HeaderConverter</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the configuration specification; may not be null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="configure(java.util.Map)"> |
| <h3>configure</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configure</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/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/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> configs)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../common/Configurable.html#configure(java.util.Map)">Configurable</a></code></span></div> |
| <div class="block">Configure this class with the given key-value pairs</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../common/Configurable.html#configure(java.util.Map)">configure</a></code> in interface <code><a href="../../common/Configurable.html" title="interface in org.apache.kafka.common">Configurable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="configure(java.util.Map,boolean)"> |
| <h3>configure</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configure</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/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/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?> configs, |
| boolean isKey)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Converter.html#configure(java.util.Map,boolean)">Converter</a></code></span></div> |
| <div class="block">Configure this class.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Converter.html#configure(java.util.Map,boolean)">configure</a></code> in interface <code><a href="Converter.html" title="interface in org.apache.kafka.connect.storage">Converter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>configs</code> - configs in key/value pairs</dd> |
| <dd><code>isKey</code> - whether this converter is for a key or a 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="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">fromConnectData</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/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/17/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"><span class="descfrm-type-label">Description copied from interface: <code><a href="Converter.html#fromConnectData(java.lang.String,org.apache.kafka.connect.data.Schema,java.lang.Object)">Converter</a></code></span></div> |
| <div class="block">Convert a Kafka Connect data object to a native object for serialization.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Converter.html#fromConnectData(java.lang.String,org.apache.kafka.connect.data.Schema,java.lang.Object)">fromConnectData</a></code> in interface <code><a href="Converter.html" title="interface in org.apache.kafka.connect.storage">Converter</a></code></dd> |
| <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="toConnectData(java.lang.String,byte[])"> |
| <h3>toConnectData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../data/SchemaAndValue.html" title="class in org.apache.kafka.connect.data">SchemaAndValue</a></span> <span class="element-name">toConnectData</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/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"><span class="descfrm-type-label">Description copied from interface: <code><a href="Converter.html#toConnectData(java.lang.String,byte%5B%5D)">Converter</a></code></span></div> |
| <div class="block">Convert a native object to a Kafka Connect data object for deserialization.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Converter.html#toConnectData(java.lang.String,byte%5B%5D)">toConnectData</a></code> in interface <code><a href="Converter.html" title="interface in org.apache.kafka.connect.storage">Converter</a></code></dd> |
| <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="fromConnectHeader(java.lang.String,java.lang.String,org.apache.kafka.connect.data.Schema,java.lang.Object)"> |
| <h3>fromConnectHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">fromConnectHeader</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> headerKey, |
| <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/17/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"><span class="descfrm-type-label">Description copied from interface: <code><a href="HeaderConverter.html#fromConnectHeader(java.lang.String,java.lang.String,org.apache.kafka.connect.data.Schema,java.lang.Object)">HeaderConverter</a></code></span></div> |
| <div class="block">Convert the <a href="../header/Header.html" title="interface in org.apache.kafka.connect.header"><code>Header</code></a>'s <a href="../header/Header.html#value()"><code>value</code></a> into its byte array representation.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HeaderConverter.html#fromConnectHeader(java.lang.String,java.lang.String,org.apache.kafka.connect.data.Schema,java.lang.Object)">fromConnectHeader</a></code> in interface <code><a href="HeaderConverter.html" title="interface in org.apache.kafka.connect.storage">HeaderConverter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>topic</code> - the name of the topic for the record containing the header</dd> |
| <dd><code>headerKey</code> - the header's key; may not be null</dd> |
| <dd><code>schema</code> - the schema for the header's value; may be null</dd> |
| <dd><code>value</code> - the header's value to convert; may be null</dd> |
| <dt>Returns:</dt> |
| <dd>the byte array form of the Header's value; may be null if the value is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toConnectHeader(java.lang.String,java.lang.String,byte[])"> |
| <h3>toConnectHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../data/SchemaAndValue.html" title="class in org.apache.kafka.connect.data">SchemaAndValue</a></span> <span class="element-name">toConnectHeader</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topic, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> headerKey, |
| byte[] value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HeaderConverter.html#toConnectHeader(java.lang.String,java.lang.String,byte%5B%5D)">HeaderConverter</a></code></span></div> |
| <div class="block">Convert the header name and byte array value into a <a href="../header/Header.html" title="interface in org.apache.kafka.connect.header"><code>Header</code></a> object.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HeaderConverter.html#toConnectHeader(java.lang.String,java.lang.String,byte%5B%5D)">toConnectHeader</a></code> in interface <code><a href="HeaderConverter.html" title="interface in org.apache.kafka.connect.storage">HeaderConverter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>topic</code> - the name of the topic for the record containing the header</dd> |
| <dd><code>headerKey</code> - the header's key; may not be null</dd> |
| <dd><code>value</code> - the header's raw value; may be null</dd> |
| <dt>Returns:</dt> |
| <dd>the <a href="../data/SchemaAndValue.html" title="class in org.apache.kafka.connect.data"><code>SchemaAndValue</code></a>; may not be null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html#close()" title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
