| <!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>AvroSource (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="AvroSource (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":42,"i2":10,"i3":9,"i4":9,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/extensions/avro/io/AvroSink.DatumWriterFactory.html" title="interface in org.apache.beam.sdk.extensions.avro.io"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.AvroReader.html" title="class in org.apache.beam.sdk.extensions.avro.io"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/avro/io/AvroSource.html" target="_top">Frames</a></li> |
| <li><a href="AvroSource.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><a href="#nested.class.summary">Nested</a> | </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.extensions.avro.io</div> |
| <h2 title="Class AvroSource" class="title">Class AvroSource<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">org.apache.beam.sdk.io.Source</a><T></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io">org.apache.beam.sdk.io.BoundedSource</a><T></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/OffsetBasedSource.html" title="class in org.apache.beam.sdk.io">org.apache.beam.sdk.io.OffsetBasedSource</a><T></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html" title="class in org.apache.beam.sdk.io">org.apache.beam.sdk.io.FileBasedSource</a><T></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.html" title="class in org.apache.beam.sdk.io">org.apache.beam.sdk.io.BlockBasedSource</a><T></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.extensions.avro.io.AvroSource<T></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type of records to be read from the source.</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable, <a href="../../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd> |
| </dl> |
| <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#SOURCE_SINK">SOURCE_SINK</a>) |
| public class <span class="typeNameLabel">AvroSource<T></span> |
| extends <a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.html" title="class in org.apache.beam.sdk.io">BlockBasedSource</a><T></pre> |
| <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>. |
| |
| <p>A <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSource</code></a> for reading Avro files. |
| |
| <p>To read a <a href="../../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of objects from one or more Avro files, use <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#from-org.apache.beam.sdk.options.ValueProvider-"><code>from(org.apache.beam.sdk.options.ValueProvider<java.lang.String>)</code></a> to specify the path(s) of the files to read. The <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io"><code>AvroSource</code></a> that is |
| returned will read objects of type <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic"><code>GenericRecord</code></a> with the schema(s) that were written at |
| file creation. To further configure the <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io"><code>AvroSource</code></a> to read with a user-defined schema, or |
| to return records of a type other than <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic"><code>GenericRecord</code></a>, use <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withSchema-org.apache.avro.Schema-"><code>withSchema(Schema)</code></a> (using an Avro <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/Schema.html?is-external=true" title="class or interface in org.apache.avro"><code>Schema</code></a>), <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withSchema-java.lang.String-"><code>withSchema(String)</code></a> (using a JSON schema), or <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withSchema-java.lang.Class-"><code>withSchema(Class)</code></a> (to |
| return objects of the Avro-generated class specified). |
| |
| <p>An <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io"><code>AvroSource</code></a> can be read from using the <a href="../../../../../../../org/apache/beam/sdk/io/Read.html" title="class in org.apache.beam.sdk.io"><code>Read</code></a> transform. For example: |
| |
| <pre><code> |
| AvroSource<MyType> source = AvroSource.from(file.toPath()).withSchema(MyType.class); |
| PCollection<MyType> records = Read.from(mySource); |
| </code></pre> |
| |
| <p>This class's implementation is based on the <a |
| href="https://avro.apache.org/docs/1.7.7/spec.html">Avro 1.7.7</a> specification and implements |
| parsing of some parts of Avro Object Container Files. The rationale for doing so is that the Avro |
| API does not provide efficient ways of computing the precise offsets of blocks within a file, |
| which is necessary to support dynamic work rebalancing. However, whenever it is possible to use |
| the Avro API in a way that supports maintaining precise offsets, this class uses the Avro API. |
| |
| <p>Avro Object Container files store records in blocks. Each block contains a collection of |
| records. Blocks may be encoded (e.g., with bzip2, deflate, snappy, etc.). Blocks are delineated |
| from one another by a 16-byte sync marker. |
| |
| <p>An <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io"><code>AvroSource</code></a> for a subrange of a single file contains records in the blocks such that |
| the start offset of the block is greater than or equal to the start offset of the source and less |
| than the end offset of the source. |
| |
| <p>To use XZ-encoded Avro files, please include an explicit dependency on <code>xz-1.8.jar</code>, |
| which has been marked as optional in the Maven <code>sdk/pom.xml</code>. |
| |
| <pre><code> |
| <dependency> |
| <groupId>org.tukaani</groupId> |
| <artifactId>xz</artifactId> |
| <version>1.8</version> |
| </dependency> |
| </code></pre> |
| |
| <h3>Permissions</h3> |
| |
| <p>Permission requirements depend on the <a href="../../../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunner</code></a> that is used to execute the |
| pipeline. Please refer to the documentation of corresponding <a href="../../../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunner</code></a>s for more |
| details.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../serialized-form.html#org.apache.beam.sdk.extensions.avro.io.AvroSource">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.AvroReader.html" title="type parameter in AvroSource.AvroReader">T</a>></span></code> |
| <div class="block">A <code>BlockBasedReader</code> for reading blocks from Avro files.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.DatumReaderFactory.html" title="type parameter in AvroSource.DatumReaderFactory">T</a>></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.io.BlockBasedSource"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.beam.sdk.io.<a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.html" title="class in org.apache.beam.sdk.io">BlockBasedSource</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.Block.html" title="class in org.apache.beam.sdk.io">BlockBasedSource.Block</a><<a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.Block.html" title="type parameter in BlockBasedSource.Block">T</a>>, <a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.BlockBasedReader.html" title="class in org.apache.beam.sdk.io">BlockBasedSource.BlockBasedReader</a><<a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.BlockBasedReader.html" title="type parameter in BlockBasedSource.BlockBasedReader">T</a>></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.io.FileBasedSource"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.beam.sdk.io.<a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html" title="class in org.apache.beam.sdk.io">FileBasedSource</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.FileBasedReader.html" title="class in org.apache.beam.sdk.io">FileBasedSource.FileBasedReader</a><<a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.FileBasedReader.html" title="type parameter in FileBasedSource.FileBasedReader">T</a>></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.io.OffsetBasedSource"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.beam.sdk.io.<a href="../../../../../../../org/apache/beam/sdk/io/OffsetBasedSource.html" title="class in org.apache.beam.sdk.io">OffsetBasedSource</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/io/OffsetBasedSource.OffsetBasedReader.html" title="class in org.apache.beam.sdk.io">OffsetBasedSource.OffsetBasedReader</a><<a href="../../../../../../../org/apache/beam/sdk/io/OffsetBasedSource.OffsetBasedReader.html" title="type parameter in OffsetBasedSource.OffsetBasedReader">T</a>></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.io.BoundedSource"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.beam.sdk.io.<a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io">BoundedSource</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="class in org.apache.beam.sdk.io">BoundedSource.BoundedReader</a><<a href="../../../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="type parameter in BoundedSource.BoundedReader">T</a>></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.io.Source"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.beam.sdk.io.<a href="../../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/io/Source.Reader.html" title="class in org.apache.beam.sdk.io">Source.Reader</a><<a href="../../../../../../../org/apache/beam/sdk/io/Source.Reader.html" title="type parameter in Source.Reader">T</a>></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== 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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/io/BlockBasedSource.html" title="class in org.apache.beam.sdk.io">BlockBasedSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#createForSubrangeOfFile-org.apache.beam.sdk.io.fs.MatchResult.Metadata-long-long-">createForSubrangeOfFile</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/fs/MatchResult.Metadata.html" title="class in org.apache.beam.sdk.io.fs">MatchResult.Metadata</a> fileMetadata, |
| long start, |
| long end)</code> |
| <div class="block">Creates a <code>BlockBasedSource</code> for the specified range in a single file.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.html" title="class in org.apache.beam.sdk.io">BlockBasedSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#createForSubrangeOfFile-java.lang.String-long-long-">createForSubrangeOfFile</a></span>(java.lang.String fileName, |
| long start, |
| long end)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Used by Dataflow worker</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.BlockBasedReader.html" title="class in org.apache.beam.sdk.io">BlockBasedSource.BlockBasedReader</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#createSingleFileReader-org.apache.beam.sdk.options.PipelineOptions-">createSingleFileReader</a></span>(<a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</code> |
| <div class="block">Creates a <code>BlockBasedReader</code>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic">GenericRecord</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#from-org.apache.beam.sdk.io.fs.MatchResult.Metadata-">from</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/fs/MatchResult.Metadata.html" title="class in org.apache.beam.sdk.io.fs">MatchResult.Metadata</a> metadata)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic">GenericRecord</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#from-java.lang.String-">from</a></span>(java.lang.String fileNameOrPattern)</code> |
| <div class="block">Like <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#from-org.apache.beam.sdk.options.ValueProvider-"><code>from(ValueProvider)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic">GenericRecord</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#from-org.apache.beam.sdk.options.ValueProvider-">from</a></span>(<a href="../../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> fileNameOrPattern)</code> |
| <div class="block">Reads from the given file name or pattern ("glob").</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#getOutputCoder--">getOutputCoder</a></span>()</code> |
| <div class="block">Returns the <code>Coder</code> to use for the data read from this source.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#validate--">validate</a></span>()</code> |
| <div class="block">Checks that this source is valid, before it can be used in a pipeline.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withDatumReaderFactory-org.apache.beam.sdk.extensions.avro.io.AvroSource.DatumReaderFactory-">withDatumReaderFactory</a></span>(<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><?> factory)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withEmptyMatchTreatment-org.apache.beam.sdk.io.fs.EmptyMatchTreatment-">withEmptyMatchTreatment</a></span>(<a href="../../../../../../../org/apache/beam/sdk/io/fs/EmptyMatchTreatment.html" title="enum in org.apache.beam.sdk.io.fs">EmptyMatchTreatment</a> emptyMatchTreatment)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withMinBundleSize-long-">withMinBundleSize</a></span>(long minBundleSize)</code> |
| <div class="block">Sets the minimum bundle size.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><X> <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><X></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withParseFn-org.apache.beam.sdk.transforms.SerializableFunction-org.apache.beam.sdk.coders.Coder-">withParseFn</a></span>(<a href="../../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic">GenericRecord</a>,X> parseFn, |
| <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><X> coder)</code> |
| <div class="block">Reads <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic"><code>GenericRecord</code></a> of unspecified schema and maps them to instances of a custom type |
| using the given <code>parseFn</code> and encoded using the given coder.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><X> <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><X></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withSchema-java.lang.Class-">withSchema</a></span>(java.lang.Class<X> clazz)</code> |
| <div class="block">Reads files containing records of the given class.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic">GenericRecord</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withSchema-org.apache.avro.Schema-">withSchema</a></span>(<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/Schema.html?is-external=true" title="class or interface in org.apache.avro">Schema</a> schema)</code> |
| <div class="block">Like <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withSchema-java.lang.String-"><code>withSchema(String)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic">GenericRecord</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withSchema-java.lang.String-">withSchema</a></span>(java.lang.String schema)</code> |
| <div class="block">Reads files containing records that conform to the given schema.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.io.FileBasedSource"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.sdk.io.<a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html" title="class in org.apache.beam.sdk.io">FileBasedSource</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#createReader-org.apache.beam.sdk.options.PipelineOptions-">createReader</a>, <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#createSourceForSubrange-long-long-">createSourceForSubrange</a>, <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#getEmptyMatchTreatment--">getEmptyMatchTreatment</a>, <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#getEstimatedSizeBytes-org.apache.beam.sdk.options.PipelineOptions-">getEstimatedSizeBytes</a>, <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#getFileOrPatternSpec--">getFileOrPatternSpec</a>, <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#getFileOrPatternSpecProvider--">getFileOrPatternSpecProvider</a>, <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#getMaxEndOffset-org.apache.beam.sdk.options.PipelineOptions-">getMaxEndOffset</a>, <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#getMode--">getMode</a>, <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#getSingleFileMetadata--">getSingleFileMetadata</a>, <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#isSplittable--">isSplittable</a>, <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#split-long-org.apache.beam.sdk.options.PipelineOptions-">split</a>, <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#toString--">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.io.OffsetBasedSource"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.sdk.io.<a href="../../../../../../../org/apache/beam/sdk/io/OffsetBasedSource.html" title="class in org.apache.beam.sdk.io">OffsetBasedSource</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/io/OffsetBasedSource.html#getBytesPerOffset--">getBytesPerOffset</a>, <a href="../../../../../../../org/apache/beam/sdk/io/OffsetBasedSource.html#getEndOffset--">getEndOffset</a>, <a href="../../../../../../../org/apache/beam/sdk/io/OffsetBasedSource.html#getMinBundleSize--">getMinBundleSize</a>, <a href="../../../../../../../org/apache/beam/sdk/io/OffsetBasedSource.html#getStartOffset--">getStartOffset</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.io.Source"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.sdk.io.<a href="../../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a></h3> |
| <code><a href="../../../../../../../org/apache/beam/sdk/io/Source.html#getDefaultOutputCoder--">getDefaultOutputCoder</a></code></li> |
| </ul> |
| <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, 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="from-org.apache.beam.sdk.options.ValueProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>from</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic">GenericRecord</a>> from(<a href="../../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> fileNameOrPattern)</pre> |
| <div class="block">Reads from the given file name or pattern ("glob"). The returned source needs to be further |
| configured by calling <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withSchema-java.lang.String-"><code>withSchema(java.lang.String)</code></a> to return a type other than <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic"><code>GenericRecord</code></a>.</div> |
| </li> |
| </ul> |
| <a name="from-org.apache.beam.sdk.io.fs.MatchResult.Metadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>from</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic">GenericRecord</a>> from(<a href="../../../../../../../org/apache/beam/sdk/io/fs/MatchResult.Metadata.html" title="class in org.apache.beam.sdk.io.fs">MatchResult.Metadata</a> metadata)</pre> |
| </li> |
| </ul> |
| <a name="from-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>from</h4> |
| <pre>public static <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic">GenericRecord</a>> from(java.lang.String fileNameOrPattern)</pre> |
| <div class="block">Like <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#from-org.apache.beam.sdk.options.ValueProvider-"><code>from(ValueProvider)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withEmptyMatchTreatment-org.apache.beam.sdk.io.fs.EmptyMatchTreatment-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withEmptyMatchTreatment</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>> withEmptyMatchTreatment(<a href="../../../../../../../org/apache/beam/sdk/io/fs/EmptyMatchTreatment.html" title="enum in org.apache.beam.sdk.io.fs">EmptyMatchTreatment</a> emptyMatchTreatment)</pre> |
| </li> |
| </ul> |
| <a name="withSchema-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withSchema</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic">GenericRecord</a>> withSchema(java.lang.String schema)</pre> |
| <div class="block">Reads files containing records that conform to the given schema.</div> |
| </li> |
| </ul> |
| <a name="withSchema-org.apache.avro.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withSchema</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic">GenericRecord</a>> withSchema(<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/Schema.html?is-external=true" title="class or interface in org.apache.avro">Schema</a> schema)</pre> |
| <div class="block">Like <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html#withSchema-java.lang.String-"><code>withSchema(String)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="withSchema-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withSchema</h4> |
| <pre>public <X> <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><X> withSchema(java.lang.Class<X> clazz)</pre> |
| <div class="block">Reads files containing records of the given class.</div> |
| </li> |
| </ul> |
| <a name="withParseFn-org.apache.beam.sdk.transforms.SerializableFunction-org.apache.beam.sdk.coders.Coder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withParseFn</h4> |
| <pre>public <X> <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><X> withParseFn(<a href="../../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic">GenericRecord</a>,X> parseFn, |
| <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><X> coder)</pre> |
| <div class="block">Reads <a href="https://static.javadoc.io/org.apache.avro/avro/1.8.2/org/apache/avro/generic/GenericRecord.html?is-external=true" title="class or interface in org.apache.avro.generic"><code>GenericRecord</code></a> of unspecified schema and maps them to instances of a custom type |
| using the given <code>parseFn</code> and encoded using the given coder.</div> |
| </li> |
| </ul> |
| <a name="withMinBundleSize-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMinBundleSize</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>> withMinBundleSize(long minBundleSize)</pre> |
| <div class="block">Sets the minimum bundle size. Refer to <a href="../../../../../../../org/apache/beam/sdk/io/OffsetBasedSource.html" title="class in org.apache.beam.sdk.io"><code>OffsetBasedSource</code></a> for a description of <code>minBundleSize</code> and its use.</div> |
| </li> |
| </ul> |
| <a name="withDatumReaderFactory-org.apache.beam.sdk.extensions.avro.io.AvroSource.DatumReaderFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDatumReaderFactory</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="class in org.apache.beam.sdk.extensions.avro.io">AvroSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>> withDatumReaderFactory(<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><?> factory)</pre> |
| </li> |
| </ul> |
| <a name="validate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>public void validate()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/beam/sdk/io/Source.html#validate--">Source</a></code></span></div> |
| <div class="block">Checks that this source is valid, before it can be used in a pipeline. |
| |
| <p>It is recommended to use <code>Preconditions</code> for implementing this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#validate--">validate</a></code> in class <code><a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html" title="class in org.apache.beam.sdk.io">FileBasedSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createForSubrangeOfFile-java.lang.String-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createForSubrangeOfFile</h4> |
| <pre>@Deprecated |
| public <a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.html" title="class in org.apache.beam.sdk.io">BlockBasedSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>> createForSubrangeOfFile(java.lang.String fileName, |
| long start, |
| long end) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Used by Dataflow worker</span></div> |
| <div class="block">Used by the Dataflow worker. Do not introduce new usages. Do not delete without confirming that |
| Dataflow ValidatesRunner tests pass.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createForSubrangeOfFile-org.apache.beam.sdk.io.fs.MatchResult.Metadata-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createForSubrangeOfFile</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.html" title="class in org.apache.beam.sdk.io">BlockBasedSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>> createForSubrangeOfFile(<a href="../../../../../../../org/apache/beam/sdk/io/fs/MatchResult.Metadata.html" title="class in org.apache.beam.sdk.io.fs">MatchResult.Metadata</a> fileMetadata, |
| long start, |
| long end)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.html#createForSubrangeOfFile-org.apache.beam.sdk.io.fs.MatchResult.Metadata-long-long-">BlockBasedSource</a></code></span></div> |
| <div class="block">Creates a <code>BlockBasedSource</code> for the specified range in a single file.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.html#createForSubrangeOfFile-org.apache.beam.sdk.io.fs.MatchResult.Metadata-long-long-">createForSubrangeOfFile</a></code> in class <code><a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.html" title="class in org.apache.beam.sdk.io">BlockBasedSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fileMetadata</code> - file backing the new <code>FileBasedSource</code>.</dd> |
| <dd><code>start</code> - starting byte offset of the new <code>FileBasedSource</code>.</dd> |
| <dd><code>end</code> - ending byte offset of the new <code>FileBasedSource</code>. May be Long.MAX_VALUE, in |
| which case it will be inferred using <a href="../../../../../../../org/apache/beam/sdk/io/FileBasedSource.html#getMaxEndOffset-org.apache.beam.sdk.options.PipelineOptions-"><code>FileBasedSource.getMaxEndOffset(org.apache.beam.sdk.options.PipelineOptions)</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createSingleFileReader-org.apache.beam.sdk.options.PipelineOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSingleFileReader</h4> |
| <pre>protected <a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.BlockBasedReader.html" title="class in org.apache.beam.sdk.io">BlockBasedSource.BlockBasedReader</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>> createSingleFileReader(<a href="../../../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.html#createSingleFileReader-org.apache.beam.sdk.options.PipelineOptions-">BlockBasedSource</a></code></span></div> |
| <div class="block">Creates a <code>BlockBasedReader</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.html#createSingleFileReader-org.apache.beam.sdk.options.PipelineOptions-">createSingleFileReader</a></code> in class <code><a href="../../../../../../../org/apache/beam/sdk/io/BlockBasedSource.html" title="class in org.apache.beam.sdk.io">BlockBasedSource</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOutputCoder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getOutputCoder</h4> |
| <pre>public <a href="../../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</a>> getOutputCoder()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../../org/apache/beam/sdk/io/Source.html#getOutputCoder--">Source</a></code></span></div> |
| <div class="block">Returns the <code>Coder</code> to use for the data read from this source.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/beam/sdk/io/Source.html#getOutputCoder--">getOutputCoder</a></code> in class <code><a href="../../../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a><<a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.html" title="type parameter in AvroSource">T</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/extensions/avro/io/AvroSink.DatumWriterFactory.html" title="interface in org.apache.beam.sdk.extensions.avro.io"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/beam/sdk/extensions/avro/io/AvroSource.AvroReader.html" title="class in org.apache.beam.sdk.extensions.avro.io"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/avro/io/AvroSource.html" target="_top">Frames</a></li> |
| <li><a href="AvroSource.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><a href="#nested.class.summary">Nested</a> | </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> |