| <!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 --> |
| <title>org.apache.beam.sdk.schemas.annotations (Apache Beam 2.47.0)</title> |
| <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.annotations (Apache Beam 2.47.0)"; |
| } |
| } |
| 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/schemas/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/schemas/io/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/annotations/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=<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/NonNull.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">org.checkerframework.checker.nullness.qual.NonNull.class</a>) |
| </p> |
| <h1 title="Package" class="title">Package org.apache.beam.sdk.schemas.annotations</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="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/annotations/DefaultSchema.DefaultSchemaProvider.html" title="class in org.apache.beam.sdk.schemas.annotations">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/annotations/DefaultSchema.DefaultSchemaProviderRegistrar.html" title="class in org.apache.beam.sdk.schemas.annotations">DefaultSchema.DefaultSchemaProviderRegistrar</a></td> |
| <td class="colLast"> |
| <div class="block">Registrar for default schemas.</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/annotations/DefaultSchema.html" title="annotation in org.apache.beam.sdk.schemas.annotations">DefaultSchema</a></td> |
| <td class="colLast"> |
| <div class="block">The <a href="../../../../../../org/apache/beam/sdk/schemas/annotations/DefaultSchema.html" title="annotation in org.apache.beam.sdk.schemas.annotations"><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> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/SchemaCaseFormat.html" title="annotation in org.apache.beam.sdk.schemas.annotations">SchemaCaseFormat</a></td> |
| <td class="colLast"> |
| <div class="block">When used on a <a href="../../../../../../org/apache/beam/sdk/schemas/JavaFieldSchema.html" title="class in org.apache.beam.sdk.schemas"><code>POJO</code></a>, <a href="../../../../../../org/apache/beam/sdk/schemas/JavaBeanSchema.html" title="class in org.apache.beam.sdk.schemas"><code>Java Bean</code></a>, or <a href="../../../../../../org/apache/beam/sdk/schemas/AutoValueSchema.html" title="class in org.apache.beam.sdk.schemas"><code>AutoValue</code></a> class the specified case format will be |
| used for all the generated Schema fields.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/SchemaCreate.html" title="annotation in org.apache.beam.sdk.schemas.annotations">SchemaCreate</a></td> |
| <td class="colLast"> |
| <div class="block">Can be put on a constructor or a static method, in which case that constructor or method will be |
| used to created instance of the class by Beam's schema code.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/SchemaFieldDescription.html" title="annotation in org.apache.beam.sdk.schemas.annotations">SchemaFieldDescription</a></td> |
| <td class="colLast"> |
| <div class="block">When used on a <a href="../../../../../../org/apache/beam/sdk/schemas/JavaFieldSchema.html" title="class in org.apache.beam.sdk.schemas"><code>POJO</code></a> field, a <a href="../../../../../../org/apache/beam/sdk/schemas/JavaBeanSchema.html" title="class in org.apache.beam.sdk.schemas"><code>Java Bean</code></a> getter, or an <a href="../../../../../../org/apache/beam/sdk/schemas/AutoValueSchema.html" title="class in org.apache.beam.sdk.schemas"><code>AutoValue</code></a> getter, the specified description is used |
| for the generated schema field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/SchemaFieldName.html" title="annotation in org.apache.beam.sdk.schemas.annotations">SchemaFieldName</a></td> |
| <td class="colLast"> |
| <div class="block">When used on a <a href="../../../../../../org/apache/beam/sdk/schemas/JavaFieldSchema.html" title="class in org.apache.beam.sdk.schemas"><code>POJO</code></a> field, a <a href="../../../../../../org/apache/beam/sdk/schemas/JavaBeanSchema.html" title="class in org.apache.beam.sdk.schemas"><code>Java Bean</code></a> getter, or an <a href="../../../../../../org/apache/beam/sdk/schemas/AutoValueSchema.html" title="class in org.apache.beam.sdk.schemas"><code>AutoValue</code></a> getter, the specified name is used for the |
| generated schema field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/SchemaFieldNumber.html" title="annotation in org.apache.beam.sdk.schemas.annotations">SchemaFieldNumber</a></td> |
| <td class="colLast"> |
| <div class="block">When used on a <a href="../../../../../../org/apache/beam/sdk/schemas/JavaFieldSchema.html" title="class in org.apache.beam.sdk.schemas"><code>POJO</code></a> field, a <a href="../../../../../../org/apache/beam/sdk/schemas/JavaBeanSchema.html" title="class in org.apache.beam.sdk.schemas"><code>Java Bean</code></a> getter, or an <a href="../../../../../../org/apache/beam/sdk/schemas/AutoValueSchema.html" title="class in org.apache.beam.sdk.schemas"><code>AutoValue</code></a> getter, the generated field will have the |
| specified index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/SchemaIgnore.html" title="annotation in org.apache.beam.sdk.schemas.annotations">SchemaIgnore</a></td> |
| <td class="colLast"> |
| <div class="block">When used on a POJO field or a JavaBean getter, that field or getter is ignored from the inferred |
| schema.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.beam.sdk.schemas.annotations Description">Package org.apache.beam.sdk.schemas.annotations 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/schemas/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/schemas/io/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/annotations/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> |
