| <!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>SchemaIOProvider (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="SchemaIOProvider (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/io/SchemaIO.html" title="interface in org.apache.beam.sdk.schemas.io"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/io/SchemaIOProvider.html" target="_top">Frames</a></li> |
| <li><a href="SchemaIOProvider.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.io</div> |
| <h2 title="Interface SchemaIOProvider" class="title">Interface SchemaIOProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/io/AvroSchemaIOProvider.html" title="class in org.apache.beam.sdk.io">AvroSchemaIOProvider</a>, <a href="../../../../../../org/apache/beam/sdk/io/gcp/bigquery/BigQuerySchemaIOProvider.html" title="class in org.apache.beam.sdk.io.gcp.bigquery">BigQuerySchemaIOProvider</a>, <a href="../../../../../../org/apache/beam/sdk/io/gcp/datastore/DataStoreV1SchemaIOProvider.html" title="class in org.apache.beam.sdk.io.gcp.datastore">DataStoreV1SchemaIOProvider</a>, <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcSchemaIOProvider.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcSchemaIOProvider</a>, <a href="../../../../../../org/apache/beam/sdk/io/gcp/pubsub/PubsubSchemaIOProvider.html" title="class in org.apache.beam.sdk.io.gcp.pubsub">PubsubSchemaIOProvider</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre><a href="../../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> |
| <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 interface <span class="typeNameLabel">SchemaIOProvider</span></pre> |
| <div class="block">Provider to create <a href="../../../../../../org/apache/beam/sdk/schemas/io/SchemaIO.html" title="interface in org.apache.beam.sdk.schemas.io"><code>SchemaIO</code></a> instances for use in Beam SQL and other SDKs. |
| |
| <p><b>Internal only:</b> This interface is actively being worked on and it will likely change as |
| we provide implementations for more standard Beam IOs. We provide no backwards compatibility |
| guarantees and it should not be implemented outside of the Beam repository. |
| |
| <p>For a detailed walkthrough of implementation, see <a |
| href="https://s.apache.org/schemaio-development-guide">s.apache.org/schemaio-development-guide |
| </a></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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><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/io/SchemaIOProvider.html#configurationSchema--">configurationSchema</a></span>()</code> |
| <div class="block">Returns the expected schema of the configuration object.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/schemas/io/SchemaIO.html" title="interface in org.apache.beam.sdk.schemas.io">SchemaIO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/schemas/io/SchemaIOProvider.html#from-java.lang.String-org.apache.beam.sdk.values.Row-org.apache.beam.sdk.schemas.Schema-">from</a></span>(java.lang.String location, |
| <a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a> configuration, |
| <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> dataSchema)</code> |
| <div class="block">Produce a SchemaIO given a String representing the data's location, the schema of the data that |
| resides there, and some IO-specific configuration object.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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/io/SchemaIOProvider.html#identifier--">identifier</a></span>()</code> |
| <div class="block">Returns an id that uniquely represents this IO.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/values/PCollection.IsBounded.html" title="enum in org.apache.beam.sdk.values">PCollection.IsBounded</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/schemas/io/SchemaIOProvider.html#isBounded--">isBounded</a></span>()</code> </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/io/SchemaIOProvider.html#requiresDataSchema--">requiresDataSchema</a></span>()</code> |
| <div class="block">Indicates whether the dataSchema value is necessary.</div> |
| </td> |
| </tr> |
| </table> |
| </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="identifier--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>identifier</h4> |
| <pre>java.lang.String identifier()</pre> |
| <div class="block">Returns an id that uniquely represents this IO.</div> |
| </li> |
| </ul> |
| <a name="configurationSchema--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configurationSchema</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> configurationSchema()</pre> |
| <div class="block">Returns the expected schema of the configuration object. Note this is distinct from the schema |
| of the data source itself.</div> |
| </li> |
| </ul> |
| <a name="from-java.lang.String-org.apache.beam.sdk.values.Row-org.apache.beam.sdk.schemas.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>from</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/schemas/io/SchemaIO.html" title="interface in org.apache.beam.sdk.schemas.io">SchemaIO</a> from(java.lang.String location, |
| <a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a> configuration, |
| <a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> dataSchema)</pre> |
| <div class="block">Produce a SchemaIO given a String representing the data's location, the schema of the data that |
| resides there, and some IO-specific configuration object. Can throw a <a href="../../../../../../org/apache/beam/sdk/schemas/io/InvalidConfigurationException.html" title="class in org.apache.beam.sdk.schemas.io"><code>InvalidConfigurationException</code></a> or a <a href="../../../../../../org/apache/beam/sdk/schemas/io/InvalidSchemaException.html" title="class in org.apache.beam.sdk.schemas.io"><code>InvalidSchemaException</code></a>.</div> |
| </li> |
| </ul> |
| <a name="requiresDataSchema--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiresDataSchema</h4> |
| <pre>boolean requiresDataSchema()</pre> |
| <div class="block">Indicates whether the dataSchema value is necessary.</div> |
| </li> |
| </ul> |
| <a name="isBounded--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isBounded</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/values/PCollection.IsBounded.html" title="enum in org.apache.beam.sdk.values">PCollection.IsBounded</a> isBounded()</pre> |
| </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/io/SchemaIO.html" title="interface in org.apache.beam.sdk.schemas.io"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/io/SchemaIOProvider.html" target="_top">Frames</a></li> |
| <li><a href="SchemaIOProvider.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> |
