blob: 92768160760c3a41c992932c017fdc7aaf363a7b [file] [log] [blame]
<!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>ConnectSchema (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="ConnectSchema (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>Prev Class</li>
<li><a href="../../../../../org/apache/kafka/connect/data/Date.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/ConnectSchema.html" target="_top">Frames</a></li>
<li><a href="ConnectSchema.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 ConnectSchema" class="title">Class ConnectSchema</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.ConnectSchema</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">ConnectSchema</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>
</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&nbsp;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&nbsp;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>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.html#ConnectSchema(org.apache.kafka.connect.data.Schema.Type)">ConnectSchema</a></strong>(<a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a>&nbsp;type)</code>
<div class="block">Construct a default schema for a primitive type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.html#ConnectSchema(org.apache.kafka.connect.data.Schema.Type,%20boolean,%20java.lang.Object,%20java.lang.String,%20java.lang.Integer,%20java.lang.String)">ConnectSchema</a></strong>(<a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a>&nbsp;type,
boolean&nbsp;optional,
<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>&nbsp;defaultValue,
<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>&nbsp;name,
<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>&nbsp;version,
<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>&nbsp;doc)</code>
<div class="block">Construct a Schema for a primitive type, setting schema parameters, struct fields, and key and value schemas to null.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.html#ConnectSchema(org.apache.kafka.connect.data.Schema.Type,%20boolean,%20java.lang.Object,%20java.lang.String,%20java.lang.Integer,%20java.lang.String,%20java.util.Map,%20java.util.List,%20org.apache.kafka.connect.data.Schema,%20org.apache.kafka.connect.data.Schema)">ConnectSchema</a></strong>(<a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a>&nbsp;type,
boolean&nbsp;optional,
<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>&nbsp;defaultValue,
<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>&nbsp;name,
<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>&nbsp;version,
<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>&nbsp;doc,
<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>&lt;<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>&gt;&nbsp;parameters,
<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>&lt;<a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data">Field</a>&gt;&nbsp;fields,
<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a>&nbsp;keySchema,
<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a>&nbsp;valueSchema)</code>
<div class="block">Construct a Schema.</div>
</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">&nbsp;</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/ConnectSchema.html#defaultValue()">defaultValue</a></strong>()</code>&nbsp;</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/ConnectSchema.html#doc()">doc</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.html#equals(java.lang.Object)">equals</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>&nbsp;o)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<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/ConnectSchema.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>&nbsp;fieldName)</code>
<div class="block">Get a field for this Schema by name.</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>&lt;<a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data">Field</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.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>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.html#hashCode()">hashCode</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.html#isOptional()">isOptional</a></strong>()</code>&nbsp;</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/ConnectSchema.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/ConnectSchema.html#name()">name</a></strong>()</code>&nbsp;</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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.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/ConnectSchema.html" title="class in org.apache.kafka.connect.data">ConnectSchema</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.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>static <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/ConnectSchema.html#schemaType(java.lang.Class)">schemaType</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;klass)</code>
<div class="block">Get the <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data"><code>Schema.Type</code></a> associated with the given class.</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/ConnectSchema.html#toString()">toString</a></strong>()</code>&nbsp;</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/ConnectSchema.html#type()">type</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.html#validateValue(java.lang.Object)">validateValue</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>&nbsp;value)</code>
<div class="block">Validate that the value can be used for this schema, i.e.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.html#validateValue(org.apache.kafka.connect.data.Schema,%20java.lang.Object)">validateValue</a></strong>(<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a>&nbsp;schema,
<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>&nbsp;value)</code>
<div class="block">Validate that the value can be used with the schema, i.e.</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/ConnectSchema.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/ConnectSchema.html#version()">version</a></strong>()</code>
<div class="block">Get the optional version of the 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&nbsp;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#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#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#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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ConnectSchema(org.apache.kafka.connect.data.Schema.Type, boolean, java.lang.Object, java.lang.String, java.lang.Integer, java.lang.String, java.util.Map, java.util.List, org.apache.kafka.connect.data.Schema, org.apache.kafka.connect.data.Schema)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ConnectSchema</h4>
<pre>public&nbsp;ConnectSchema(<a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a>&nbsp;type,
boolean&nbsp;optional,
<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>&nbsp;defaultValue,
<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>&nbsp;name,
<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>&nbsp;version,
<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>&nbsp;doc,
<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>&lt;<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>&gt;&nbsp;parameters,
<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>&lt;<a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data">Field</a>&gt;&nbsp;fields,
<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a>&nbsp;keySchema,
<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a>&nbsp;valueSchema)</pre>
<div class="block">Construct a Schema. Most users should not construct schemas manually, preferring <a href="../../../../../org/apache/kafka/connect/data/SchemaBuilder.html" title="class in org.apache.kafka.connect.data"><code>SchemaBuilder</code></a> instead.</div>
</li>
</ul>
<a name="ConnectSchema(org.apache.kafka.connect.data.Schema.Type, boolean, java.lang.Object, java.lang.String, java.lang.Integer, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ConnectSchema</h4>
<pre>public&nbsp;ConnectSchema(<a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a>&nbsp;type,
boolean&nbsp;optional,
<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>&nbsp;defaultValue,
<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>&nbsp;name,
<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>&nbsp;version,
<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>&nbsp;doc)</pre>
<div class="block">Construct a Schema for a primitive type, setting schema parameters, struct fields, and key and value schemas to null.</div>
</li>
</ul>
<a name="ConnectSchema(org.apache.kafka.connect.data.Schema.Type)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConnectSchema</h4>
<pre>public&nbsp;ConnectSchema(<a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a>&nbsp;type)</pre>
<div class="block">Construct a default schema for a primitive type. The schema is required, has no default value, name, version,
or documentation.</div>
</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>public&nbsp;<a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a>&nbsp;type()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#type()">type</a></code>&nbsp;in interface&nbsp;<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="isOptional()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOptional</h4>
<pre>public&nbsp;boolean&nbsp;isOptional()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#isOptional()">isOptional</a></code>&nbsp;in interface&nbsp;<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="defaultValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultValue</h4>
<pre>public&nbsp;<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>&nbsp;defaultValue()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#defaultValue()">defaultValue</a></code>&nbsp;in interface&nbsp;<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="name()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public&nbsp;<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>&nbsp;name()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#name()">name</a></code>&nbsp;in interface&nbsp;<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="version()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>version</h4>
<pre>public&nbsp;<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>&nbsp;version()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="doc()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doc</h4>
<pre>public&nbsp;<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>&nbsp;doc()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#doc()">doc</a></code>&nbsp;in interface&nbsp;<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="parameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameters</h4>
<pre>public&nbsp;<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>&lt;<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>&gt;&nbsp;parameters()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="fields()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fields</h4>
<pre>public&nbsp;<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>&lt;<a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data">Field</a>&gt;&nbsp;fields()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#fields()">Schema</a></code></strong></div>
<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>&nbsp;in interface&nbsp;<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&nbsp;<a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data">Field</a>&nbsp;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>&nbsp;fieldName)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="keySchema()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keySchema</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a>&nbsp;keySchema()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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&nbsp;<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a>&nbsp;valueSchema()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<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>&nbsp;in interface&nbsp;<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="validateValue(org.apache.kafka.connect.data.Schema, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateValue</h4>
<pre>public static&nbsp;void&nbsp;validateValue(<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a>&nbsp;schema,
<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>&nbsp;value)</pre>
<div class="block">Validate that the value can be used with the schema, i.e. that its type matches the schema type and nullability
requirements. Throws a DataException if the value is invalid.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>schema</code> - Schema to test</dd><dd><code>value</code> - value to test</dd></dl>
</li>
</ul>
<a name="validateValue(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateValue</h4>
<pre>public&nbsp;void&nbsp;validateValue(<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>&nbsp;value)</pre>
<div class="block">Validate that the value can be used for this schema, i.e. that its type matches the schema type and optional
requirements. Throws a DataException if the value is invalid.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the value to validate</dd></dl>
</li>
</ul>
<a name="schema()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>schema</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/kafka/connect/data/ConnectSchema.html" title="class in org.apache.kafka.connect.data">ConnectSchema</a>&nbsp;schema()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#schema()">Schema</a></code></strong></div>
<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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/kafka/connect/data/Schema.html#schema()">schema</a></code>&nbsp;in interface&nbsp;<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>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<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>&nbsp;o)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<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></dd>
</dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<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></dd>
</dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<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>&nbsp;toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<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></dd>
</dl>
</li>
</ul>
<a name="schemaType(java.lang.Class)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>schemaType</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data">Schema.Type</a>&nbsp;schemaType(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;klass)</pre>
<div class="block">Get the <a href="../../../../../org/apache/kafka/connect/data/Schema.Type.html" title="enum in org.apache.kafka.connect.data"><code>Schema.Type</code></a> associated with the given class.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>klass</code> - the Class to</dd>
<dt><span class="strong">Returns:</span></dt><dd>the corresponding type, nor null if there is no matching type</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>Prev Class</li>
<li><a href="../../../../../org/apache/kafka/connect/data/Date.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/ConnectSchema.html" target="_top">Frames</a></li>
<li><a href="ConnectSchema.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>