| <!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>SchemaBuilder (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="SchemaBuilder (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/SchemaAndValue.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/SchemaProjector.html" title="class 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/SchemaBuilder.html" target="_top">Frames</a></li> |
| <li><a href="SchemaBuilder.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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="Class SchemaBuilder" class="title">Class SchemaBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.kafka.connect.data.SchemaBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">SchemaBuilder</span> |
| extends <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> |
| implements <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></pre> |
| <div class="block"><p> |
| SchemaBuilder provides a fluent API for constructing <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a> objects. It allows you to set each of the |
| properties for the schema and each call returns the SchemaBuilder so the calls can be chained. When nested types |
| are required, use one of the predefined schemas from <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a> or use a second SchemaBuilder inline. |
| </p> |
| <p> |
| Here is an example of building a struct schema: |
| <pre> |
| Schema dateSchema = SchemaBuilder.struct() |
| .name("com.example.CalendarDate").version(2).doc("A calendar date including month, day, and year.") |
| .field("month", Schema.STRING_SCHEMA) |
| .field("day", Schema.INT8_SCHEMA) |
| .field("year", Schema.INT16_SCHEMA) |
| .build(); |
| </pre> |
| </p> |
| <p> |
| Here is an example of using a second SchemaBuilder to construct complex, nested types: |
| <pre> |
| Schema userListSchema = SchemaBuilder.array( |
| SchemaBuilder.struct().name("com.example.User").field("username", Schema.STRING_SCHEMA).field("id", Schema.INT64_SCHEMA).build() |
| ).build(); |
| </pre> |
| </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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.kafka.connect.data.Schema"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.kafka.connect.data.<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></h3> |
| <code><a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.kafka.connect.data.Schema"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.kafka.connect.data.<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></h3> |
| <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#BOOLEAN_SCHEMA">BOOLEAN_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#BYTES_SCHEMA">BYTES_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#FLOAT32_SCHEMA">FLOAT32_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#FLOAT64_SCHEMA">FLOAT64_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#INT16_SCHEMA">INT16_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#INT32_SCHEMA">INT32_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#INT64_SCHEMA">INT64_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#INT8_SCHEMA">INT8_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_BOOLEAN_SCHEMA">OPTIONAL_BOOLEAN_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_BYTES_SCHEMA">OPTIONAL_BYTES_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_FLOAT32_SCHEMA">OPTIONAL_FLOAT32_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_FLOAT64_SCHEMA">OPTIONAL_FLOAT64_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_INT16_SCHEMA">OPTIONAL_INT16_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_INT32_SCHEMA">OPTIONAL_INT32_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_INT64_SCHEMA">OPTIONAL_INT64_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_INT8_SCHEMA">OPTIONAL_INT8_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#OPTIONAL_STRING_SCHEMA">OPTIONAL_STRING_SCHEMA</a>, <a href="../../../../../org/apache/kafka/connect/data/Schema.html#STRING_SCHEMA">STRING_SCHEMA</a></code></li> |
| </ul> |
| </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>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#array(org.apache.kafka.connect.data.Schema)">array</a></strong>(<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> valueSchema)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#bool()">bool</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/SchemaBuilder.html#build()">build</a></strong>()</code> |
| <div class="block">Build the Schema using the current settings</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#bytes()">bytes</a></strong>()</code> </td> |
| </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/SchemaBuilder.html#defaultValue()">defaultValue</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#defaultValue(java.lang.Object)">defaultValue</a></strong>(<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> value)</code> |
| <div class="block">Set the default value for this 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/SchemaBuilder.html#doc()">doc</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#doc(java.lang.String)">doc</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> doc)</code> |
| <div class="block">Set the documentation for this schema.</div> |
| </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/SchemaBuilder.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="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#field(java.lang.String,%20org.apache.kafka.connect.data.Schema)">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, |
| <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> fieldSchema)</code> |
| <div class="block">Add a field to this struct schema.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/SchemaBuilder.html#fields()">fields</a></strong>()</code> |
| <div class="block">Get the list of fields for this Schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#float32()">float32</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#float64()">float64</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#int16()">int16</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#int32()">int32</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#int64()">int64</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#int8()">int8</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#isOptional()">isOptional</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/SchemaBuilder.html#keySchema()">keySchema</a></strong>()</code> |
| <div class="block">Get the key schema for this map schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#map(org.apache.kafka.connect.data.Schema,%20org.apache.kafka.connect.data.Schema)">map</a></strong>(<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> keySchema, |
| <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> valueSchema)</code> </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/SchemaBuilder.html#name()">name</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#name(java.lang.String)">name</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> name)</code> |
| <div class="block">Set the name of this schema.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#optional()">optional</a></strong>()</code> |
| <div class="block">Set this schema as optional.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#parameter(java.lang.String,%20java.lang.String)">parameter</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> propertyName, |
| <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> propertyValue)</code> |
| <div class="block">Set a schema parameter.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/SchemaBuilder.html#parameters()">parameters</a></strong>()</code> |
| <div class="block">Get a map of schema parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#parameters(java.util.Map)">parameters</a></strong>(<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>> props)</code> |
| <div class="block">Set schema parameters.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#required()">required</a></strong>()</code> |
| <div class="block">Set this schema as required.</div> |
| </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/SchemaBuilder.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> specified by this builder</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#string()">string</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#struct()">struct</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <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/SchemaBuilder.html#type()">type</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#type(org.apache.kafka.connect.data.Schema.Type)">type</a></strong>(<a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a> type)</code> |
| <div class="block">Create a SchemaBuilder for the specified type.</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/SchemaBuilder.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/SchemaBuilder.html#version()">version</a></strong>()</code> |
| <div class="block">Get the optional version of the schema.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#version(java.lang.Integer)">version</a></strong>(<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)</code> |
| <div class="block">Set the version of this schema.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isOptional()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOptional</h4> |
| <pre>public boolean isOptional()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#isOptional()">isOptional</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if this field is optional, false otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="optional()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>optional</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> optional()</pre> |
| <div class="block">Set this schema as optional.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="required()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>required</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> required()</pre> |
| <div class="block">Set this schema as required. This is the default, but this method can be used to make this choice explicit.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="defaultValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultValue</h4> |
| <pre>public <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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#defaultValue()">defaultValue</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the default value for this schema</dd></dl> |
| </li> |
| </ul> |
| <a name="defaultValue(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultValue</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> defaultValue(<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> value)</pre> |
| <div class="block">Set the default value for this schema. The value is validated against the schema type, throwing a |
| <a href="../../../../../org/apache/kafka/connect/errors/SchemaBuilderException.html" title="class in org.apache.kafka.connect.errors"><code>SchemaBuilderException</code></a> if it does not match.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the default value</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="name()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>public <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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#name()">name</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the name of this schema</dd></dl> |
| </li> |
| </ul> |
| <a name="name(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> name(<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> |
| <div class="block">Set the name of this schema.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the schema name</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="version()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>version</h4> |
| <pre>public <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"><strong>Description copied from interface: <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#version()">Schema</a></code></strong></div> |
| <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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#version()">version</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the version of this schema</dd></dl> |
| </li> |
| </ul> |
| <a name="version(java.lang.Integer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>version</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> version(<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">Set the version of this schema. Schema versions are integers which, if provided, must indicate which schema is |
| newer and which is older by their ordering.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>version</code> - the schema version</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="doc()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doc</h4> |
| <pre>public <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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#doc()">doc</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the documentation for this schema</dd></dl> |
| </li> |
| </ul> |
| <a name="doc(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doc</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> doc(<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> |
| <div class="block">Set the documentation for this schema.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>doc</code> - the documentation</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="parameters()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameters</h4> |
| <pre>public <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"><strong>Description copied from interface: <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#parameters()">Schema</a></code></strong></div> |
| <div class="block">Get a map of schema parameters.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#parameters()">parameters</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></dd> |
| <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="parameter(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameter</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> parameter(<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> propertyName, |
| <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> propertyValue)</pre> |
| <div class="block">Set a schema parameter.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of the schema property to define</dd><dd><code>propertyValue</code> - value of the schema property to define, as a String</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="parameters(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameters</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> parameters(<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>> props)</pre> |
| <div class="block">Set schema parameters. This operation is additive; it does not remove existing parameters that do not appear in |
| the set of properties pass to this method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>props</code> - Map of properties to set</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="type()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre>public <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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#type()">type</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the type of this schema</dd></dl> |
| </li> |
| </ul> |
| <a name="type(org.apache.kafka.connect.data.Schema.Type)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> type(<a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a> type)</pre> |
| <div class="block">Create a SchemaBuilder for the specified type. |
| |
| Usually it will be simpler to use one of the variants like <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#string()"><code>string()</code></a> or <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html#struct()"><code>struct()</code></a>, but this form |
| can be useful when generating schemas dynamically.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the schema type</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="int8()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>int8</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> int8()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html#INT8"><code>Schema.Type.INT8</code></a> SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="int16()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>int16</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> int16()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html#INT16"><code>Schema.Type.INT16</code></a> SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="int32()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>int32</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> int32()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html#INT32"><code>Schema.Type.INT32</code></a> SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="int64()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>int64</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> int64()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html#INT64"><code>Schema.Type.INT64</code></a> SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="float32()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>float32</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> float32()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html#FLOAT32"><code>Schema.Type.FLOAT32</code></a> SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="float64()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>float64</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> float64()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html#FLOAT64"><code>Schema.Type.FLOAT64</code></a> SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="bool()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bool</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> bool()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html#BOOLEAN"><code>Schema.Type.BOOLEAN</code></a> SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="string()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>string</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> string()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html#STRING"><code>Schema.Type.STRING</code></a> SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="bytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bytes</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> bytes()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html#BYTES"><code>Schema.Type.BYTES</code></a> SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="struct()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>struct</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> struct()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html#STRUCT"><code>Schema.Type.STRUCT</code></a> SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="field(java.lang.String, org.apache.kafka.connect.data.Schema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>field</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</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, |
| <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> fieldSchema)</pre> |
| <div class="block">Add a field to this struct schema. Throws a SchemaBuilderException if this is not a struct schema.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fieldName</code> - the name of the field to add</dd><dd><code>fieldSchema</code> - the Schema for the field's value</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="fields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fields</h4> |
| <pre>public <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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#fields()">fields</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></dd> |
| <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>public <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"><strong>Description copied from interface: <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#field(java.lang.String)">Schema</a></code></strong></div> |
| <div class="block">Get a field for this Schema by name. Throws a DataException if this schema is not a struct.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#field(java.lang.String)">field</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></dd> |
| <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="array(org.apache.kafka.connect.data.Schema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>array</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> array(<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> valueSchema)</pre> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>valueSchema</code> - the schema for elements of the array</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html#ARRAY"><code>Schema.Type.ARRAY</code></a> SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="map(org.apache.kafka.connect.data.Schema, org.apache.kafka.connect.data.Schema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>map</h4> |
| <pre>public static <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data">SchemaBuilder</a> map(<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> keySchema, |
| <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> valueSchema)</pre> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keySchema</code> - the schema for keys in the map</dd><dd><code>valueSchema</code> - the schema for values in the map</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html#MAP"><code>Schema.Type.MAP</code></a> SchemaBuilder</dd></dl> |
| </li> |
| </ul> |
| <a name="keySchema()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>keySchema</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> keySchema()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#keySchema()">Schema</a></code></strong></div> |
| <div class="block">Get the key schema for this map schema. Throws a DataException if this schema is not a map.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#keySchema()">keySchema</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></dd> |
| <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>public <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> valueSchema()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#valueSchema()">Schema</a></code></strong></div> |
| <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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#valueSchema()">valueSchema</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the value schema</dd></dl> |
| </li> |
| </ul> |
| <a name="build()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> build()</pre> |
| <div class="block">Build the Schema using the current settings</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> |
| <a name="schema()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>schema</h4> |
| <pre>public <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> specified by this builder</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#schema()">schema</a></code> in interface <code><a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a></code></dd> |
| <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/SchemaAndValue.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/SchemaProjector.html" title="class 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/SchemaBuilder.html" target="_top">Frames</a></li> |
| <li><a href="SchemaBuilder.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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> |
