| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>SchemaDefinition (Pulsar Client :: API 4.1.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.pulsar.client.api.schema, interface: SchemaDefinition"> |
| <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="class-use/SchemaDefinition.html">Use</a></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>Nested</li> |
| <li>Field</li> |
| <li>Constr</li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li>Constr</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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><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.pulsar.client.api.schema</a></div> |
| <h1 title="Interface SchemaDefinition" class="title">Interface SchemaDefinition<T></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="../../../common/classification/InterfaceAudience.Public.html" title="annotation interface in org.apache.pulsar.common.classification">@Public</a> |
| <a href="../../../common/classification/InterfaceStability.Stable.html" title="annotation interface in org.apache.pulsar.common.classification">@Stable</a> |
| </span><span class="modifiers">public interface </span><span class="element-name type-name-label">SchemaDefinition<T></span></div> |
| <div class="block">Interface for schema definition.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-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" 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-tab1"><code>static <T> <a href="SchemaDefinitionBuilder.html" title="interface in org.apache.pulsar.client.api.schema">SchemaDefinitionBuilder</a><wbr><T></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#builder()" class="member-name-link">builder</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Get a new builder instance that can used to configure and build a <a href="SchemaDefinition.html" title="interface in org.apache.pulsar.client.api.schema"><code>SchemaDefinition</code></a> instance.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAlwaysAllowNull()" class="member-name-link">getAlwaysAllowNull</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 schema whether always allow null or not.</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/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getClassLoader()" class="member-name-link">getClassLoader</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 pojo classLoader.</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/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="#getJsonDef()" class="member-name-link">getJsonDef</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 json schema definition.</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/Class.html" title="class or interface in java.lang" class="external-link">Class</a><wbr><<a href="SchemaDefinition.html" title="type parameter in SchemaDefinition">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPojo()" class="member-name-link">getPojo</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 pojo schema definition.</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/Map.html" title="class or interface in java.util" class="external-link">Map</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>,<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="#getProperties()" class="member-name-link">getProperties</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 schema class.</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/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr><<a href="SchemaReader.html" title="interface in org.apache.pulsar.client.api.schema">SchemaReader</a><<a href="SchemaDefinition.html" title="type parameter in SchemaDefinition">T</a>>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSchemaReaderOpt()" class="member-name-link">getSchemaReaderOpt</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 a configured schema reader.</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/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr><<a href="SchemaWriter.html" title="interface in org.apache.pulsar.client.api.schema">SchemaWriter</a><<a href="SchemaDefinition.html" title="type parameter in SchemaDefinition">T</a>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSchemaWriterOpt()" class="member-name-link">getSchemaWriterOpt</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 configured schema writer.</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="#getSupportSchemaVersioning()" class="member-name-link">getSupportSchemaVersioning</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 supportSchemaVersioning schema definition.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isJsr310ConversionEnabled()" class="member-name-link">isJsr310ConversionEnabled</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 JSR310 conversion enabled.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="builder()"> |
| <h3>builder</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="SchemaDefinitionBuilder.html" title="interface in org.apache.pulsar.client.api.schema">SchemaDefinitionBuilder</a><T></span> <span class="element-name">builder</span>()</div> |
| <div class="block">Get a new builder instance that can used to configure and build a <a href="SchemaDefinition.html" title="interface in org.apache.pulsar.client.api.schema"><code>SchemaDefinition</code></a> instance.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the <a href="SchemaDefinition.html" title="interface in org.apache.pulsar.client.api.schema"><code>SchemaDefinition</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAlwaysAllowNull()"> |
| <h3>getAlwaysAllowNull</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">getAlwaysAllowNull</span>()</div> |
| <div class="block">Get schema whether always allow null or not.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>schema always null or not</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isJsr310ConversionEnabled()"> |
| <h3>isJsr310ConversionEnabled</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isJsr310ConversionEnabled</span>()</div> |
| <div class="block">Get JSR310 conversion enabled.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>return true if enable JSR310 conversion. false means use Joda time conversion.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProperties()"> |
| <h3>getProperties</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">getProperties</span>()</div> |
| <div class="block">Get schema class.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>schema class</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJsonDef()"> |
| <h3>getJsonDef</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">getJsonDef</span>()</div> |
| <div class="block">Get json schema definition.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>schema class</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPojo()"> |
| <h3>getPojo</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/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="SchemaDefinition.html" title="type parameter in SchemaDefinition">T</a>></span> <span class="element-name">getPojo</span>()</div> |
| <div class="block">Get pojo schema definition.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>pojo schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getClassLoader()"> |
| <h3>getClassLoader</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/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a></span> <span class="element-name">getClassLoader</span>()</div> |
| <div class="block">Get pojo classLoader.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>pojo schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSupportSchemaVersioning()"> |
| <h3>getSupportSchemaVersioning</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">getSupportSchemaVersioning</span>()</div> |
| <div class="block">Get supportSchemaVersioning schema definition.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the flag of supportSchemaVersioning</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSchemaReaderOpt()"> |
| <h3>getSchemaReaderOpt</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/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="SchemaReader.html" title="interface in org.apache.pulsar.client.api.schema">SchemaReader</a><<a href="SchemaDefinition.html" title="type parameter in SchemaDefinition">T</a>>></span> <span class="element-name">getSchemaReaderOpt</span>()</div> |
| <div class="block">Get a configured schema reader.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>optional containing configured schema reader or empty optional if none is configure</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSchemaWriterOpt()"> |
| <h3>getSchemaWriterOpt</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/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="SchemaWriter.html" title="interface in org.apache.pulsar.client.api.schema">SchemaWriter</a><<a href="SchemaDefinition.html" title="type parameter in SchemaDefinition">T</a>>></span> <span class="element-name">getSchemaWriterOpt</span>()</div> |
| <div class="block">Get a configured schema writer.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>optional containing configured schema writer or empty optional if none is configure</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2017–2025 <a href="https://www.apache.org/">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
