| <!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>SchemaRegistry (Apache Beam 2.38.0-SNAPSHOT)</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="SchemaRegistry (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":10,"i2":10,"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":10,"i17":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/SchemaProviderRegistrar.html" title="interface in org.apache.beam.sdk.schemas"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/schemas/SchemaTranslation.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/SchemaRegistry.html" target="_top">Frames</a></li> |
| <li><a href="SchemaRegistry.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 SchemaRegistry" class="title">Class SchemaRegistry</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.schemas.SchemaRegistry</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <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">SchemaRegistry</span> |
| extends java.lang.Object</pre> |
| <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>. |
| |
| <p>Types registered in a pipeline's schema registry will automatically be discovered by any |
| <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> that uses <a href="../../../../../org/apache/beam/sdk/schemas/SchemaCoder.html" title="class in org.apache.beam.sdk.schemas"><code>SchemaCoder</code></a>. This allows users |
| to write pipelines in terms of their own Java types, yet still register schemas for these types. |
| |
| <p>TODO: Provide support for schemas registered via a ServiceLoader interface. This will allow |
| optional modules to register schemas as well.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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>static <a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html" title="class in org.apache.beam.sdk.schemas">SchemaRegistry</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#createDefault--">createDefault</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>,T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#getFromRowFunction-java.lang.Class-">getFromRowFunction</a></span>(java.lang.Class<T> clazz)</code> |
| <div class="block">Retrieve the function that converts a <a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a> object to the specified type.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>,T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#getFromRowFunction-org.apache.beam.sdk.values.TypeDescriptor-">getFromRowFunction</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor)</code> |
| <div class="block">Retrieve the function that converts a <a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a> object to the specified type.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><T> <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/SchemaRegistry.html#getSchema-java.lang.Class-">getSchema</a></span>(java.lang.Class<T> clazz)</code> |
| <div class="block">Retrieve a <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> for a given <code>Class</code> type.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><T> <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/SchemaRegistry.html#getSchema-org.apache.beam.sdk.values.TypeDescriptor-">getSchema</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor)</code> |
| <div class="block">Retrieve a <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> for a given <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> type.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../../../../org/apache/beam/sdk/schemas/SchemaCoder.html" title="class in org.apache.beam.sdk.schemas">SchemaCoder</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#getSchemaCoder-java.lang.Class-">getSchemaCoder</a></span>(java.lang.Class<T> clazz)</code> |
| <div class="block">Retrieve a <a href="../../../../../org/apache/beam/sdk/schemas/SchemaCoder.html" title="class in org.apache.beam.sdk.schemas"><code>SchemaCoder</code></a> for a given <code>Class</code> type.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../../../../org/apache/beam/sdk/schemas/SchemaCoder.html" title="class in org.apache.beam.sdk.schemas">SchemaCoder</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#getSchemaCoder-org.apache.beam.sdk.values.TypeDescriptor-">getSchemaCoder</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor)</code> |
| <div class="block">Retrieve a <a href="../../../../../org/apache/beam/sdk/schemas/SchemaCoder.html" title="class in org.apache.beam.sdk.schemas"><code>SchemaCoder</code></a> for a given <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> type.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><T,<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#getToRowFunction-java.lang.Class-">getToRowFunction</a></span>(java.lang.Class<T> clazz)</code> |
| <div class="block">Retrieve the function that converts an object of the specified type to a <a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a> object.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><T,<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#getToRowFunction-org.apache.beam.sdk.values.TypeDescriptor-">getToRowFunction</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor)</code> |
| <div class="block">Retrieve the function that converts an object of the specified type to a <a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a> object.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#registerJavaBean-java.lang.Class-">registerJavaBean</a></span>(java.lang.Class<T> clazz)</code> |
| <div class="block">Register a JavaBean type for automatic schema inference.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#registerJavaBean-org.apache.beam.sdk.values.TypeDescriptor-">registerJavaBean</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor)</code> |
| <div class="block">Register a JavaBean type for automatic schema inference.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#registerPOJO-java.lang.Class-">registerPOJO</a></span>(java.lang.Class<T> clazz)</code> |
| <div class="block">Register a POJO type for automatic schema inference.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#registerPOJO-org.apache.beam.sdk.values.TypeDescriptor-">registerPOJO</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor)</code> |
| <div class="block">Register a POJO type for automatic schema inference.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#registerSchemaForClass-java.lang.Class-org.apache.beam.sdk.schemas.Schema-org.apache.beam.sdk.transforms.SerializableFunction-org.apache.beam.sdk.transforms.SerializableFunction-">registerSchemaForClass</a></span>(java.lang.Class<T> clazz, |
| <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> schema, |
| <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><T,<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>> toRow, |
| <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>,T> fromRow)</code> |
| <div class="block">Register a schema for a specific <code>Class</code> type.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#registerSchemaForType-org.apache.beam.sdk.values.TypeDescriptor-org.apache.beam.sdk.schemas.Schema-org.apache.beam.sdk.transforms.SerializableFunction-org.apache.beam.sdk.transforms.SerializableFunction-">registerSchemaForType</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> type, |
| <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> schema, |
| <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><T,<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>> toRow, |
| <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>,T> fromRow)</code> |
| <div class="block">Register a schema for a specific <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> type.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#registerSchemaProvider-java.lang.Class-org.apache.beam.sdk.schemas.SchemaProvider-">registerSchemaProvider</a></span>(java.lang.Class<T> clazz, |
| <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas">SchemaProvider</a> schemaProvider)</code> |
| <div class="block">Register a <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a> to be used for a specific type.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#registerSchemaProvider-org.apache.beam.sdk.schemas.SchemaProvider-">registerSchemaProvider</a></span>(<a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas">SchemaProvider</a> schemaProvider)</code> |
| <div class="block">Register a <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html#registerSchemaProvider-org.apache.beam.sdk.values.TypeDescriptor-org.apache.beam.sdk.schemas.SchemaProvider-">registerSchemaProvider</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor, |
| <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas">SchemaProvider</a> schemaProvider)</code> |
| <div class="block">Register a <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a> to be used for a specific type.</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createDefault--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createDefault</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/sdk/schemas/SchemaRegistry.html" title="class in org.apache.beam.sdk.schemas">SchemaRegistry</a> createDefault()</pre> |
| </li> |
| </ul> |
| <a name="registerSchemaForClass-java.lang.Class-org.apache.beam.sdk.schemas.Schema-org.apache.beam.sdk.transforms.SerializableFunction-org.apache.beam.sdk.transforms.SerializableFunction-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerSchemaForClass</h4> |
| <pre>public <T> void registerSchemaForClass(java.lang.Class<T> clazz, |
| <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> schema, |
| <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><T,<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>> toRow, |
| <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>,T> fromRow)</pre> |
| <div class="block">Register a schema for a specific <code>Class</code> type.</div> |
| </li> |
| </ul> |
| <a name="registerSchemaForType-org.apache.beam.sdk.values.TypeDescriptor-org.apache.beam.sdk.schemas.Schema-org.apache.beam.sdk.transforms.SerializableFunction-org.apache.beam.sdk.transforms.SerializableFunction-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerSchemaForType</h4> |
| <pre>public <T> void registerSchemaForType(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> type, |
| <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> schema, |
| <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><T,<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>> toRow, |
| <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>,T> fromRow)</pre> |
| <div class="block">Register a schema for a specific <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> type.</div> |
| </li> |
| </ul> |
| <a name="registerSchemaProvider-org.apache.beam.sdk.schemas.SchemaProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerSchemaProvider</h4> |
| <pre>public void registerSchemaProvider(<a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas">SchemaProvider</a> schemaProvider)</pre> |
| <div class="block">Register a <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a>. |
| |
| <p>A <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a> allows for deferred lookups of per-type schemas. This can be used |
| when schemas are registered in an external service. The SchemaProvider will lookup the type in |
| the external service and return the correct <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="registerSchemaProvider-java.lang.Class-org.apache.beam.sdk.schemas.SchemaProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerSchemaProvider</h4> |
| <pre>public <T> void registerSchemaProvider(java.lang.Class<T> clazz, |
| <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas">SchemaProvider</a> schemaProvider)</pre> |
| <div class="block">Register a <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a> to be used for a specific type. *</div> |
| </li> |
| </ul> |
| <a name="registerSchemaProvider-org.apache.beam.sdk.values.TypeDescriptor-org.apache.beam.sdk.schemas.SchemaProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerSchemaProvider</h4> |
| <pre>public <T> void registerSchemaProvider(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor, |
| <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas">SchemaProvider</a> schemaProvider)</pre> |
| <div class="block">Register a <a href="../../../../../org/apache/beam/sdk/schemas/SchemaProvider.html" title="interface in org.apache.beam.sdk.schemas"><code>SchemaProvider</code></a> to be used for a specific type. *</div> |
| </li> |
| </ul> |
| <a name="registerPOJO-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerPOJO</h4> |
| <pre>public <T> void registerPOJO(java.lang.Class<T> clazz)</pre> |
| <div class="block">Register a POJO type for automatic schema inference. |
| |
| <p>Currently schema field names will match field names in the POJO, and all fields must be |
| mutable (i.e. no final fields).</div> |
| </li> |
| </ul> |
| <a name="registerPOJO-org.apache.beam.sdk.values.TypeDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerPOJO</h4> |
| <pre>public <T> void registerPOJO(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor)</pre> |
| <div class="block">Register a POJO type for automatic schema inference. |
| |
| <p>Currently schema field names will match field names in the POJO, and all fields must be |
| mutable (i.e. no final fields). The Java object is expected to have implemented a correct |
| .equals() and .hashCode methods The equals method must be completely determined by the schema |
| fields. i.e. if the object has hidden fields that are not reflected in the schema but are |
| compared in equals, then results will be incorrect.</div> |
| </li> |
| </ul> |
| <a name="registerJavaBean-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerJavaBean</h4> |
| <pre>public <T> void registerJavaBean(java.lang.Class<T> clazz)</pre> |
| <div class="block">Register a JavaBean type for automatic schema inference. |
| |
| <p>Currently schema field names will match getter names in the bean, and all getters must have |
| matching setters. The Java object is expected to have implemented a correct .equals() and |
| .hashCode methods The equals method must be completely determined by the schema fields. i.e. if |
| the object has hidden fields that are not reflected in the schema but are compared in equals, |
| then results will be incorrect.</div> |
| </li> |
| </ul> |
| <a name="registerJavaBean-org.apache.beam.sdk.values.TypeDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerJavaBean</h4> |
| <pre>public <T> void registerJavaBean(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor)</pre> |
| <div class="block">Register a JavaBean type for automatic schema inference. |
| |
| <p>Currently schema field names will match getter names in the bean, and all getters must have |
| matching setters.</div> |
| </li> |
| </ul> |
| <a name="getSchema-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre>public <T> <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> getSchema(java.lang.Class<T> clazz) |
| throws <a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></pre> |
| <div class="block">Retrieve a <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> for a given <code>Class</code> type. If no schema exists, throws <a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas"><code>NoSuchSchemaException</code></a>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchema-org.apache.beam.sdk.values.TypeDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre>public <T> <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> getSchema(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor) |
| throws <a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></pre> |
| <div class="block">Retrieve a <a href="../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas"><code>Schema</code></a> for a given <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> type. If no schema exists, throws |
| <a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas"><code>NoSuchSchemaException</code></a>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getToRowFunction-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getToRowFunction</h4> |
| <pre>public <T> <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><T,<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>> getToRowFunction(java.lang.Class<T> clazz) |
| throws <a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></pre> |
| <div class="block">Retrieve the function that converts an object of the specified type to a <a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a> object.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getToRowFunction-org.apache.beam.sdk.values.TypeDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getToRowFunction</h4> |
| <pre>public <T> <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><T,<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>> getToRowFunction(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor) |
| throws <a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></pre> |
| <div class="block">Retrieve the function that converts an object of the specified type to a <a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a> object.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFromRowFunction-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFromRowFunction</h4> |
| <pre>public <T> <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>,T> getFromRowFunction(java.lang.Class<T> clazz) |
| throws <a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></pre> |
| <div class="block">Retrieve the function that converts a <a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a> object to the specified type.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFromRowFunction-org.apache.beam.sdk.values.TypeDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFromRowFunction</h4> |
| <pre>public <T> <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>,T> getFromRowFunction(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor) |
| throws <a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></pre> |
| <div class="block">Retrieve the function that converts a <a href="../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a> object to the specified type.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchemaCoder-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemaCoder</h4> |
| <pre>public <T> <a href="../../../../../org/apache/beam/sdk/schemas/SchemaCoder.html" title="class in org.apache.beam.sdk.schemas">SchemaCoder</a><T> getSchemaCoder(java.lang.Class<T> clazz) |
| throws <a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></pre> |
| <div class="block">Retrieve a <a href="../../../../../org/apache/beam/sdk/schemas/SchemaCoder.html" title="class in org.apache.beam.sdk.schemas"><code>SchemaCoder</code></a> for a given <code>Class</code> type. If no schema exists, throws |
| <code>NoSuchSchemaException</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchemaCoder-org.apache.beam.sdk.values.TypeDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSchemaCoder</h4> |
| <pre>public <T> <a href="../../../../../org/apache/beam/sdk/schemas/SchemaCoder.html" title="class in org.apache.beam.sdk.schemas">SchemaCoder</a><T> getSchemaCoder(<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> typeDescriptor) |
| throws <a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</a></pre> |
| <div class="block">Retrieve a <a href="../../../../../org/apache/beam/sdk/schemas/SchemaCoder.html" title="class in org.apache.beam.sdk.schemas"><code>SchemaCoder</code></a> for a given <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> type. If no schema exists, |
| throws <code>NoSuchSchemaException</code>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/beam/sdk/schemas/NoSuchSchemaException.html" title="class in org.apache.beam.sdk.schemas">NoSuchSchemaException</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> |
| <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/SchemaProviderRegistrar.html" title="interface in org.apache.beam.sdk.schemas"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/schemas/SchemaTranslation.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/SchemaRegistry.html" target="_top">Frames</a></li> |
| <li><a href="SchemaRegistry.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
