com.google.cloud.dataflow.sdk.io

Class TextIO.Read.Bound<T>

java.lang.Object

com.google.cloud.dataflow.sdk.transforms.PTransform<PInput,PCollection<T>>

com.google.cloud.dataflow.sdk.io.TextIO.Read.Bound<T>

Type Parameters:

T - the type of each of the elements of the resulting PCollection, decoded from the lines of the text file

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

TextIO.Read

public static class TextIO.Read.Bound<T>
extends PTransform<PInput,PCollection<T>>

A root PTransform that reads from a text file (or multiple text files matching a pattern) and returns a bounded PCollection containing the decoding of each of the lines of the text file(s). The default decoding just returns the lines.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.google.cloud.dataflow.sdk.transforms.PTransform

name

Method Summary

Methods

Modifier and Type	Method and Description
PCollection<T>	apply(PInput input) Applies this PTransform on the given Input, and returns its Output.
TextIO.Read.Bound<T>	from(java.lang.String filepattern) Returns a new TextIO.Read PTransform that's like this one but that reads from the file(s) with the given name or pattern.
TextIO.CompressionType	getCompressionType()
protected Coder<T>	getDefaultOutputCoder() Returns the default Coder to use for the output of this single-output PTransform, or null if none can be inferred.
java.lang.String	getFilepattern()
protected java.lang.String	getKindString() Returns a string describing what kind of PTransform this is.
TextIO.Read.Bound<T>	named(java.lang.String name) Returns a new TextIO.Read PTransform that's like this one but with the given step name.
boolean	needsValidation()
<T1> TextIO.Read.Bound<T1>	withCoder(Coder<T1> coder) Returns a new TextIO.Read PTransform that's like this one but that uses the given Coder<T1> to decode each of the lines of the file into a value of type T1.
TextIO.Read.Bound<T>	withCompressionType(TextIO.CompressionType compressionType) Returns a new TextIO.Read PTransform that's like this one but reads from input sources using the specified compression type.
TextIO.Read.Bound<T>	withoutValidation() Returns a new TextIO.Read PTransform that's like this one but that has GCS path validation on pipeline creation disabled.

Methods inherited from class com.google.cloud.dataflow.sdk.transforms.PTransform

finishSpecifying, getCoderRegistry, getDefaultName, getDefaultOutputCoder, getInput, getName, getOutput, getPipeline, setName, setPipeline, toString, withName

Methods inherited from class java.lang.Object

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

Method Detail

named

public TextIO.Read.Bound<T> named(java.lang.String name)

Returns a new TextIO.Read PTransform that's like this one but with the given step name. Does not modify this object.

from

public TextIO.Read.Bound<T> from(java.lang.String filepattern)

Returns a new TextIO.Read PTransform that's like this one but that reads from the file(s) with the given name or pattern. (See TextIO.Read.from(java.lang.String) for a description of filepatterns.) Does not modify this object.

withCoder

public <T1> TextIO.Read.Bound<T1> withCoder(Coder<T1> coder)

Returns a new TextIO.Read PTransform that's like this one but that uses the given Coder<T1> to decode each of the lines of the file into a value of type T1. Does not modify this object.

Type Parameters:

T1 - the type of the decoded elements, and the elements of the resulting PCollection

withoutValidation

public TextIO.Read.Bound<T> withoutValidation()

Returns a new TextIO.Read PTransform that's like this one but that has GCS path validation on pipeline creation disabled. Does not modify this object.

This can be useful in the case where the GCS input does not exist at the pipeline creation time, but is expected to be available at execution time.

withCompressionType

public TextIO.Read.Bound<T> withCompressionType(TextIO.CompressionType compressionType)

Returns a new TextIO.Read PTransform that's like this one but reads from input sources using the specified compression type. Does not modify this object.

If AUTO compression type is specified, a compression type is selected on a per-file basis, based on the file's extension (e.g., .gz will be processed as a gzipped file, .bz will be processed as a bzipped file, other extensions with be treated as uncompressed input).

If no compression type is specified, the default is AUTO.

apply

public PCollection<T> apply(PInput input)

Description copied from class: PTransform

Applies this PTransform on the given Input, and returns its Output.

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).

The default implementation throws an exception. A derived class must either implement apply, or else each runner must supply a custom implementation via PipelineRunner.apply(com.google.cloud.dataflow.sdk.transforms.PTransform<Input, Output>, Input).

Overrides:

apply in class PTransform<PInput,PCollection<T>>

getDefaultOutputCoder

protected Coder<T> getDefaultOutputCoder()

Description copied from class: PTransform

Returns the default Coder to use for the output of this single-output PTransform, or null if none can be inferred.

By default, returns null.

Overrides:

getDefaultOutputCoder in class PTransform<PInput,PCollection<T>>

getKindString

protected java.lang.String getKindString()

Description copied from class: PTransform

Returns a string describing what kind of PTransform this is.

By default, returns the base name of this PTransform's class.

Overrides:

getKindString in class PTransform<PInput,PCollection<T>>

getFilepattern

public java.lang.String getFilepattern()

needsValidation

public boolean needsValidation()

getCompressionType

public TextIO.CompressionType getCompressionType()