| <!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 (1.8.0_161-google-v7) on Thu Oct 18 16:14:37 PDT 2018 --> |
| <title>org.apache.beam.sdk.io (Apache Beam 2.8.0-SNAPSHOT)</title> |
| <meta name="date" content="2018-10-18"> |
| <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.io (Apache Beam 2.8.0-SNAPSHOT)"; |
| } |
| } |
| 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/fn/windowing/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/io/amqp/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/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=edu.umd.cs.findbugs.annotations.NonNull.class) |
| </p> |
| <h1 title="Package" class="title">Package org.apache.beam.sdk.io</h1> |
| <div class="docSummary"> |
| <div class="block">Defines transforms for reading and writing common storage formats, including <a href="../../../../../org/apache/beam/sdk/io/AvroIO.html" title="class in org.apache.beam.sdk.io"><code>AvroIO</code></a>, and <a href="../../../../../org/apache/beam/sdk/io/TextIO.html" title="class in org.apache.beam.sdk.io"><code>TextIO</code></a>.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="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/io/AvroIO.RecordFormatter.html" title="interface in org.apache.beam.sdk.io">AvroIO.RecordFormatter</a><ElementT></td> |
| <td class="colLast"> |
| <div class="block">Formats an element of a user type into a record with the given schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/CompressedSource.DecompressingChannelFactory.html" title="interface in org.apache.beam.sdk.io">CompressedSource.DecompressingChannelFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory interface for creating channels that decompress the content of an underlying channel.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.OutputFileHints.html" title="interface in org.apache.beam.sdk.io">FileBasedSink.OutputFileHints</a></td> |
| <td class="colLast"> |
| <div class="block">Provides hints about how to generate output files, such as a suggested filename suffix (e.g.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.WritableByteChannelFactory.html" title="interface in org.apache.beam.sdk.io">FileBasedSink.WritableByteChannelFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Implementations create instances of <code>WritableByteChannel</code> used by <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink</code></a> |
| and related classes to allow <em>decorating</em>, or otherwise transforming, the raw data that |
| would normally be written directly to the <code>WritableByteChannel</code> passed into <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.WritableByteChannelFactory.html#create-java.nio.channels.WritableByteChannel-"><code>FileBasedSink.WritableByteChannelFactory.create(WritableByteChannel)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileIO.Sink.html" title="interface in org.apache.beam.sdk.io">FileIO.Sink</a><ElementT></td> |
| <td class="colLast"> |
| <div class="block">Specifies how to write elements to individual files in <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#write--"><code>FileIO.write()</code></a> and <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#writeDynamic--"><code>FileIO.writeDynamic()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileIO.Write.FileNaming.html" title="interface in org.apache.beam.sdk.io">FileIO.Write.FileNaming</a></td> |
| <td class="colLast"> |
| <div class="block">A policy for generating names for shard files.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileSystemRegistrar.html" title="interface in org.apache.beam.sdk.io">FileSystemRegistrar</a></td> |
| <td class="colLast"> |
| <div class="block">A registrar that creates <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="class in org.apache.beam.sdk.io"><code>FileSystem</code></a> instances from <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a></td> |
| <td class="colLast"> |
| <div class="block">A marker representing the progress and state of an <a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource.UnboundedReader</code></a>.</div> |
| </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/io/AvroIO.html" title="class in org.apache.beam.sdk.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/io/AvroIO.Parse.html" title="class in org.apache.beam.sdk.io">AvroIO.Parse</a><T></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/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/io/AvroIO.ParseAll.html" title="class in org.apache.beam.sdk.io">AvroIO.ParseAll</a><T></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/AvroIO.html#parseAllGenericRecords-org.apache.beam.sdk.transforms.SerializableFunction-"><code>AvroIO.parseAllGenericRecords(org.apache.beam.sdk.transforms.SerializableFunction<org.apache.avro.generic.GenericRecord, T>)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/AvroIO.Read.html" title="class in org.apache.beam.sdk.io">AvroIO.Read</a><T></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/AvroIO.html#read-java.lang.Class-"><code>AvroIO.read(java.lang.Class<T>)</code></a> and <a href="../../../../../org/apache/beam/sdk/io/AvroIO.html#readGenericRecords-org.apache.avro.Schema-"><code>AvroIO.readGenericRecords(org.apache.avro.Schema)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/AvroIO.ReadAll.html" title="class in org.apache.beam.sdk.io">AvroIO.ReadAll</a><T></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/AvroIO.html#readAll-java.lang.Class-"><code>AvroIO.readAll(java.lang.Class<T>)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/AvroIO.Sink.html" title="class in org.apache.beam.sdk.io">AvroIO.Sink</a><ElementT></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/AvroIO.html#sink-java.lang.Class-"><code>AvroIO.sink(java.lang.Class<ElementT>)</code></a> and <a href="../../../../../org/apache/beam/sdk/io/AvroIO.html#sinkViaGenericRecords-org.apache.avro.Schema-org.apache.beam.sdk.io.AvroIO.RecordFormatter-"><code>AvroIO.sinkViaGenericRecords(org.apache.avro.Schema, org.apache.beam.sdk.io.AvroIO.RecordFormatter<ElementT>)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/AvroIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">AvroIO.TypedWrite</a><UserT,DestinationT,OutputT></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/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/io/AvroIO.Write.html" title="class in org.apache.beam.sdk.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/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/io/AvroSource.html" title="class in org.apache.beam.sdk.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/io/AvroIO.Read.html" title="class in org.apache.beam.sdk.io"><code>AvroIO.Read</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/AvroSource.AvroReader.html" title="class in org.apache.beam.sdk.io">AvroSource.AvroReader</a><T></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/io/BlockBasedSource.BlockBasedReader.html" title="class in org.apache.beam.sdk.io"><code>BlockBasedSource.BlockBasedReader</code></a> for reading blocks from Avro files.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/BlockBasedSource.html" title="class in org.apache.beam.sdk.io">BlockBasedSource</a><T></td> |
| <td class="colLast"> |
| <div class="block">A <code>BlockBasedSource</code> is a <a href="../../../../../org/apache/beam/sdk/io/FileBasedSource.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSource</code></a> where a file consists of blocks of |
| records.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/BlockBasedSource.Block.html" title="class in org.apache.beam.sdk.io">BlockBasedSource.Block</a><T></td> |
| <td class="colLast"> |
| <div class="block">A <code>Block</code> represents a block of records that can be read.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/BlockBasedSource.BlockBasedReader.html" title="class in org.apache.beam.sdk.io">BlockBasedSource.BlockBasedReader</a><T></td> |
| <td class="colLast"> |
| <div class="block">A <code>Reader</code> that reads records from a <a href="../../../../../org/apache/beam/sdk/io/BlockBasedSource.html" title="class in org.apache.beam.sdk.io"><code>BlockBasedSource</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/BoundedReadFromUnboundedSource.html" title="class in org.apache.beam.sdk.io">BoundedReadFromUnboundedSource</a><T></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> that reads a bounded amount of data from an <a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource</code></a>, specified |
| as one or both of a maximum number of elements or a maximum period of time to read.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io">BoundedSource</a><T></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io"><code>Source</code></a> that reads a finite amount of input and, because of that, supports some |
| additional operations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/BoundedSource.BoundedReader.html" title="class in org.apache.beam.sdk.io">BoundedSource.BoundedReader</a><T></td> |
| <td class="colLast"> |
| <div class="block">A <code>Reader</code> that reads a bounded amount of input and supports some additional operations, |
| such as progress estimation and dynamic work rebalancing.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/CompressedSource.html" title="class in org.apache.beam.sdk.io">CompressedSource</a><T></td> |
| <td class="colLast"> |
| <div class="block">A Source that reads from compressed files.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/CompressedSource.CompressedReader.html" title="class in org.apache.beam.sdk.io">CompressedSource.CompressedReader</a><T></td> |
| <td class="colLast"> |
| <div class="block">Reader for a <a href="../../../../../org/apache/beam/sdk/io/CompressedSource.html" title="class in org.apache.beam.sdk.io"><code>CompressedSource</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/CountingSource.html" title="class in org.apache.beam.sdk.io">CountingSource</a></td> |
| <td class="colLast"> |
| <div class="block">Most users should use <a href="../../../../../org/apache/beam/sdk/io/GenerateSequence.html" title="class in org.apache.beam.sdk.io"><code>GenerateSequence</code></a> instead.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/CountingSource.CounterMark.html" title="class in org.apache.beam.sdk.io">CountingSource.CounterMark</a></td> |
| <td class="colLast"> |
| <div class="block">The checkpoint for an unbounded <a href="../../../../../org/apache/beam/sdk/io/CountingSource.html" title="class in org.apache.beam.sdk.io"><code>CountingSource</code></a> is simply the last value produced.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy</a></td> |
| <td class="colLast"> |
| <div class="block">A default <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink.FilenamePolicy</code></a> for windowed and unwindowed files.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy.Params</a></td> |
| <td class="colLast"> |
| <div class="block">Encapsulates constructor parameters to <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.ParamsCoder.html" title="class in org.apache.beam.sdk.io">DefaultFilenamePolicy.ParamsCoder</a></td> |
| <td class="colLast"> |
| <div class="block">A Coder for <a href="../../../../../org/apache/beam/sdk/io/DefaultFilenamePolicy.Params.html" title="class in org.apache.beam.sdk.io"><code>DefaultFilenamePolicy.Params</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/DynamicAvroDestinations.html" title="class in org.apache.beam.sdk.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/io/AvroIO.html" title="class in org.apache.beam.sdk.io"><code>AvroIO</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/DynamicFileDestinations.html" title="class in org.apache.beam.sdk.io">DynamicFileDestinations</a></td> |
| <td class="colLast"> |
| <div class="block">Some helper classes that derive from <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink.DynamicDestinations</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.html" title="class in org.apache.beam.sdk.io">FileBasedSink</a><UserT,DestinationT,OutputT></td> |
| <td class="colLast"> |
| <div class="block">Abstract class for file-based output.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.DynamicDestinations.html" title="class in org.apache.beam.sdk.io">FileBasedSink.DynamicDestinations</a><UserT,DestinationT,OutputT></td> |
| <td class="colLast"> |
| <div class="block">A class that allows value-dependent writes in <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FilenamePolicy.html" title="class in org.apache.beam.sdk.io">FileBasedSink.FilenamePolicy</a></td> |
| <td class="colLast"> |
| <div class="block">A naming policy for output files.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FileResult.html" title="class in org.apache.beam.sdk.io">FileBasedSink.FileResult</a><DestinationT></td> |
| <td class="colLast"> |
| <div class="block">Result of a single bundle write.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FileResultCoder.html" title="class in org.apache.beam.sdk.io">FileBasedSink.FileResultCoder</a><DestinationT></td> |
| <td class="colLast"> |
| <div class="block">A coder for <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.FileResult.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink.FileResult</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.WriteOperation.html" title="class in org.apache.beam.sdk.io">FileBasedSink.WriteOperation</a><DestinationT,OutputT></td> |
| <td class="colLast"> |
| <div class="block">Abstract operation that manages the process of writing to <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.Writer.html" title="class in org.apache.beam.sdk.io">FileBasedSink.Writer</a><DestinationT,OutputT></td> |
| <td class="colLast"> |
| <div class="block">Abstract writer that writes a bundle to a <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSource.html" title="class in org.apache.beam.sdk.io">FileBasedSource</a><T></td> |
| <td class="colLast"> |
| <div class="block">A common base class for all file-based <a href="../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io"><code>Source</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSource.FileBasedReader.html" title="class in org.apache.beam.sdk.io">FileBasedSource.FileBasedReader</a><T></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/io/Source.Reader.html" title="class in org.apache.beam.sdk.io"><code>reader</code></a> that implements code common to readers of <code>FileBasedSource</code>s.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileIO.html" title="class in org.apache.beam.sdk.io">FileIO</a></td> |
| <td class="colLast"> |
| <div class="block">General-purpose transforms for working with files: listing files (matching), reading and writing.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileIO.Match.html" title="class in org.apache.beam.sdk.io">FileIO.Match</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#match--"><code>FileIO.match()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileIO.MatchAll.html" title="class in org.apache.beam.sdk.io">FileIO.MatchAll</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#matchAll--"><code>FileIO.matchAll()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileIO.MatchConfiguration.html" title="class in org.apache.beam.sdk.io">FileIO.MatchConfiguration</a></td> |
| <td class="colLast"> |
| <div class="block">Describes configuration for matching filepatterns, such as <a href="../../../../../org/apache/beam/sdk/io/fs/EmptyMatchTreatment.html" title="enum in org.apache.beam.sdk.io.fs"><code>EmptyMatchTreatment</code></a> and |
| continuous watching for matching files.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileIO.ReadableFile.html" title="class in org.apache.beam.sdk.io">FileIO.ReadableFile</a></td> |
| <td class="colLast"> |
| <div class="block">A utility class for accessing a potentially compressed file.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileIO.ReadMatches.html" title="class in org.apache.beam.sdk.io">FileIO.ReadMatches</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#readMatches--"><code>FileIO.readMatches()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileIO.Write.html" title="class in org.apache.beam.sdk.io">FileIO.Write</a><DestinationT,UserT></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#write--"><code>FileIO.write()</code></a> and <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#writeDynamic--"><code>FileIO.writeDynamic()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="class in org.apache.beam.sdk.io">FileSystem</a><ResourceIdT extends <a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs">ResourceId</a>></td> |
| <td class="colLast"> |
| <div class="block">File system interface in Beam.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileSystems.html" title="class in org.apache.beam.sdk.io">FileSystems</a></td> |
| <td class="colLast"> |
| <div class="block">Clients facing <a href="../../../../../org/apache/beam/sdk/io/FileSystem.html" title="class in org.apache.beam.sdk.io"><code>FileSystem</code></a> utility.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/GenerateSequence.html" title="class in org.apache.beam.sdk.io">GenerateSequence</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that produces longs starting from the given value, and either up to the |
| given limit or until <code>Long.MAX_VALUE</code> / until the given time elapses.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/LocalFileSystemRegistrar.html" title="class in org.apache.beam.sdk.io">LocalFileSystemRegistrar</a></td> |
| <td class="colLast"> |
| <div class="block"><code>AutoService</code> registrar for the <code>LocalFileSystem</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/LocalResources.html" title="class in org.apache.beam.sdk.io">LocalResources</a></td> |
| <td class="colLast"> |
| <div class="block">Helper functions for producing a <a href="../../../../../org/apache/beam/sdk/io/fs/ResourceId.html" title="interface in org.apache.beam.sdk.io.fs"><code>ResourceId</code></a> that references a local file or directory.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/OffsetBasedSource.html" title="class in org.apache.beam.sdk.io">OffsetBasedSource</a><T></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io"><code>BoundedSource</code></a> that uses offsets to define starting and ending positions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/OffsetBasedSource.OffsetBasedReader.html" title="class in org.apache.beam.sdk.io">OffsetBasedSource.OffsetBasedReader</a><T></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/io/Source.Reader.html" title="class in org.apache.beam.sdk.io"><code>Source.Reader</code></a> that implements code common to readers of all <a href="../../../../../org/apache/beam/sdk/io/OffsetBasedSource.html" title="class in org.apache.beam.sdk.io"><code>OffsetBasedSource</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/Read.html" title="class in org.apache.beam.sdk.io">Read</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> for reading from a <a href="../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io"><code>Source</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/Read.Bounded.html" title="class in org.apache.beam.sdk.io">Read.Bounded</a><T></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> that reads from a <a href="../../../../../org/apache/beam/sdk/io/BoundedSource.html" title="class in org.apache.beam.sdk.io"><code>BoundedSource</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/Read.Builder.html" title="class in org.apache.beam.sdk.io">Read.Builder</a></td> |
| <td class="colLast"> |
| <div class="block">Helper class for building <a href="../../../../../org/apache/beam/sdk/io/Read.html" title="class in org.apache.beam.sdk.io"><code>Read</code></a> transforms.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/Read.Unbounded.html" title="class in org.apache.beam.sdk.io">Read.Unbounded</a><T></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> that reads from a <a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.html" title="class in org.apache.beam.sdk.io"><code>UnboundedSource</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/ReadableFileCoder.html" title="class in org.apache.beam.sdk.io">ReadableFileCoder</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for <a href="../../../../../org/apache/beam/sdk/io/FileIO.ReadableFile.html" title="class in org.apache.beam.sdk.io"><code>FileIO.ReadableFile</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/ReadAllViaFileBasedSource.html" title="class in org.apache.beam.sdk.io">ReadAllViaFileBasedSource</a><T></td> |
| <td class="colLast"> |
| <div class="block">Reads each file in the input <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of <a href="../../../../../org/apache/beam/sdk/io/FileIO.ReadableFile.html" title="class in org.apache.beam.sdk.io"><code>FileIO.ReadableFile</code></a> using given parameters |
| for splitting files into offset ranges and for creating a <a href="../../../../../org/apache/beam/sdk/io/FileBasedSource.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSource</code></a> for a file.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/ShardNameTemplate.html" title="class in org.apache.beam.sdk.io">ShardNameTemplate</a></td> |
| <td class="colLast"> |
| <div class="block">Standard shard naming templates.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io">Source</a><T></td> |
| <td class="colLast"> |
| <div class="block">Base class for defining input formats and creating a <code>Source</code> for reading the input.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/Source.Reader.html" title="class in org.apache.beam.sdk.io">Source.Reader</a><T></td> |
| <td class="colLast"> |
| <div class="block">The interface that readers of custom input sources must implement.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TextIO.html" title="class in org.apache.beam.sdk.io">TextIO</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 text files.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TextIO.Read.html" title="class in org.apache.beam.sdk.io">TextIO.Read</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#read--"><code>TextIO.read()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TextIO.ReadAll.html" title="class in org.apache.beam.sdk.io">TextIO.ReadAll</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#readAll--"><code>TextIO.readAll()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TextIO.ReadFiles.html" title="class in org.apache.beam.sdk.io">TextIO.ReadFiles</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#readFiles--"><code>TextIO.readFiles()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TextIO.Sink.html" title="class in org.apache.beam.sdk.io">TextIO.Sink</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#sink--"><code>TextIO.sink()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TextIO.TypedWrite.html" title="class in org.apache.beam.sdk.io">TextIO.TypedWrite</a><UserT,DestinationT></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#write--"><code>TextIO.write()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TextIO.Write.html" title="class in org.apache.beam.sdk.io">TextIO.Write</a></td> |
| <td class="colLast"> |
| <div class="block">This class is used as the default return value of <a href="../../../../../org/apache/beam/sdk/io/TextIO.html#write--"><code>TextIO.write()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TFRecordIO.html" title="class in org.apache.beam.sdk.io">TFRecordIO</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 TensorFlow TFRecord files.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TFRecordIO.Read.html" title="class in org.apache.beam.sdk.io">TFRecordIO.Read</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/TFRecordIO.html#read--"><code>TFRecordIO.read()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TFRecordIO.Sink.html" title="class in org.apache.beam.sdk.io">TFRecordIO.Sink</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/io/FileIO.Sink.html" title="interface in org.apache.beam.sdk.io"><code>FileIO.Sink</code></a> for use with <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#write--"><code>FileIO.write()</code></a> and <a href="../../../../../org/apache/beam/sdk/io/FileIO.html#writeDynamic--"><code>FileIO.writeDynamic()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TFRecordIO.Write.html" title="class in org.apache.beam.sdk.io">TFRecordIO.Write</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/sdk/io/TFRecordIO.html#write--"><code>TFRecordIO.write()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.html" title="class in org.apache.beam.sdk.io">UnboundedSource</a><OutputT,CheckpointMarkT extends <a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.html" title="interface in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark</a>></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/io/Source.html" title="class in org.apache.beam.sdk.io"><code>Source</code></a> that reads an unbounded amount of input and, because of that, supports some |
| additional operations such as checkpointing, watermarks, and record ids.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.CheckpointMark.NoopCheckpointMark.html" title="class in org.apache.beam.sdk.io">UnboundedSource.CheckpointMark.NoopCheckpointMark</a></td> |
| <td class="colLast"> |
| <div class="block">A checkpoint mark that does nothing when finalized.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/UnboundedSource.UnboundedReader.html" title="class in org.apache.beam.sdk.io">UnboundedSource.UnboundedReader</a><OutputT></td> |
| <td class="colLast"> |
| <div class="block">A <code>Reader</code> that reads an unbounded amount of input.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/WriteFiles.html" title="class in org.apache.beam.sdk.io">WriteFiles</a><UserT,DestinationT,OutputT></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that writes to a <a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.html" title="class in org.apache.beam.sdk.io"><code>FileBasedSink</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/WriteFilesResult.html" title="class in org.apache.beam.sdk.io">WriteFilesResult</a><DestinationT></td> |
| <td class="colLast"> |
| <div class="block">The result of a <a href="../../../../../org/apache/beam/sdk/io/WriteFiles.html" title="class in org.apache.beam.sdk.io"><code>WriteFiles</code></a> transform.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/CompressedSource.CompressionMode.html" title="enum in org.apache.beam.sdk.io">CompressedSource.CompressionMode</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io"><code>Compression</code></a> instead</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io">Compression</a></td> |
| <td class="colLast"> |
| <div class="block">Various compression types for reading/writing files.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSink.CompressionType.html" title="enum in org.apache.beam.sdk.io">FileBasedSink.CompressionType</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">use <a href="../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io"><code>Compression</code></a>.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/FileBasedSource.Mode.html" title="enum in org.apache.beam.sdk.io">FileBasedSource.Mode</a></td> |
| <td class="colLast"> |
| <div class="block">A given <code>FileBasedSource</code> represents a file resource of one of these types.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TextIO.CompressionType.html" title="enum in org.apache.beam.sdk.io">TextIO.CompressionType</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io"><code>Compression</code></a>.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/sdk/io/TFRecordIO.CompressionType.html" title="enum in org.apache.beam.sdk.io">TFRecordIO.CompressionType</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../../org/apache/beam/sdk/io/Compression.html" title="enum in org.apache.beam.sdk.io"><code>Compression</code></a>.</span></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.beam.sdk.io Description">Package org.apache.beam.sdk.io Description</h2> |
| <div class="block">Defines transforms for reading and writing common storage formats, including <a href="../../../../../org/apache/beam/sdk/io/AvroIO.html" title="class in org.apache.beam.sdk.io"><code>AvroIO</code></a>, and <a href="../../../../../org/apache/beam/sdk/io/TextIO.html" title="class in org.apache.beam.sdk.io"><code>TextIO</code></a>. |
| |
| <p>The classes in this package provide <code>Read</code> transforms that create PCollections from |
| existing storage: |
| |
| <pre><code> |
| PCollection<TableRow> inputData = pipeline.apply( |
| BigQueryIO.readTableRows().from("clouddataflow-readonly:samples.weather_stations")); |
| </code></pre> |
| |
| and <code>Write</code> transforms that persist PCollections to external storage: |
| |
| <pre><code> |
| PCollection<Integer> numbers = ...; |
| numbers.apply(TextIO.write().to("gs://my_bucket/path/to/numbers")); |
| </code></pre></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/fn/windowing/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/io/amqp/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/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> |