| <!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>Struct (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="Struct (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/SchemaProjector.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/Time.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/Struct.html" target="_top">Frames</a></li> |
| <li><a href="Struct.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><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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 Struct" class="title">Class Struct</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.Struct</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">Struct</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></pre> |
| <div class="block"><p> |
| A structured record containing a set of named fields with values, each field using an independent <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a>. |
| Struct objects must specify a complete <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a> up front, and only fields specified in the Schema may be set. |
| </p> |
| <p> |
| The Struct's <a href="../../../../../org/apache/kafka/connect/data/Struct.html#put(java.lang.String,%20java.lang.Object)"><code>put(String, Object)</code></a> method returns the Struct itself to provide a fluent API for constructing |
| complete objects: |
| <pre> |
| Schema schema = SchemaBuilder.struct().name("com.example.Person") |
| .field("name", Schema.STRING_SCHEMA).field("age", Schema.INT32_SCHEMA).build() |
| Struct struct = new Struct(schema).put("name", "Bobby McGee").put("age", 21) |
| </pre> |
| </p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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"> </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/Struct.html#Struct(org.apache.kafka.connect.data.Schema)">Struct</a></strong>(<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> schema)</code> |
| <div class="block">Create a new Struct for this <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a></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"> </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>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.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> o)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/Struct.html#get(org.apache.kafka.connect.data.Field)">get</a></strong>(<a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data">Field</a> field)</code> |
| <div class="block">Get the value of a field, returning the default value if no value has been set yet and a default value is specified |
| in the field's schema.</div> |
| </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/Struct.html#get(java.lang.String)">get</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 the value of a field, returning the default value if no value has been set yet and a default value is specified |
| in the field's schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><T> <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><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#getArray(java.lang.String)">getArray</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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a List.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#getBoolean(java.lang.String)">getBoolean</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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Boolean.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#getBytes(java.lang.String)">getBytes</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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a byte[].</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#getFloat32(java.lang.String)">getFloat32</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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Float.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#getFloat64(java.lang.String)">getFloat64</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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Double.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Short.html?is-external=true" title="class or interface in java.lang">Short</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#getInt16(java.lang.String)">getInt16</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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Short.</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/Struct.html#getInt32(java.lang.String)">getInt32</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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Integer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#getInt64(java.lang.String)">getInt64</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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Long.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Byte.html?is-external=true" title="class or interface in java.lang">Byte</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#getInt8(java.lang.String)">getInt8</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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Byte.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><K,V> <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><K,V></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#getMap(java.lang.String)">getMap</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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Map.</div> |
| </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/Struct.html#getString(java.lang.String)">getString</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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a String.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/Struct.html" title="class in org.apache.kafka.connect.data">Struct</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#getStruct(java.lang.String)">getStruct</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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Struct.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/Struct.html#getWithoutDefault(java.lang.String)">getWithoutDefault</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 the underlying raw value for the field without accounting for default values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#hashCode()">hashCode</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/Struct.html" title="class in org.apache.kafka.connect.data">Struct</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#put(org.apache.kafka.connect.data.Field,%20java.lang.Object)">put</a></strong>(<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/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Set the value of a field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/connect/data/Struct.html" title="class in org.apache.kafka.connect.data">Struct</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#put(java.lang.String,%20java.lang.Object)">put</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="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 value of a field.</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/Struct.html#schema()">schema</a></strong>()</code> |
| <div class="block">Get the schema for this Struct.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/connect/data/Struct.html#validate()">validate</a></strong>()</code> |
| <div class="block">Validates that this struct has filled in all the necessary data with valid values.</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#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#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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Struct(org.apache.kafka.connect.data.Schema)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Struct</h4> |
| <pre>public Struct(<a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data">Schema</a> schema)</pre> |
| <div class="block">Create a new Struct for this <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>schema</code> - the <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a> for the Struct</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="schema()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <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">Get the schema for this Struct.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the Struct's schema</dd></dl> |
| </li> |
| </ul> |
| <a name="get(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</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> get(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</pre> |
| <div class="block">Get the value of a field, returning the default value if no value has been set yet and a default value is specified |
| in the field's schema. Because this handles fields of all types, the value is returned as an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><code>Object</code></a> and |
| must be cast to a more specific type.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fieldName</code> - the field name to lookup</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the value for the field</dd></dl> |
| </li> |
| </ul> |
| <a name="get(org.apache.kafka.connect.data.Field)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</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> get(<a href="../../../../../org/apache/kafka/connect/data/Field.html" title="class in org.apache.kafka.connect.data">Field</a> field)</pre> |
| <div class="block">Get the value of a field, returning the default value if no value has been set yet and a default value is specified |
| in the field's schema. Because this handles fields of all types, the value is returned as an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><code>Object</code></a> and |
| must be cast to a more specific type.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>field</code> - the field to lookup</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the value for the field</dd></dl> |
| </li> |
| </ul> |
| <a name="getWithoutDefault(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWithoutDefault</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> getWithoutDefault(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</pre> |
| <div class="block">Get the underlying raw value for the field without accounting for default values.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fieldName</code> - the field to get the value of</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the raw value</dd></dl> |
| </li> |
| </ul> |
| <a name="getInt8(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt8</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Byte.html?is-external=true" title="class or interface in java.lang">Byte</a> getInt8(<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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Byte.</div> |
| </li> |
| </ul> |
| <a name="getInt16(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt16</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Short.html?is-external=true" title="class or interface in java.lang">Short</a> getInt16(<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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Short.</div> |
| </li> |
| </ul> |
| <a name="getInt32(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt32</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> getInt32(<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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Integer.</div> |
| </li> |
| </ul> |
| <a name="getInt64(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt64</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> getInt64(<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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Long.</div> |
| </li> |
| </ul> |
| <a name="getFloat32(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFloat32</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang">Float</a> getFloat32(<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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Float.</div> |
| </li> |
| </ul> |
| <a name="getFloat64(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFloat64</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a> getFloat64(<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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Double.</div> |
| </li> |
| </ul> |
| <a name="getBoolean(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBoolean</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> getBoolean(<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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Boolean.</div> |
| </li> |
| </ul> |
| <a name="getString(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getString</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> getString(<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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a String.</div> |
| </li> |
| </ul> |
| <a name="getBytes(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBytes</h4> |
| <pre>public byte[] getBytes(<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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a byte[].</div> |
| </li> |
| </ul> |
| <a name="getArray(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArray</h4> |
| <pre>public <T> <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><T> getArray(<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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a List.</div> |
| </li> |
| </ul> |
| <a name="getMap(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMap</h4> |
| <pre>public <K,V> <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><K,V> getMap(<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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Map.</div> |
| </li> |
| </ul> |
| <a name="getStruct(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStruct</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/Struct.html" title="class in org.apache.kafka.connect.data">Struct</a> getStruct(<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">Equivalent to calling <a href="../../../../../org/apache/kafka/connect/data/Struct.html#get(java.lang.String)"><code>get(String)</code></a> and casting the result to a Struct.</div> |
| </li> |
| </ul> |
| <a name="put(java.lang.String, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/Struct.html" title="class in org.apache.kafka.connect.data">Struct</a> put(<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="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 value of a field. Validates the value, throwing a <a href="../../../../../org/apache/kafka/connect/errors/DataException.html" title="class in org.apache.kafka.connect.errors"><code>DataException</code></a> if it does not match the field's |
| <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fieldName</code> - the name of the field to set</dd><dd><code>value</code> - the value of the field</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the Struct, to allow chaining of <a href="../../../../../org/apache/kafka/connect/data/Struct.html#put(java.lang.String,%20java.lang.Object)"><code>put(String, Object)</code></a> calls</dd></dl> |
| </li> |
| </ul> |
| <a name="put(org.apache.kafka.connect.data.Field, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>public <a href="../../../../../org/apache/kafka/connect/data/Struct.html" title="class in org.apache.kafka.connect.data">Struct</a> put(<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/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">Set the value of a field. Validates the value, throwing a <a href="../../../../../org/apache/kafka/connect/errors/DataException.html" title="class in org.apache.kafka.connect.errors"><code>DataException</code></a> if it does not match the field's |
| <a href="../../../../../org/apache/kafka/connect/data/Schema.html" title="interface in org.apache.kafka.connect.data"><code>Schema</code></a>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>field</code> - the field to set</dd><dd><code>value</code> - the value of the field</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the Struct, to allow chaining of <a href="../../../../../org/apache/kafka/connect/data/Struct.html#put(java.lang.String,%20java.lang.Object)"><code>put(String, Object)</code></a> calls</dd></dl> |
| </li> |
| </ul> |
| <a name="validate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>public void validate()</pre> |
| <div class="block">Validates that this struct has filled in all the necessary data with valid values. For required fields |
| without defaults, this validates that a value has been set and has matching types/schemas. If any validation |
| fails, throws a DataException.</div> |
| </li> |
| </ul> |
| <a name="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean 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> 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> in class <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="blockListLast"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int 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> in class <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> |
| </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/SchemaProjector.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/Time.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/Struct.html" target="_top">Frames</a></li> |
| <li><a href="Struct.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><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |