| <!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 (1.8.0_181-google-v7) on Wed Aug 14 17:37:14 PDT 2019 --> |
| <title>Schema (Apache Beam 2.15.0-SNAPSHOT)</title> |
| <meta name="date" content="2019-08-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Schema (Apache Beam 2.15.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":9,"i17":10,"i18":10,"i19":9,"i20":10,"i21":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/schemas/Schema.Builder.html" title="class in org.apache.beam.sdk.schemas"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/schemas/Schema.html" target="_top">Frames</a></li> |
| <li><a href="Schema.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>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.beam.sdk.schemas</div> |
| <h2 title="Class Schema" class="title">Class Schema</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.schemas.Schema</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SCHEMAS">SCHEMAS</a>) |
| public class <span class="typeNameLabel">Schema</span> |
| extends java.lang.Object |
| implements java.io.Serializable</pre> |
| <div class="block"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> describes the fields in <a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.beam.sdk.schemas.Schema">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.Builder.html" title="class in org.apache.beam.sdk.schemas">Schema.Builder</a></span></code> |
| <div class="block">Builder class for building <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.EquivalenceNullablePolicy.html" title="enum in org.apache.beam.sdk.schemas">Schema.EquivalenceNullablePolicy</a></span></code> |
| <div class="block">Control whether nullable is included in equivalence check.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a></span></code> |
| <div class="block">Field of a row.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a></span></code> |
| <div class="block">A descriptor of a single field type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.LogicalType.html" title="interface in org.apache.beam.sdk.schemas">Schema.LogicalType</a><<a href="../../../../../org/apache/beam/sdk/schemas/Schema.LogicalType.html" title="type parameter in Schema.LogicalType">InputT</a>,<a href="../../../../../org/apache/beam/sdk/schemas/Schema.LogicalType.html" title="type parameter in Schema.LogicalType">BaseT</a>></span></code> |
| <div class="block">A LogicalType allows users to define a custom schema type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.TypeName.html" title="enum in org.apache.beam.sdk.schemas">Schema.TypeName</a></span></code> |
| <div class="block">An enumerated list of type constructors.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#Schema-java.util.List-">Schema</a></span>(java.util.List<<a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a>> fields)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#assignableTo-org.apache.beam.sdk.schemas.Schema-">assignableTo</a></span>(<a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> other)</code> |
| <div class="block">Returns true if this Schema can be assigned to another Schema.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#assignableToIgnoreNullable-org.apache.beam.sdk.schemas.Schema-">assignableToIgnoreNullable</a></span>(<a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> other)</code> |
| <div class="block">Returns true if this Schema can be assigned to another Schema, ignoring nullable.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/schemas/Schema.Builder.html" title="class in org.apache.beam.sdk.schemas">Schema.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#builder--">builder</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code> |
| <div class="block">Returns true if two Schemas have the same fields in the same order.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#equivalent-org.apache.beam.sdk.schemas.Schema-">equivalent</a></span>(<a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> other)</code> |
| <div class="block">Returns true if two Schemas have the same fields, but possibly in different orders.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Integer></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#getEncodingPositions--">getEncodingPositions</a></span>()</code> |
| <div class="block">Gets the encoding positions for this schema.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#getField-int-">getField</a></span>(int index)</code> |
| <div class="block">Return a field by index.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#getField-java.lang.String-">getField</a></span>(java.lang.String name)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#getFieldCount--">getFieldCount</a></span>()</code> |
| <div class="block">Return the count of fields.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#getFieldNames--">getFieldNames</a></span>()</code> |
| <div class="block">Return the list of all field names.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#getFields--">getFields</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.util.UUID</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#getUUID--">getUUID</a></span>()</code> |
| <div class="block">Get this schema's UUID.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#hasField-java.lang.String-">hasField</a></span>(java.lang.String fieldName)</code> |
| <div class="block">Returns true if <code>fieldName</code> exists in the schema, false otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#hashCode--">hashCode</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#indexOf-java.lang.String-">indexOf</a></span>(java.lang.String fieldName)</code> |
| <div class="block">Find the index of a given field.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#nameOf-int-">nameOf</a></span>(int fieldIndex)</code> |
| <div class="block">Return the name of field by index.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#of-org.apache.beam.sdk.schemas.Schema.Field...-">of</a></span>(<a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a>... fields)</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#setEncodingPositions-java.util.Map-">setEncodingPositions</a></span>(java.util.Map<java.lang.String,java.lang.Integer> encodingPositions)</code> |
| <div class="block">Sets the encoding positions for this schema.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#setUUID-java.util.UUID-">setUUID</a></span>(java.util.UUID uuid)</code> |
| <div class="block">Set this schema's UUID.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>static java.util.stream.Collector<<a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a>,java.util.List<<a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a>>,<a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#toSchema--">toSchema</a></span>()</code> |
| <div class="block">Collects a stream of <a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas"><code>Schema.Field</code></a>s into a <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html#typesEqual-org.apache.beam.sdk.schemas.Schema-">typesEqual</a></span>(<a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> other)</code> |
| <div class="block">Returns true if two schemas are equal ignoring field names and descriptions.</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.Object</h3> |
| <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</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="Schema-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Schema</h4> |
| <pre>public Schema(java.util.List<<a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a>> fields)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="builder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>builder</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/schemas/Schema.Builder.html" title="class in org.apache.beam.sdk.schemas">Schema.Builder</a> builder()</pre> |
| </li> |
| </ul> |
| <a name="of-org.apache.beam.sdk.schemas.Schema.Field...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> of(<a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a>... fields)</pre> |
| </li> |
| </ul> |
| <a name="setUUID-java.util.UUID-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUUID</h4> |
| <pre>public void setUUID(java.util.UUID uuid)</pre> |
| <div class="block">Set this schema's UUID. All schemas with the same UUID must be guaranteed to be identical.</div> |
| </li> |
| </ul> |
| <a name="getEncodingPositions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncodingPositions</h4> |
| <pre>public java.util.Map<java.lang.String,java.lang.Integer> getEncodingPositions()</pre> |
| <div class="block">Gets the encoding positions for this schema.</div> |
| </li> |
| </ul> |
| <a name="setEncodingPositions-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEncodingPositions</h4> |
| <pre>public void setEncodingPositions(java.util.Map<java.lang.String,java.lang.Integer> encodingPositions)</pre> |
| <div class="block">Sets the encoding positions for this schema.</div> |
| </li> |
| </ul> |
| <a name="getUUID--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUUID</h4> |
| <pre>@Nullable |
| public java.util.UUID getUUID()</pre> |
| <div class="block">Get this schema's UUID.</div> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(java.lang.Object o)</pre> |
| <div class="block">Returns true if two Schemas have the same fields in the same order.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>equals</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="typesEqual-org.apache.beam.sdk.schemas.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>typesEqual</h4> |
| <pre>public boolean typesEqual(<a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> other)</pre> |
| <div class="block">Returns true if two schemas are equal ignoring field names and descriptions.</div> |
| </li> |
| </ul> |
| <a name="equivalent-org.apache.beam.sdk.schemas.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equivalent</h4> |
| <pre>public boolean equivalent(<a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> other)</pre> |
| <div class="block">Returns true if two Schemas have the same fields, but possibly in different orders.</div> |
| </li> |
| </ul> |
| <a name="assignableTo-org.apache.beam.sdk.schemas.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assignableTo</h4> |
| <pre>public boolean assignableTo(<a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> other)</pre> |
| <div class="block">Returns true if this Schema can be assigned to another Schema. *</div> |
| </li> |
| </ul> |
| <a name="assignableToIgnoreNullable-org.apache.beam.sdk.schemas.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assignableToIgnoreNullable</h4> |
| <pre>public boolean assignableToIgnoreNullable(<a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> other)</pre> |
| <div class="block">Returns true if this Schema can be assigned to another Schema, ignoring nullable. *</div> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFields</h4> |
| <pre>public java.util.List<<a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a>> getFields()</pre> |
| </li> |
| </ul> |
| <a name="toSchema--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toSchema</h4> |
| <pre>public static java.util.stream.Collector<<a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a>,java.util.List<<a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a>>,<a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>> toSchema()</pre> |
| <div class="block">Collects a stream of <a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas"><code>Schema.Field</code></a>s into a <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getFieldNames--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldNames</h4> |
| <pre>public java.util.List<java.lang.String> getFieldNames()</pre> |
| <div class="block">Return the list of all field names.</div> |
| </li> |
| </ul> |
| <a name="getField-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getField</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a> getField(int index)</pre> |
| <div class="block">Return a field by index.</div> |
| </li> |
| </ul> |
| <a name="getField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getField</h4> |
| <pre>public <a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a> getField(java.lang.String name)</pre> |
| </li> |
| </ul> |
| <a name="indexOf-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>indexOf</h4> |
| <pre>public int indexOf(java.lang.String fieldName)</pre> |
| <div class="block">Find the index of a given field.</div> |
| </li> |
| </ul> |
| <a name="hasField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasField</h4> |
| <pre>public boolean hasField(java.lang.String fieldName)</pre> |
| <div class="block">Returns true if <code>fieldName</code> exists in the schema, false otherwise.</div> |
| </li> |
| </ul> |
| <a name="nameOf-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nameOf</h4> |
| <pre>public java.lang.String nameOf(int fieldIndex)</pre> |
| <div class="block">Return the name of field by index.</div> |
| </li> |
| </ul> |
| <a name="getFieldCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getFieldCount</h4> |
| <pre>public int getFieldCount()</pre> |
| <div class="block">Return the count of fields.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/schemas/Schema.Builder.html" title="class in org.apache.beam.sdk.schemas"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/schemas/Schema.html" target="_top">Frames</a></li> |
| <li><a href="Schema.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>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> |
