| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Thu Aug 04 13:19:29 BST 2016 --> |
| <title>Schema (kafka 0.10.0.1 API)</title> |
| <meta name="date" content="2016-08-04"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Schema (kafka 0.10.0.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/kafka/connect/data/Schema.html" target="_top">Frames</a></li> |
| <li><a href="Schema.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.kafka.connect.data</div> |
| <h2 title="Interface Schema" class="title">Interface Schema</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.html" title="class in org.apache.kafka.connect.data">ConnectSchema</a>, <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Schema</span></pre> |
| <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="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data"><code>SchemaBuilder</code></a> will be simpler. |
| </p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a></strong></code> |
| <div class="block">The type of a schema.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#BOOLEAN_SCHEMA">BOOLEAN_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#BYTES_SCHEMA">BYTES_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#FLOAT32_SCHEMA">FLOAT32_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#FLOAT64_SCHEMA">FLOAT64_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#INT16_SCHEMA">INT16_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#INT32_SCHEMA">INT32_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#INT64_SCHEMA">INT64_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#INT8_SCHEMA">INT8_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_BOOLEAN_SCHEMA">OPTIONAL_BOOLEAN_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_BYTES_SCHEMA">OPTIONAL_BYTES_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_FLOAT32_SCHEMA">OPTIONAL_FLOAT32_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_FLOAT64_SCHEMA">OPTIONAL_FLOAT64_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_INT16_SCHEMA">OPTIONAL_INT16_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_INT32_SCHEMA">OPTIONAL_INT32_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_INT64_SCHEMA">OPTIONAL_INT64_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_INT8_SCHEMA">OPTIONAL_INT8_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_STRING_SCHEMA">OPTIONAL_STRING_SCHEMA</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#STRING_SCHEMA">STRING_SCHEMA</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#defaultValue()">defaultValue</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#doc()">doc</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data">Field</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#field(java.lang.String)">field</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</code> |
| <div class="block">Get a field for this Schema by name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data">Field</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#fields()">fields</a></strong>()</code> |
| <div class="block">Get the list of fields for this Schema.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#isOptional()">isOptional</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#keySchema()">keySchema</a></strong>()</code> |
| <div class="block">Get the key schema for this map schema.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#name()">name</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#parameters()">parameters</a></strong>()</code> |
| <div class="block">Get a map of schema parameters.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#schema()">schema</a></strong>()</code> |
| <div class="block">Return a concrete instance of the <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#type()">type</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#valueSchema()">valueSchema</a></strong>()</code> |
| <div class="block">Get the value schema for this map or array schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Schema.html#version()">version</a></strong>()</code> |
| <div class="block">Get the optional version of the schema.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="INT8_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INT8_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> INT8_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="INT16_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INT16_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> INT16_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="INT32_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INT32_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> INT32_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="INT64_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INT64_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> INT64_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="FLOAT32_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FLOAT32_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> FLOAT32_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="FLOAT64_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FLOAT64_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> FLOAT64_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="BOOLEAN_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BOOLEAN_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> BOOLEAN_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="STRING_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>STRING_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> STRING_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="BYTES_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BYTES_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> BYTES_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="OPTIONAL_INT8_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OPTIONAL_INT8_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> OPTIONAL_INT8_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="OPTIONAL_INT16_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OPTIONAL_INT16_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> OPTIONAL_INT16_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="OPTIONAL_INT32_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OPTIONAL_INT32_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> OPTIONAL_INT32_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="OPTIONAL_INT64_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OPTIONAL_INT64_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> OPTIONAL_INT64_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="OPTIONAL_FLOAT32_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OPTIONAL_FLOAT32_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> OPTIONAL_FLOAT32_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="OPTIONAL_FLOAT64_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OPTIONAL_FLOAT64_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> OPTIONAL_FLOAT64_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="OPTIONAL_BOOLEAN_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OPTIONAL_BOOLEAN_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> OPTIONAL_BOOLEAN_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="OPTIONAL_STRING_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OPTIONAL_STRING_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> OPTIONAL_STRING_SCHEMA</pre> |
| </li> |
| </ul> |
| <a name="OPTIONAL_BYTES_SCHEMA"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>OPTIONAL_BYTES_SCHEMA</h4> |
| <pre>static final <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> OPTIONAL_BYTES_SCHEMA</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="type()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre><a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a> type()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the type of this schema</dd></dl> |
| </li> |
| </ul> |
| <a name="isOptional()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOptional</h4> |
| <pre>boolean isOptional()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if this field is optional, false otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="defaultValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultValue</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> defaultValue()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the default value for this schema</dd></dl> |
| </li> |
| </ul> |
| <a name="name()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the name of this schema</dd></dl> |
| </li> |
| </ul> |
| <a name="version()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>version</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> version()</pre> |
| <div class="block">Get the optional version of the schema. If a version is included, newer versions *must* be larger than older ones.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the version of this schema</dd></dl> |
| </li> |
| </ul> |
| <a name="doc()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doc</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> doc()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the documentation for this schema</dd></dl> |
| </li> |
| </ul> |
| <a name="parameters()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameters</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> parameters()</pre> |
| <div class="block">Get a map of schema parameters.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Map containing parameters for this schema, or null if there are no parameters</dd></dl> |
| </li> |
| </ul> |
| <a name="keySchema()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>keySchema</h4> |
| <pre><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> keySchema()</pre> |
| <div class="block">Get the key schema for this map schema. Throws a DataException if this schema is not a map.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the key schema</dd></dl> |
| </li> |
| </ul> |
| <a name="valueSchema()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueSchema</h4> |
| <pre><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> valueSchema()</pre> |
| <div class="block">Get the value schema for this map or array schema. Throws a DataException if this schema is not a map or array.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the value schema</dd></dl> |
| </li> |
| </ul> |
| <a name="fields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fields</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data">Field</a>> fields()</pre> |
| <div class="block">Get the list of fields for this Schema. Throws a DataException if this schema is not a struct.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the list of fields for this Schema</dd></dl> |
| </li> |
| </ul> |
| <a name="field(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>field</h4> |
| <pre><a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data">Field</a> field(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</pre> |
| <div class="block">Get a field for this Schema by name. Throws a DataException if this schema is not a struct.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fieldName</code> - the name of the field to look up</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the Field object for the specified field, or null if there is no field with the given name</dd></dl> |
| </li> |
| </ul> |
| <a name="schema()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>schema</h4> |
| <pre><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> schema()</pre> |
| <div class="block">Return a concrete instance of the <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a></div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/kafka/connect/data/Schema.html" target="_top">Frames</a></li> |
| <li><a href="Schema.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
