| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>ConfigDef (kafka 4.0.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.common.config, class: ConfigDef"> |
| <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"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.7.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 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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <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> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li><a href="#nested-class-summary">Nested</a></li> |
| <li><a href="#field-summary">Field</a></li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <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> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </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.common.config</a></div> |
| <h1 title="Class ConfigDef" class="title">Class ConfigDef</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/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.common.config.ConfigDef</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">ConfigDef</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">This class is used for specifying the set of expected configurations. For each configuration, you can specify |
| the name, the type, the default value, the documentation, the group information, the order in the group, |
| the width of the configuration value and the name suitable for display in the UI. |
| |
| You can provide special validation logic used for single configuration validation by overriding <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config"><code>ConfigDef.Validator</code></a>. |
| |
| Moreover, you can specify the dependents of a configuration. The valid values and visibility of a configuration |
| may change according to the values of other configurations. You can override <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config"><code>ConfigDef.Recommender</code></a> to get valid |
| values and set visibility of a configuration given the current configuration values. |
| |
| <p/> |
| To use the class: |
| <p/> |
| <pre> |
| ConfigDef defs = new ConfigDef(); |
| |
| // check <a href="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String)"><code>define(String, Type, Object, Importance, String)</code></a> for more details. |
| defs.define("config_with_default", Type.STRING, "default string value", Importance.High, "Configuration with default value."); |
| // check <a href="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String)"><code>define(String, Type, Object, Validator, Importance, String)</code></a> for more details. |
| defs.define("config_with_validator", Type.INT, 42, Range.atLeast(0), Importance.High, "Configuration with user provided validator."); |
| // check <a href="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List)"><code>define(String, Type, Importance, String, String, int, Width, String, List<String>)</code></a> for more details. |
| defs.define("config_with_dependents", Type.INT, Importance.LOW, "Configuration with dependents.", "group", 1, Width.SHORT, "Config With Dependents", Arrays.asList("config_with_default","config_with_validator")); |
| |
| Map<String, String> props = new HashMap<>(); |
| props.put("config_with_default", "some value"); |
| props.put("config_with_dependents", "some other value"); |
| |
| Map<String, Object> configs = defs.parse(props); |
| // will return "some value" |
| String someConfig = (String) configs.get("config_with_default"); |
| // will return default value of 42 |
| int anotherConfig = (Integer) configs.get("config_with_validator"); |
| |
| // To validate the full configuration, use: |
| List<ConfigValue> configValues = defs.validate(props); |
| // The <a href="ConfigValue.html" title="class in org.apache.kafka.common.config"><code>ConfigValue</code></a> contains updated configuration information given the current configuration values. |
| </pre> |
| <p/> |
| This class can be used standalone or in combination with <a href="AbstractConfig.html" title="class in org.apache.kafka.common.config"><code>AbstractConfig</code></a> which provides some additional |
| functionality for accessing configs.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="ConfigDef.CaseInsensitiveValidString.html" class="type-name-link" title="class in org.apache.kafka.common.config">ConfigDef.CaseInsensitiveValidString</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="ConfigDef.CompositeValidator.html" class="type-name-link" title="class in org.apache.kafka.common.config">ConfigDef.CompositeValidator</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="ConfigDef.ConfigKey.html" class="type-name-link" title="class in org.apache.kafka.common.config">ConfigDef.ConfigKey</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static enum </code></div> |
| <div class="col-second odd-row-color"><code><a href="ConfigDef.Importance.html" class="type-name-link" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The importance level for a configuration</div> |
| </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="ConfigDef.LambdaValidator.html" class="type-name-link" title="class in org.apache.kafka.common.config">ConfigDef.LambdaValidator</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="ConfigDef.ListSize.html" class="type-name-link" title="class in org.apache.kafka.common.config">ConfigDef.ListSize</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="ConfigDef.NonEmptyString.html" class="type-name-link" title="class in org.apache.kafka.common.config">ConfigDef.NonEmptyString</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="ConfigDef.NonEmptyStringWithoutControlChars.html" class="type-name-link" title="class in org.apache.kafka.common.config">ConfigDef.NonEmptyStringWithoutControlChars</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="ConfigDef.NonNullValidator.html" class="type-name-link" title="class in org.apache.kafka.common.config">ConfigDef.NonNullValidator</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="ConfigDef.Range.html" class="type-name-link" title="class in org.apache.kafka.common.config">ConfigDef.Range</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Validation logic for numeric ranges</div> |
| </div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="ConfigDef.Recommender.html" class="type-name-link" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">This is used by the <a href="#validate(java.util.Map)"><code>validate(Map)</code></a> to get valid values for a configuration given the current |
| configuration values in order to perform full configuration validation and visibility modification.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static enum </code></div> |
| <div class="col-second odd-row-color"><code><a href="ConfigDef.Type.html" class="type-name-link" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The type for a configuration value</div> |
| </div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="ConfigDef.Validator.html" class="type-name-link" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Validation logic the user may provide to perform single configuration validation.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="ConfigDef.ValidList.html" class="type-name-link" title="class in org.apache.kafka.common.config">ConfigDef.ValidList</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="ConfigDef.ValidString.html" class="type-name-link" title="class in org.apache.kafka.common.config">ConfigDef.ValidString</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static enum </code></div> |
| <div class="col-second odd-row-color"><code><a href="ConfigDef.Width.html" class="type-name-link" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The width of a configuration value</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/21/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"><code><a href="#NO_DEFAULT_VALUE" class="member-name-link">NO_DEFAULT_VALUE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A unique Java object which represents the lack of a default value.</div> |
| </div> |
| </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()" class="member-name-link">ConfigDef</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.kafka.common.config.ConfigDef)" class="member-name-link">ConfigDef</a><wbr>(<a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a> base)</code></div> |
| <div class="col-last odd-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" aria-labelledby="method-summary-table-tab0"> |
| <div class="summary-table three-column-summary"> |
| <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/21/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><wbr><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="ConfigDef.ConfigKey.html" title="class in org.apache.kafka.common.config">ConfigDef.ConfigKey</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configKeys()" class="member-name-link">configKeys</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 configuration keys</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#convertToString(java.lang.Object,org.apache.kafka.common.config.ConfigDef.Type)" class="member-name-link">convertToString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> parsedValue, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><wbr><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#convertToStringMapWithPasswordValues(java.util.Map)" class="member-name-link">convertToStringMapWithPasswordValues</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/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/21/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-tab1 method-summary-table-tab4"> |
| <div class="block">Converts a map of config (key, value) pairs to a map of strings where each value |
| is converted to a string.</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/21/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><wbr><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#defaultValues()" class="member-name-link">defaultValues</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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-tab2 method-summary-table-tab4"><code><a href="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no special validation logic</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> alternativeString)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no special validation logic</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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-tab2 method-summary-table-tab4"><code><a href="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no special validation logic, not dependents and no custom recommender</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no special validation logic and no custom recommender</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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-tab2 method-summary-table-tab4"><code><a href="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List,org.apache.kafka.common.config.ConfigDef.Recommender)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no special validation logic</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,org.apache.kafka.common.config.ConfigDef.Recommender)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no special validation logic and no custom recommender</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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-tab2 method-summary-table-tab4"><code><a href="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no group, no order in group, no width, no display name, no dependents and no custom recommender</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no dependents and no custom recommender</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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-tab2 method-summary-table-tab4"><code><a href="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no custom recommender</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List,org.apache.kafka.common.config.ConfigDef.Recommender)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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-tab2 method-summary-table-tab4"><code><a href="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List,org.apache.kafka.common.config.ConfigDef.Recommender,java.lang.String)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> alternativeString)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,org.apache.kafka.common.config.ConfigDef.Recommender)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no dependents</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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-tab2 method-summary-table-tab4"><code><a href="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no default value and no special validation logic</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no default value, no special validation logic, no dependents and no custom recommender</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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-tab2 method-summary-table-tab4"><code><a href="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no default value, no special validation logic and no custom recommender</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List,org.apache.kafka.common.config.ConfigDef.Recommender)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no default value and no special validation logic</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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-tab2 method-summary-table-tab4"><code><a href="#define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,org.apache.kafka.common.config.ConfigDef.Recommender)" class="member-name-link">define</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new configuration with no default value, no special validation logic and no custom recommender</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#define(org.apache.kafka.common.config.ConfigDef.ConfigKey)" class="member-name-link">define</a><wbr>(<a href="ConfigDef.ConfigKey.html" title="class in org.apache.kafka.common.config">ConfigDef.ConfigKey</a> key)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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-tab2 method-summary-table-tab4"><code><a href="#defineInternal(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance)" class="member-name-link">defineInternal</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new internal configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#defineInternal(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String)" class="member-name-link">defineInternal</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Define a new internal configuration.</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="#embed(java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef)" class="member-name-link">embed</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> keyPrefix, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> groupPrefix, |
| int startingOrd, |
| <a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a> child)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="https://docs.oracle.com/en/java/javase/21/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="#groups()" class="member-name-link">groups</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 groups for the configuration</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/21/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><wbr><<a href="https://docs.oracle.com/en/java/javase/21/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="#names()" class="member-name-link">names</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns unmodifiable set of properties names defined in this <a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></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/21/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><wbr><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parse(java.util.Map)" class="member-name-link">parse</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><?,<wbr>?> props)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Parse and validate configs against this configuration definition.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/21/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-tab1 method-summary-table-tab4"><code><a href="#parseType(java.lang.String,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Type)" class="member-name-link">parseType</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Parse a value according to its expected type.</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/21/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="#toEnrichedRst()" class="member-name-link">toEnrichedRst</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configs with new metadata (group, orderInGroup, dependents) formatted with reStructuredText, suitable for embedding in Sphinx |
| documentation.</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/21/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="#toHtml()" class="member-name-link">toHtml</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="https://docs.oracle.com/en/java/javase/21/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="#toHtml(int,java.util.function.Function)" class="member-name-link">toHtml</a><wbr>(int headerDepth, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> idGenerator)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Converts this config into an HTML list that can be embedded into docs.</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/21/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="#toHtml(int,java.util.function.Function,java.util.Map)" class="member-name-link">toHtml</a><wbr>(int headerDepth, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> idGenerator, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dynamicUpdateModes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Converts this config into an HTML list that can be embedded into docs.</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/21/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="#toHtml(java.util.Map)" class="member-name-link">toHtml</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dynamicUpdateModes)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Converts this config into an HTML list that can be embedded into docs.</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/21/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="#toHtmlTable()" class="member-name-link">toHtmlTable</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="https://docs.oracle.com/en/java/javase/21/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="#toHtmlTable(java.util.Map)" class="member-name-link">toHtmlTable</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dynamicUpdateModes)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Converts this config into an HTML table that can be embedded into docs.</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/21/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="#toRst()" class="member-name-link">toRst</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 configs formatted with reStructuredText, suitable for embedding in Sphinx |
| documentation.</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/21/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="ConfigValue.html" title="class in org.apache.kafka.common.config">ConfigValue</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(java.util.Map)" class="member-name-link">validate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> props)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Validate the current configuration values with the configuration definition.</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/21/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><wbr><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="ConfigValue.html" title="class in org.apache.kafka.common.config">ConfigValue</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validateAll(java.util.Map)" class="member-name-link">validateAll</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> props)</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="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="#withClientSaslSupport()" class="member-name-link">withClientSaslSupport</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add standard SASL client configuration options.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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-tab2 method-summary-table-tab4"><code><a href="#withClientSslSupport()" class="member-name-link">withClientSslSupport</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add standard SSL client configuration options.</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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/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="NO_DEFAULT_VALUE"> |
| <h3>NO_DEFAULT_VALUE</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/21/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">NO_DEFAULT_VALUE</span></div> |
| <div class="block">A unique Java object which represents the lack of a default value.</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>()"> |
| <h3>ConfigDef</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ConfigDef</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.kafka.common.config.ConfigDef)"> |
| <h3>ConfigDef</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ConfigDef</span><wbr><span class="parameters">(<a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a> base)</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="names()"> |
| <h3>names</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/21/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">names</span>()</div> |
| <div class="block">Returns unmodifiable set of properties names defined in this <a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>new unmodifiable <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link"><code>Set</code></a> instance containing the keys</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defaultValues()"> |
| <h3>defaultValues</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/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">defaultValues</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(org.apache.kafka.common.config.ConfigDef.ConfigKey)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="ConfigDef.ConfigKey.html" title="class in org.apache.kafka.common.config">ConfigDef.ConfigKey</a> key)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List,org.apache.kafka.common.config.ConfigDef.Recommender)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender)</span></div> |
| <div class="block">Define a new configuration</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>defaultValue</code> - the default value to use if this config isn't present</dd> |
| <dd><code>validator</code> - the validator to use in checking the correctness of the config</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dd><code>dependents</code> - the configurations that are dependents of this configuration</dd> |
| <dd><code>recommender</code> - the recommender provides valid values given the parent configuration values</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List,org.apache.kafka.common.config.ConfigDef.Recommender,java.lang.String)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> alternativeString)</span></div> |
| <div class="block">Define a new configuration</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>defaultValue</code> - the default value to use if this config isn't present</dd> |
| <dd><code>validator</code> - the validator to use in checking the correctness of the config</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dd><code>dependents</code> - the configurations that are dependents of this configuration</dd> |
| <dd><code>recommender</code> - the recommender provides valid values given the parent configuration values</dd> |
| <dd><code>alternativeString</code> - the string which will be used to override the string of defaultValue</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents)</span></div> |
| <div class="block">Define a new configuration with no custom recommender</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>defaultValue</code> - the default value to use if this config isn't present</dd> |
| <dd><code>validator</code> - the validator to use in checking the correctness of the config</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dd><code>dependents</code> - the configurations that are dependents of this configuration</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,org.apache.kafka.common.config.ConfigDef.Recommender)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender)</span></div> |
| <div class="block">Define a new configuration with no dependents</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>defaultValue</code> - the default value to use if this config isn't present</dd> |
| <dd><code>validator</code> - the validator to use in checking the correctness of the config</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dd><code>recommender</code> - the recommender provides valid values given the parent configuration values</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName)</span></div> |
| <div class="block">Define a new configuration with no dependents and no custom recommender</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>defaultValue</code> - the default value to use if this config isn't present</dd> |
| <dd><code>validator</code> - the validator to use in checking the correctness of the config</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List,org.apache.kafka.common.config.ConfigDef.Recommender)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender)</span></div> |
| <div class="block">Define a new configuration with no special validation logic</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>defaultValue</code> - the default value to use if this config isn't present</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dd><code>dependents</code> - the configurations that are dependents of this configuration</dd> |
| <dd><code>recommender</code> - the recommender provides valid values given the parent configuration values</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents)</span></div> |
| <div class="block">Define a new configuration with no special validation logic and no custom recommender</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>defaultValue</code> - the default value to use if this config isn't present</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dd><code>dependents</code> - the configurations that are dependents of this configuration</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,org.apache.kafka.common.config.ConfigDef.Recommender)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender)</span></div> |
| <div class="block">Define a new configuration with no special validation logic and no custom recommender</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>defaultValue</code> - the default value to use if this config isn't present</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dd><code>recommender</code> - the recommender provides valid values given the parent configuration values</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName)</span></div> |
| <div class="block">Define a new configuration with no special validation logic, not dependents and no custom recommender</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>defaultValue</code> - the default value to use if this config isn't present</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List,org.apache.kafka.common.config.ConfigDef.Recommender)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender)</span></div> |
| <div class="block">Define a new configuration with no default value and no special validation logic</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dd><code>dependents</code> - the configurations that are dependents of this configuration</dd> |
| <dd><code>recommender</code> - the recommender provides valid values given the parent configuration value</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,java.util.List)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dependents)</span></div> |
| <div class="block">Define a new configuration with no default value, no special validation logic and no custom recommender</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dd><code>dependents</code> - the configurations that are dependents of this configuration</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String,org.apache.kafka.common.config.ConfigDef.Recommender)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName, |
| <a href="ConfigDef.Recommender.html" title="interface in org.apache.kafka.common.config">ConfigDef.Recommender</a> recommender)</span></div> |
| <div class="block">Define a new configuration with no default value, no special validation logic and no custom recommender</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dd><code>recommender</code> - the recommender provides valid values given the parent configuration value</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef.Width,java.lang.String)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> group, |
| int orderInGroup, |
| <a href="ConfigDef.Width.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Width</a> width, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> displayName)</span></div> |
| <div class="block">Define a new configuration with no default value, no special validation logic, no dependents and no custom recommender</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dd><code>group</code> - the group this config belongs to</dd> |
| <dd><code>orderInGroup</code> - the order of this config in the group</dd> |
| <dd><code>width</code> - the width of the config</dd> |
| <dd><code>displayName</code> - the name suitable for display</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation)</span></div> |
| <div class="block">Define a new configuration with no group, no order in group, no width, no display name, no dependents and no custom recommender</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the config parameter</dd> |
| <dd><code>type</code> - the type of the config</dd> |
| <dd><code>defaultValue</code> - the default value to use if this config isn't present</dd> |
| <dd><code>validator</code> - the validator to use in checking the correctness of the config</dd> |
| <dd><code>importance</code> - the importance of this config</dd> |
| <dd><code>documentation</code> - the documentation string for the config</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation)</span></div> |
| <div class="block">Define a new configuration with no special validation logic</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the config parameter</dd> |
| <dd><code>type</code> - The type of the config</dd> |
| <dd><code>defaultValue</code> - The default value to use if this config isn't present</dd> |
| <dd><code>importance</code> - The importance of this config: is this something you will likely need to change.</dd> |
| <dd><code>documentation</code> - The documentation string for the config</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String,java.lang.String)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> alternativeString)</span></div> |
| <div class="block">Define a new configuration with no special validation logic</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the config parameter</dd> |
| <dd><code>type</code> - The type of the config</dd> |
| <dd><code>defaultValue</code> - The default value to use if this config isn't present</dd> |
| <dd><code>importance</code> - The importance of this config: is this something you will likely need to change.</dd> |
| <dd><code>documentation</code> - The documentation string for the config</dd> |
| <dd><code>alternativeString</code> - The string which will be used to override the string of defaultValue</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="define(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String)"> |
| <h3>define</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">define</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation)</span></div> |
| <div class="block">Define a new configuration with no default value and no special validation logic</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the config parameter</dd> |
| <dd><code>type</code> - The type of the config</dd> |
| <dd><code>importance</code> - The importance of this config: is this something you will likely need to change.</dd> |
| <dd><code>documentation</code> - The documentation string for the config</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defineInternal(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Importance)"> |
| <h3>defineInternal</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">defineInternal</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance)</span></div> |
| <div class="block">Define a new internal configuration. Internal configuration won't show up in the docs and aren't |
| intended for general use.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the config parameter</dd> |
| <dd><code>type</code> - The type of the config</dd> |
| <dd><code>defaultValue</code> - The default value to use if this config isn't present</dd> |
| <dd><code>importance</code> - The importance of this config (i.e. is this something you will likely need to change?)</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defineInternal(java.lang.String,org.apache.kafka.common.config.ConfigDef.Type,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Validator,org.apache.kafka.common.config.ConfigDef.Importance,java.lang.String)"> |
| <h3>defineInternal</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">defineInternal</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> defaultValue, |
| <a href="ConfigDef.Validator.html" title="interface in org.apache.kafka.common.config">ConfigDef.Validator</a> validator, |
| <a href="ConfigDef.Importance.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Importance</a> importance, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> documentation)</span></div> |
| <div class="block">Define a new internal configuration. Internal configuration won't show up in the docs and aren't |
| intended for general use.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The name of the config parameter</dd> |
| <dd><code>type</code> - The type of the config</dd> |
| <dd><code>defaultValue</code> - The default value to use if this config isn't present</dd> |
| <dd><code>validator</code> - The validator to use in checking the correctness of the config</dd> |
| <dd><code>importance</code> - The importance of this config (i.e. is this something you will likely need to change?)</dd> |
| <dd><code>documentation</code> - The documentation string for the config</dd> |
| <dt>Returns:</dt> |
| <dd>This ConfigDef so you can chain calls</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="configKeys()"> |
| <h3>configKeys</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="ConfigDef.ConfigKey.html" title="class in org.apache.kafka.common.config">ConfigDef.ConfigKey</a>></span> <span class="element-name">configKeys</span>()</div> |
| <div class="block">Get the configuration keys</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a map containing all configuration keys</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="groups()"> |
| <h3>groups</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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/21/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">groups</span>()</div> |
| <div class="block">Get the groups for the configuration</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a list of group names</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withClientSslSupport()"> |
| <h3>withClientSslSupport</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">withClientSslSupport</span>()</div> |
| <div class="block">Add standard SSL client configuration options.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>this</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withClientSaslSupport()"> |
| <h3>withClientSaslSupport</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a></span> <span class="element-name">withClientSaslSupport</span>()</div> |
| <div class="block">Add standard SASL client configuration options.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>this</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parse(java.util.Map)"> |
| <h3>parse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/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">parse</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><?,<wbr>?> props)</span></div> |
| <div class="block">Parse and validate configs against this configuration definition. The input is a map of configs. It is expected |
| that the keys of the map are strings, but the values can either be strings or they may already be of the |
| appropriate type (int, string, etc). This will work equally well with either java.util.Properties instances or a |
| programmatically constructed map.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>props</code> - The configs to parse and validate.</dd> |
| <dt>Returns:</dt> |
| <dd>Parsed and validated configs. The key will be the config name and the value will be the value parsed into |
| the appropriate type (int, string, etc).</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(java.util.Map)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ConfigValue.html" title="class in org.apache.kafka.common.config">ConfigValue</a>></span> <span class="element-name">validate</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> props)</span></div> |
| <div class="block">Validate the current configuration values with the configuration definition.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>props</code> - the current configuration values</dd> |
| <dt>Returns:</dt> |
| <dd>List of Config, each Config contains the updated configuration information given |
| the current configuration values.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validateAll(java.util.Map)"> |
| <h3>validateAll</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="ConfigValue.html" title="class in org.apache.kafka.common.config">ConfigValue</a>></span> <span class="element-name">validateAll</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> props)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseType(java.lang.String,java.lang.Object,org.apache.kafka.common.config.ConfigDef.Type)"> |
| <h3>parseType</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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">parseType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type)</span></div> |
| <div class="block">Parse a value according to its expected type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The config name</dd> |
| <dd><code>value</code> - The config value</dd> |
| <dd><code>type</code> - The expected type</dd> |
| <dt>Returns:</dt> |
| <dd>The parsed object</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertToString(java.lang.Object,org.apache.kafka.common.config.ConfigDef.Type)"> |
| <h3>convertToString</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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">convertToString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> parsedValue, |
| <a href="ConfigDef.Type.html" title="enum class in org.apache.kafka.common.config">ConfigDef.Type</a> type)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertToStringMapWithPasswordValues(java.util.Map)"> |
| <h3>convertToStringMapWithPasswordValues</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/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">convertToStringMapWithPasswordValues</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/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/21/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">Converts a map of config (key, value) pairs to a map of strings where each value |
| is converted to a string. This method should be used with care since it stores |
| actual password values to String. Values from this map should never be used in log entries.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toHtmlTable()"> |
| <h3>toHtmlTable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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">toHtmlTable</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toHtmlTable(java.util.Map)"> |
| <h3>toHtmlTable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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">toHtmlTable</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dynamicUpdateModes)</span></div> |
| <div class="block">Converts this config into an HTML table that can be embedded into docs. |
| If <code>dynamicUpdateModes</code> is non-empty, a "Dynamic Update Mode" column |
| will be included n the table with the value of the update mode. Default |
| mode is "read-only".</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dynamicUpdateModes</code> - Config name -> update mode mapping</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toRst()"> |
| <h3>toRst</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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">toRst</span>()</div> |
| <div class="block">Get the configs formatted with reStructuredText, suitable for embedding in Sphinx |
| documentation.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toEnrichedRst()"> |
| <h3>toEnrichedRst</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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">toEnrichedRst</span>()</div> |
| <div class="block">Configs with new metadata (group, orderInGroup, dependents) formatted with reStructuredText, suitable for embedding in Sphinx |
| documentation.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="embed(java.lang.String,java.lang.String,int,org.apache.kafka.common.config.ConfigDef)"> |
| <h3>embed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">embed</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> keyPrefix, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> groupPrefix, |
| int startingOrd, |
| <a href="ConfigDef.html" title="class in org.apache.kafka.common.config">ConfigDef</a> child)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toHtml()"> |
| <h3>toHtml</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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">toHtml</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toHtml(int,java.util.function.Function)"> |
| <h3>toHtml</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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">toHtml</span><wbr><span class="parameters">(int headerDepth, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> idGenerator)</span></div> |
| <div class="block">Converts this config into an HTML list that can be embedded into docs.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>headerDepth</code> - The top level header depth in the generated HTML.</dd> |
| <dd><code>idGenerator</code> - A function for computing the HTML id attribute in the generated HTML from a given config name.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toHtml(java.util.Map)"> |
| <h3>toHtml</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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">toHtml</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dynamicUpdateModes)</span></div> |
| <div class="block">Converts this config into an HTML list that can be embedded into docs. |
| If <code>dynamicUpdateModes</code> is non-empty, a "Dynamic Update Mode" label |
| will be included in the config details with the value of the update mode. Default |
| mode is "read-only".</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dynamicUpdateModes</code> - Config name -> update mode mapping.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toHtml(int,java.util.function.Function,java.util.Map)"> |
| <h3>toHtml</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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">toHtml</span><wbr><span class="parameters">(int headerDepth, |
| <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> idGenerator, |
| <a href="https://docs.oracle.com/en/java/javase/21/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/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> dynamicUpdateModes)</span></div> |
| <div class="block">Converts this config into an HTML list that can be embedded into docs. |
| If <code>dynamicUpdateModes</code> is non-empty, a "Dynamic Update Mode" label |
| will be included in the config details with the value of the update mode. Default |
| mode is "read-only".</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>headerDepth</code> - The top level header depth in the generated HTML.</dd> |
| <dd><code>idGenerator</code> - A function for computing the HTML id attribute in the generated HTML from a given config name.</dd> |
| <dd><code>dynamicUpdateModes</code> - Config name -> update mode mapping.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
