org.apache.beam.sdk.extensions.avro.io

Class AvroIO.ReadFiles<T>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<FileIO.ReadableFile>,PCollection<T>>

org.apache.beam.sdk.extensions.avro.io.AvroIO.ReadFiles<T>

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

AvroIO

public abstract static class AvroIO.ReadFiles<T>
extends PTransform<PCollection<FileIO.ReadableFile>,PCollection<T>>

Implementation of AvroIO.readFiles(java.lang.Class<T>).

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor and Description
ReadFiles()

Method Summary

Modifier and Type	Method and Description
PCollection<T>	expand(PCollection<FileIO.ReadableFile> input) Override this method to specify how this PTransform should be expanded on the given InputT.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
AvroIO.ReadFiles<T>	withBeamSchemas(boolean withBeamSchemas) If set to true, a Beam schema will be inferred from the AVRO schema.
AvroIO.ReadFiles<T>	withCoder(Coder<T> coder) Sets a coder for the result of the read function.
AvroIO.ReadFiles<T>	withDatumReaderFactory(AvroSource.DatumReaderFactory<T> factory) Sets a custom AvroSource.DatumReaderFactory for reading.
AvroIO.ReadFiles<T>	withDesiredBundleSizeBytes(long desiredBundleSizeBytes) Set a value for the bundle size for parallel reads.
AvroIO.ReadFiles<T>	withFileExceptionHandler(ReadAllViaFileBasedSource.ReadFileRangesFnExceptionHandler exceptionHandler) Specifies if exceptions should be logged only for streaming pipelines.
AvroIO.ReadFiles<T>	withUsesReshuffle(boolean usesReshuffle) Specifies if a Reshuffle should run before file reads occur.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setDisplayData, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReadFiles

public ReadFiles()

Method Detail

withDesiredBundleSizeBytes

public AvroIO.ReadFiles<T> withDesiredBundleSizeBytes(long desiredBundleSizeBytes)

Set a value for the bundle size for parallel reads. Default is 64 MB. You may want to use a lower value (e.g. 1 MB) for streaming applications.

withUsesReshuffle

public AvroIO.ReadFiles<T> withUsesReshuffle(boolean usesReshuffle)

Specifies if a Reshuffle should run before file reads occur.

withFileExceptionHandler

public AvroIO.ReadFiles<T> withFileExceptionHandler(ReadAllViaFileBasedSource.ReadFileRangesFnExceptionHandler exceptionHandler)

Specifies if exceptions should be logged only for streaming pipelines.

withBeamSchemas

public AvroIO.ReadFiles<T> withBeamSchemas(boolean withBeamSchemas)

If set to true, a Beam schema will be inferred from the AVRO schema. This allows the output to be used by SQL and by the schema-transform library.

withCoder

public AvroIO.ReadFiles<T> withCoder(Coder<T> coder)

Sets a coder for the result of the read function.

withDatumReaderFactory

public AvroIO.ReadFiles<T> withDatumReaderFactory(AvroSource.DatumReaderFactory<T> factory)

Sets a custom AvroSource.DatumReaderFactory for reading. Pass a AvroDatumFactory to also use the factory for the default output AvroCoder

expand

public PCollection<T> expand(PCollection<FileIO.ReadableFile> input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

expand in class PTransform<PCollection<FileIO.ReadableFile>,PCollection<T>>

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: PTransform

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class PTransform<PCollection<FileIO.ReadableFile>,PCollection<T>>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData