| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>StringConverterConfig (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: StringConverterConfig"> |
| <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><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.kafka.connect.storage</a></div> |
| <h1 title="Class StringConverterConfig" class="title">Class StringConverterConfig</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"><a href="../../common/config/AbstractConfig.html" title="class in org.apache.kafka.common.config">org.apache.kafka.common.config.AbstractConfig</a> |
| <div class="inheritance"><a href="ConverterConfig.html" title="class in org.apache.kafka.connect.storage">org.apache.kafka.connect.storage.ConverterConfig</a> |
| <div class="inheritance">org.apache.kafka.connect.storage.StringConverterConfig</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">StringConverterConfig</span> |
| <span class="extends-implements">extends <a href="ConverterConfig.html" title="class in org.apache.kafka.connect.storage">ConverterConfig</a></span></div> |
| <div class="block">Configuration options for <a href="StringConverter.html" title="class in org.apache.kafka.connect.storage"><code>StringConverter</code></a> instances.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <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"><code><a href="#ENCODING_CONFIG" class="member-name-link">ENCODING_CONFIG</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <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 odd-row-color"><code><a href="#ENCODING_DEFAULT" class="member-name-link">ENCODING_DEFAULT</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.kafka.connect.storage.ConverterConfig">Fields inherited from class org.apache.kafka.connect.storage.<a href="ConverterConfig.html" title="class in org.apache.kafka.connect.storage">ConverterConfig</a></h3> |
| <code><a href="ConverterConfig.html#TYPE_CONFIG">TYPE_CONFIG</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.kafka.common.config.AbstractConfig">Fields inherited from class org.apache.kafka.common.config.<a href="../../common/config/AbstractConfig.html" title="class in org.apache.kafka.common.config">AbstractConfig</a></h3> |
| <code><a href="../../common/config/AbstractConfig.html#CONFIG_PROVIDERS_CONFIG">CONFIG_PROVIDERS_CONFIG</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(java.util.Map)" class="member-name-link">StringConverterConfig</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>?> props)</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../../common/config/ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#configDef()" class="member-name-link">configDef</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#encoding()" class="member-name-link">encoding</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 string encoding.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.kafka.connect.storage.ConverterConfig">Methods inherited from class org.apache.kafka.connect.storage.<a href="ConverterConfig.html" title="class in org.apache.kafka.connect.storage">ConverterConfig</a></h3> |
| <code><a href="ConverterConfig.html#newConfigDef()">newConfigDef</a>, <a href="ConverterConfig.html#type()">type</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.kafka.common.config.AbstractConfig">Methods inherited from class org.apache.kafka.common.config.<a href="../../common/config/AbstractConfig.html" title="class in org.apache.kafka.common.config">AbstractConfig</a></h3> |
| <code><a href="../../common/config/AbstractConfig.html#documentationOf(java.lang.String)">documentationOf</a>, <a href="../../common/config/AbstractConfig.html#equals(java.lang.Object)">equals</a>, <a href="../../common/config/AbstractConfig.html#get(java.lang.String)">get</a>, <a href="../../common/config/AbstractConfig.html#getBoolean(java.lang.String)">getBoolean</a>, <a href="../../common/config/AbstractConfig.html#getClass(java.lang.String)">getClass</a>, <a href="../../common/config/AbstractConfig.html#getConfiguredInstance(java.lang.String,java.lang.Class)">getConfiguredInstance</a>, <a href="../../common/config/AbstractConfig.html#getConfiguredInstance(java.lang.String,java.lang.Class,java.util.Map)">getConfiguredInstance</a>, <a href="../../common/config/AbstractConfig.html#getConfiguredInstances(java.lang.String,java.lang.Class)">getConfiguredInstances</a>, <a href="../../common/config/AbstractConfig.html#getConfiguredInstances(java.lang.String,java.lang.Class,java.util.Map)">getConfiguredInstances</a>, <a href="../../common/config/AbstractConfig.html#getConfiguredInstances(java.util.List,java.lang.Class,java.util.Map)">getConfiguredInstances</a>, <a href="../../common/config/AbstractConfig.html#getDouble(java.lang.String)">getDouble</a>, <a href="../../common/config/AbstractConfig.html#getInt(java.lang.String)">getInt</a>, <a href="../../common/config/AbstractConfig.html#getList(java.lang.String)">getList</a>, <a href="../../common/config/AbstractConfig.html#getLong(java.lang.String)">getLong</a>, <a href="../../common/config/AbstractConfig.html#getPassword(java.lang.String)">getPassword</a>, <a href="../../common/config/AbstractConfig.html#getShort(java.lang.String)">getShort</a>, <a href="../../common/config/AbstractConfig.html#getString(java.lang.String)">getString</a>, <a href="../../common/config/AbstractConfig.html#hashCode()">hashCode</a>, <a href="../../common/config/AbstractConfig.html#ignore(java.lang.String)">ignore</a>, <a href="../../common/config/AbstractConfig.html#logUnused()">logUnused</a>, <a href="../../common/config/AbstractConfig.html#nonInternalValues()">nonInternalValues</a>, <a href="../../common/config/AbstractConfig.html#originals()">originals</a>, <a href="../../common/config/AbstractConfig.html#originals(java.util.Map)">originals</a>, <a href="../../common/config/AbstractConfig.html#originalsStrings()">originalsStrings</a>, <a href="../../common/config/AbstractConfig.html#originalsWithPrefix(java.lang.String)">originalsWithPrefix</a>, <a href="../../common/config/AbstractConfig.html#originalsWithPrefix(java.lang.String,boolean)">originalsWithPrefix</a>, <a href="../../common/config/AbstractConfig.html#postProcessParsedConfig(java.util.Map)">postProcessParsedConfig</a>, <a href="../../common/config/AbstractConfig.html#typeOf(java.lang.String)">typeOf</a>, <a href="../../common/config/AbstractConfig.html#unused()">unused</a>, <a href="../../common/config/AbstractConfig.html#values()">values</a>, <a href="../../common/config/AbstractConfig.html#valuesWithPrefixAllOrNothing(java.lang.String)">valuesWithPrefixAllOrNothing</a>, <a href="../../common/config/AbstractConfig.html#valuesWithPrefixOverride(java.lang.String)">valuesWithPrefixOverride</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/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#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#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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="ENCODING_CONFIG"> |
| <h3>ENCODING_CONFIG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">ENCODING_CONFIG</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.kafka.connect.storage.StringConverterConfig.ENCODING_CONFIG">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ENCODING_DEFAULT"> |
| <h3>ENCODING_DEFAULT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">ENCODING_DEFAULT</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.util.Map)"> |
| <h3>StringConverterConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">StringConverterConfig</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>?> props)</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="configDef()"> |
| <h3>configDef</h3> |
| <div class="member-signature"><span class="modifiers">public static</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">configDef</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="encoding()"> |
| <h3>encoding</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">encoding</span>()</div> |
| <div class="block">Get the string encoding.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the encoding; never null</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
