| <!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_161-google-v7) on Thu Oct 18 16:14:38 PDT 2018 --> |
| <title>org.apache.beam.sdk.schemas (Apache Beam 2.8.0-SNAPSHOT)</title> |
| <meta name="date" content="2018-10-18"> |
| <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="org.apache.beam.sdk.schemas (Apache Beam 2.8.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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/options/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/schemas/transforms/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/schemas/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <p>@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class) |
| </p> |
| <h1 title="Package" class="title">Package org.apache.beam.sdk.schemas</h1> |
| <div class="docSummary"> |
| <div class="block">Defines <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> and other classes for representing schema'd |
| data in a <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/FieldValueGetter.html" title="interface in org.apache.beam.sdk.schemas">FieldValueGetter</a><ObjectT,ValueT></td> |
| <td class="colLast"> |
| <div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/FieldValueGetterFactory.html" title="interface in org.apache.beam.sdk.schemas">FieldValueGetterFactory</a></td> |
| <td class="colLast"> |
| <div class="block">A factory interface for creating <a href="../../../../../org/apache/beam/sdk/schemas/FieldValueGetter.html" title="interface in org.apache.beam.sdk.schemas"><code>FieldValueGetter</code></a> objects |
| corresponding to a class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/FieldValueSetter.html" title="interface in org.apache.beam.sdk.schemas">FieldValueSetter</a><ObjectT,ValueT></td> |
| <td class="colLast"> |
| <div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/FieldValueSetterFactory.html" title="interface in org.apache.beam.sdk.schemas">FieldValueSetterFactory</a></td> |
| <td class="colLast"> |
| <div class="block">A factory interface for creating <a href="../../../../../org/apache/beam/sdk/schemas/FieldValueSetter.html" title="interface in org.apache.beam.sdk.schemas"><code>FieldValueSetter</code></a> objects |
| corresponding to a class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas">SchemaProvider</a></td> |
| <td class="colLast"> |
| <div class="block">Concrete implementations of this class allow creation of schema service objects that vend a |
| <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> for a specific type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaProviderRegistrar.html" title="interface in org.apache.beam.sdk.schemas">SchemaProviderRegistrar</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a> creators have the ability to automatically have their <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>schemaProvider</code></a> registered with this SDK by creating a <code>ServiceLoader</code> entry |
| and a concrete implementation of this interface.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/DefaultSchema.DefaultSchemaProvider.html" title="class in org.apache.beam.sdk.schemas">DefaultSchema.DefaultSchemaProvider</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a> for default schemas.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/DefaultSchema.DefaultSchemaProviderRegistrar.html" title="class in org.apache.beam.sdk.schemas">DefaultSchema.DefaultSchemaProviderRegistrar</a></td> |
| <td class="colLast"> |
| <div class="block">Registrar for default schemas.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/FieldAccessDescriptor.html" title="class in org.apache.beam.sdk.schemas">FieldAccessDescriptor</a></td> |
| <td class="colLast"> |
| <div class="block">Used inside of a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> to describe which fields in a schema |
| type need to be accessed for processing.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/FieldTypeDescriptors.html" title="class in org.apache.beam.sdk.schemas">FieldTypeDescriptors</a></td> |
| <td class="colLast"> |
| <div class="block">Utilities for converting between <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> field types and <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a>s that |
| define Java objects which can represent these field types.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/GetterBasedSchemaProvider.html" title="class in org.apache.beam.sdk.schemas">GetterBasedSchemaProvider</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a> base class that vends schemas and rows based on <a href="../../../../../org/apache/beam/sdk/schemas/FieldValueGetter.html" title="interface in org.apache.beam.sdk.schemas"><code>FieldValueGetter</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/JavaBeanSchema.html" title="class in org.apache.beam.sdk.schemas">JavaBeanSchema</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a> for Java Bean objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/JavaFieldSchema.html" title="class in org.apache.beam.sdk.schemas">JavaFieldSchema</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a> for Java POJO objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.Builder.html" title="class in org.apache.beam.sdk.schemas">Schema.Builder</a></td> |
| <td class="colLast"> |
| <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"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas">Schema.Field</a></td> |
| <td class="colLast"> |
| <div class="block">Field of a row.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.Builder.html" title="class in org.apache.beam.sdk.schemas">Schema.Field.Builder</a></td> |
| <td class="colLast"> |
| <div class="block">Builder for <a href="../../../../../org/apache/beam/sdk/schemas/Schema.Field.html" title="class in org.apache.beam.sdk.schemas"><code>Schema.Field</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a></td> |
| <td class="colLast"> |
| <div class="block">A descriptor of a single field type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaCoder.html" title="class in org.apache.beam.sdk.schemas">SchemaCoder</a><T></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaCoder.html" title="class in org.apache.beam.sdk.schemas"><code>SchemaCoder</code></a> is used as the coder for types that have schemas registered.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html" title="class in org.apache.beam.sdk.schemas">SchemaRegistry</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html" title="class in org.apache.beam.sdk.schemas"><code>SchemaRegistry</code></a> allows registering <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a>s for a given Java <code>Class</code> or a |
| <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/Schema.TypeName.html" title="enum in org.apache.beam.sdk.schemas">Schema.TypeName</a></td> |
| <td class="colLast"> |
| <div class="block">An enumerated list of type constructors.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></td> |
| <td class="colLast"> |
| <div class="block">Indicates that we are missing a schema for a type.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> |
| <caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Annotation Type</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/schemas/DefaultSchema.html" title="annotation in org.apache.beam.sdk.schemas">DefaultSchema</a></td> |
| <td class="colLast"> |
| <div class="block">The <a href="../../../../../org/apache/beam/sdk/schemas/DefaultSchema.html" title="annotation in org.apache.beam.sdk.schemas"><code>DefaultSchema</code></a> annotation specifies a <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a> class to handle obtaining |
| a schema and row for the specified class.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.beam.sdk.schemas Description">Package org.apache.beam.sdk.schemas Description</h2> |
| <div class="block">Defines <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> and other classes for representing schema'd |
| data in a <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>. |
| |
| <p>For further details, see the documentation for each class in this package.</div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/options/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/schemas/transforms/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/schemas/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
