| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Schema (kafka 3.6.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.kafka.connect.data, interface: Schema"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </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>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.kafka.connect.data</a></div> |
| <h1 title="Interface Schema" class="title">Interface Schema</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="ConnectSchema.html" title="class in org.apache.kafka.connect.data">ConnectSchema</a></code>, <code><a href="SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Schema</span></div> |
| <div class="block"><p> |
| Definition of an abstract data type. Data types can be primitive types (integer types, floating point types, |
| boolean, strings, and bytes) or complex types (typed arrays, maps with one key schema and value schema, |
| and structs that have a fixed set of field names each with an associated value schema). Any type can be specified |
| as optional, allowing it to be omitted (resulting in null values when it is missing) and can specify a default |
| value. |
| </p> |
| <p> |
| All schemas may have some associated metadata: a name, version, and documentation. These are all considered part |
| of the schema itself and included when comparing schemas. Besides adding important metadata, these fields enable |
| the specification of logical types that specify additional constraints and semantics (e.g. UNIX timestamps are |
| just an int64, but the user needs the know about the additional semantics to interpret it properly). |
| </p> |
| <p> |
| Schemas can be created directly, but in most cases using <a href="SchemaBuilder.html" title="class in org.apache.kafka.connect.data"><code>SchemaBuilder</code></a> will be simpler. |
| </p></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">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="Schema.Type.html" class="type-name-link" title="enum class in org.apache.kafka.connect.data">Schema.Type</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The type of a schema.</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="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#BOOLEAN_SCHEMA" class="member-name-link">BOOLEAN_SCHEMA</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#BYTES_SCHEMA" class="member-name-link">BYTES_SCHEMA</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#FLOAT32_SCHEMA" class="member-name-link">FLOAT32_SCHEMA</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#FLOAT64_SCHEMA" class="member-name-link">FLOAT64_SCHEMA</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#INT16_SCHEMA" class="member-name-link">INT16_SCHEMA</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#INT32_SCHEMA" class="member-name-link">INT32_SCHEMA</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#INT64_SCHEMA" class="member-name-link">INT64_SCHEMA</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#INT8_SCHEMA" class="member-name-link">INT8_SCHEMA</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#OPTIONAL_BOOLEAN_SCHEMA" class="member-name-link">OPTIONAL_BOOLEAN_SCHEMA</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#OPTIONAL_BYTES_SCHEMA" class="member-name-link">OPTIONAL_BYTES_SCHEMA</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#OPTIONAL_FLOAT32_SCHEMA" class="member-name-link">OPTIONAL_FLOAT32_SCHEMA</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#OPTIONAL_FLOAT64_SCHEMA" class="member-name-link">OPTIONAL_FLOAT64_SCHEMA</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#OPTIONAL_INT16_SCHEMA" class="member-name-link">OPTIONAL_INT16_SCHEMA</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#OPTIONAL_INT32_SCHEMA" class="member-name-link">OPTIONAL_INT32_SCHEMA</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#OPTIONAL_INT64_SCHEMA" class="member-name-link">OPTIONAL_INT64_SCHEMA</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#OPTIONAL_INT8_SCHEMA" class="member-name-link">OPTIONAL_INT8_SCHEMA</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#OPTIONAL_STRING_SCHEMA" class="member-name-link">OPTIONAL_STRING_SCHEMA</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#STRING_SCHEMA" class="member-name-link">STRING_SCHEMA</a></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-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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#defaultValue()" class="member-name-link">defaultValue</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#doc()" class="member-name-link">doc</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Field.html" title="class in org.apache.kafka.connect.data">Field</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#field(java.lang.String)" class="member-name-link">field</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fieldName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get a <a href="Field.html" title="class in org.apache.kafka.connect.data"><code>Field</code></a> for this Schema by name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Field.html" title="class in org.apache.kafka.connect.data">Field</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#fields()" class="member-name-link">fields</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the list of Fields for this Schema.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isOptional()" class="member-name-link">isOptional</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#keySchema()" class="member-name-link">keySchema</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the key schema for this map schema.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#name()" class="member-name-link">name</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#parameters()" class="member-name-link">parameters</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get a map of schema parameters.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#schema()" class="member-name-link">schema</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return a concrete instance of the <a href="Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Schema.Type.html" title="enum class in org.apache.kafka.connect.data">Schema.Type</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#type()" class="member-name-link">type</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#valueSchema()" class="member-name-link">valueSchema</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the value schema for this map or array schema.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#version()" class="member-name-link">version</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the optional version of the schema.</div> |
| </div> |
| </div> |
| </div> |
| </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="INT8_SCHEMA"> |
| <h3>INT8_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">INT8_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INT16_SCHEMA"> |
| <h3>INT16_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">INT16_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INT32_SCHEMA"> |
| <h3>INT32_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">INT32_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INT64_SCHEMA"> |
| <h3>INT64_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">INT64_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FLOAT32_SCHEMA"> |
| <h3>FLOAT32_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">FLOAT32_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FLOAT64_SCHEMA"> |
| <h3>FLOAT64_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">FLOAT64_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="BOOLEAN_SCHEMA"> |
| <h3>BOOLEAN_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">BOOLEAN_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="STRING_SCHEMA"> |
| <h3>STRING_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">STRING_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="BYTES_SCHEMA"> |
| <h3>BYTES_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">BYTES_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OPTIONAL_INT8_SCHEMA"> |
| <h3>OPTIONAL_INT8_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">OPTIONAL_INT8_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OPTIONAL_INT16_SCHEMA"> |
| <h3>OPTIONAL_INT16_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">OPTIONAL_INT16_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OPTIONAL_INT32_SCHEMA"> |
| <h3>OPTIONAL_INT32_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">OPTIONAL_INT32_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OPTIONAL_INT64_SCHEMA"> |
| <h3>OPTIONAL_INT64_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">OPTIONAL_INT64_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OPTIONAL_FLOAT32_SCHEMA"> |
| <h3>OPTIONAL_FLOAT32_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">OPTIONAL_FLOAT32_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OPTIONAL_FLOAT64_SCHEMA"> |
| <h3>OPTIONAL_FLOAT64_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">OPTIONAL_FLOAT64_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OPTIONAL_BOOLEAN_SCHEMA"> |
| <h3>OPTIONAL_BOOLEAN_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">OPTIONAL_BOOLEAN_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OPTIONAL_STRING_SCHEMA"> |
| <h3>OPTIONAL_STRING_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">OPTIONAL_STRING_SCHEMA</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OPTIONAL_BYTES_SCHEMA"> |
| <h3>OPTIONAL_BYTES_SCHEMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">OPTIONAL_BYTES_SCHEMA</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="type()"> |
| <h3>type</h3> |
| <div class="member-signature"><span class="return-type"><a href="Schema.Type.html" title="enum class in org.apache.kafka.connect.data">Schema.Type</a></span> <span class="element-name">type</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the type of this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isOptional()"> |
| <h3>isOptional</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isOptional</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if this field is optional, false otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defaultValue()"> |
| <h3>defaultValue</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">defaultValue</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the default value for this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="name()"> |
| <h3>name</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">name</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the name of this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="version()"> |
| <h3>version</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">version</span>()</div> |
| <div class="block">Get the optional version of the schema. If a version is included, newer versions <b>must</b> be larger than older ones.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the version of this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doc()"> |
| <h3>doc</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">doc</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the documentation for this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parameters()"> |
| <h3>parameters</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">parameters</span>()</div> |
| <div class="block">Get a map of schema parameters.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Map containing parameters for this schema, or null if there are no parameters</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keySchema()"> |
| <h3>keySchema</h3> |
| <div class="member-signature"><span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">keySchema</span>()</div> |
| <div class="block">Get the key schema for this map schema. Throws a <a href="../errors/DataException.html" title="class in org.apache.kafka.connect.errors"><code>DataException</code></a> if this schema is not a map.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the key schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="valueSchema()"> |
| <h3>valueSchema</h3> |
| <div class="member-signature"><span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">valueSchema</span>()</div> |
| <div class="block">Get the value schema for this map or array schema. Throws a <a href="../errors/DataException.html" title="class in org.apache.kafka.connect.errors"><code>DataException</code></a> if this schema is not a map or array.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the value schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fields()"> |
| <h3>fields</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Field.html" title="class in org.apache.kafka.connect.data">Field</a>></span> <span class="element-name">fields</span>()</div> |
| <div class="block">Get the list of Fields for this Schema. Throws a <a href="../errors/DataException.html" title="class in org.apache.kafka.connect.errors"><code>DataException</code></a> if this schema is not a |
| <a href="Schema.Type.html#STRUCT"><code>Schema.Type.STRUCT</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the list of fields for this Schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="field(java.lang.String)"> |
| <h3>field</h3> |
| <div class="member-signature"><span class="return-type"><a href="Field.html" title="class in org.apache.kafka.connect.data">Field</a></span> <span class="element-name">field</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fieldName)</span></div> |
| <div class="block">Get a <a href="Field.html" title="class in org.apache.kafka.connect.data"><code>Field</code></a> for this Schema by name. Throws a <a href="../errors/DataException.html" title="class in org.apache.kafka.connect.errors"><code>DataException</code></a> if this schema is not a |
| <a href="Schema.Type.html#STRUCT"><code>Schema.Type.STRUCT</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fieldName</code> - the name of the field to look up</dd> |
| <dt>Returns:</dt> |
| <dd>the Field object for the specified field, or null if there is no field with the given name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="schema()"> |
| <h3>schema</h3> |
| <div class="member-signature"><span class="return-type"><a href="Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></span> <span class="element-name">schema</span>()</div> |
| <div class="block">Return a concrete instance of the <a href="Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the <a href="Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
