| <!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.extensions.avro.io (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.extensions.avro.io (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/extensions/avro/coders/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/schemas/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/avro/io/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>) |
| <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#EXTENSION">EXTENSION</a>) |
| </p> |
| <h1 title="Package" class="title">Package org.apache.beam.sdk.extensions.avro.io</h1> |
| <div class="docSummary"> |
| <div class="block">Defines transforms for reading and writing Avro storage format.</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/extensions/avro/io/AvroIO.RecordFormatter.html" title="interface in org.apache.beam.sdk.extensions.avro.io">AvroIO.RecordFormatter</a><ElementT></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Users can achieve the same by providing this transform in a <a href="../../../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> before using write in AvroIO <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html#write-java.lang.Class-"><code>AvroIO.write(Class)</code></a>.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSink.DatumWriterFactory.html" title="interface in org.apache.beam.sdk.extensions.avro.io">AvroSink.DatumWriterFactory</a><T></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.DatumReaderFactory.html" title="interface in org.apache.beam.sdk.extensions.avro.io">AvroSource.DatumReaderFactory</a><T></td> |
| <td class="colLast"> </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/extensions/avro/io/AvroIO.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroIO</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>s for reading and writing Avro files.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.Parse.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroIO.Parse</a><T></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html#parseGenericRecords-org.apache.beam.sdk.transforms.SerializableFunction-"><code>AvroIO.parseGenericRecords(org.apache.beam.sdk.transforms.SerializableFunction<org.apache.avro.generic.GenericRecord, T>)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.ParseAll.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroIO.ParseAll</a><T></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">See <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html#parseAllGenericRecords-org.apache.beam.sdk.transforms.SerializableFunction-"><code>AvroIO.parseAllGenericRecords(SerializableFunction)</code></a> for details.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.ParseFiles.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroIO.ParseFiles</a><T></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html#parseFilesGenericRecords-org.apache.beam.sdk.transforms.SerializableFunction-"><code>AvroIO.parseFilesGenericRecords(org.apache.beam.sdk.transforms.SerializableFunction<org.apache.avro.generic.GenericRecord, T>)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.Read.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroIO.Read</a><T></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html#read-java.lang.Class-"><code>AvroIO.read(java.lang.Class<T>)</code></a> and <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html#readGenericRecords-org.apache.avro.Schema-"><code>AvroIO.readGenericRecords(org.apache.avro.Schema)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.ReadAll.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroIO.ReadAll</a><T></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">See <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html#readAll-java.lang.Class-"><code>AvroIO.readAll(Class)</code></a> for details.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.ReadFiles.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroIO.ReadFiles</a><T></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html#readFiles-java.lang.Class-"><code>AvroIO.readFiles(java.lang.Class<T>)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.Sink.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroIO.Sink</a><ElementT></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html#sink-java.lang.Class-"><code>AvroIO.sink(java.lang.Class<ElementT>)</code></a> and <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html#sinkViaGenericRecords-org.apache.avro.Schema-org.apache.beam.sdk.extensions.avro.io.AvroIO.RecordFormatter-"><code>AvroIO.sinkViaGenericRecords(org.apache.avro.Schema, org.apache.beam.sdk.extensions.avro.io.AvroIO.RecordFormatter<ElementT>)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.TypedWrite.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroIO.TypedWrite</a><UserT,DestinationT,OutputT></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html#write-java.lang.Class-"><code>AvroIO.write(java.lang.Class<T>)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.Write.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroIO.Write</a><T></td> |
| <td class="colLast"> |
| <div class="block">This class is used as the default return value of <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html#write-java.lang.Class-"><code>AvroIO.write(java.lang.Class<T>)</code></a></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSchemaIOProvider.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSchemaIOProvider</a></td> |
| <td class="colLast"> |
| <div class="block">An implementation of <a href="../../../../../../../org/apache/beam/sdk/schemas/io/SchemaIOProvider.html" title="interface in org.apache.beam.sdk.schemas.io"><code>SchemaIOProvider</code></a> for reading and writing Avro files with <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html" title="class in org.apache.beam.sdk.extensions.avro.io"><code>AvroIO</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSink.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSink</a><UserT,DestinationT,OutputT></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSink.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink</code></a> for Avro files.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><T></td> |
| <td class="colLast"> |
| <div class="block">Do not use in pipelines directly: most users should use <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.Read.html" title="class in org.apache.beam.sdk.extensions.avro.io"><code>AvroIO.Read</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.AvroReader.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource.AvroReader</a><T></td> |
| <td class="colLast"> |
| <div class="block">A <code>BlockBasedReader</code> for reading blocks from Avro files.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/DynamicAvroDestinations.html" title="class in org.apache.beam.sdk.extensions.avro.io">DynamicAvroDestinations</a><UserT,DestinationT,OutputT></td> |
| <td class="colLast"> |
| <div class="block">A specialization of <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink.DynamicDestinations</code></a> for <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroIO.html" title="class in org.apache.beam.sdk.extensions.avro.io"><code>AvroIO</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.beam.sdk.extensions.avro.io Description">Package org.apache.beam.sdk.extensions.avro.io Description</h2> |
| <div class="block">Defines transforms for reading and writing Avro storage format.</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/extensions/avro/coders/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/schemas/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/avro/io/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> |