com.google.cloud.dataflow.sdk.transforms

Class ParDo.Bound<I,O>

java.lang.Object

com.google.cloud.dataflow.sdk.transforms.PTransform<PCollection<? extends I>,PCollection<O>>

com.google.cloud.dataflow.sdk.transforms.ParDo.Bound<I,O>

Type Parameters:

I - the type of the (main) input PCollection elements

O - the type of the (main) output PCollection elements

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

ParDo

public static class ParDo.Bound<I,O>
extends PTransform<PCollection<? extends I>,PCollection<O>>

A PTransform that, when applied to a PCollection<I>, invokes a user-specified DoFn<I, O> on all its elements, with all its outputs collected into an output PCollection<O>.

A multi-output form of this transform can be created with withOutputTags(com.google.cloud.dataflow.sdk.values.TupleTag<O>, com.google.cloud.dataflow.sdk.values.TupleTagList).

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<O>	apply(PCollection<? extends I> input) Applies this PTransform on the given Input, and returns its Output.
protected java.lang.String	getDefaultName() Returns the name to use by default for this PTransform (not including the names of any enclosing PTransforms).
protected Coder<O>	getDefaultOutputCoder() Returns the default Coder to use for the output of this single-output PTransform, or null if none can be inferred.
DoFn<I,O>	getFn()
protected java.lang.String	getKindString() Returns a string describing what kind of PTransform this is.
java.util.List<PCollectionView<?,?>>	getSideInputs()
ParDo.Bound<I,O>	named(java.lang.String name) Returns a new ParDo PTransform that's like this PTransform but with the specified name.
ParDo.BoundMulti<I,O>	withOutputTags(TupleTag<O> mainOutputTag, TupleTagList sideOutputTags) Returns a new multi-output ParDo PTransform that's like this PTransform but with the specified main and side output tags.
ParDo.Bound<I,O>	withSideInputs(java.lang.Iterable<? extends PCollectionView<?,?>> sideInputs) Returns a new ParDo PTransform that's like this PTransform but with the specified side inputs.
ParDo.Bound<I,O>	withSideInputs(PCollectionView<?,?>... sideInputs) Returns a new ParDo PTransform that's like this PTransform but with the specified side inputs.

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

finishSpecifying, getCoderRegistry, 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 ParDo.Bound<I,O> named(java.lang.String name)

Returns a new ParDo PTransform that's like this PTransform but with the specified name. Does not modify this PTransform.

See the discussion of Naming above for more explanation.

withSideInputs

public ParDo.Bound<I,O> withSideInputs(PCollectionView<?,?>... sideInputs)

Returns a new ParDo PTransform that's like this PTransform but with the specified side inputs. Does not modify this PTransform.

See the discussion of Side Inputs above and on ParDo.withSideInputs(com.google.cloud.dataflow.sdk.values.PCollectionView<?, ?>...) for more explanation.

withSideInputs

public ParDo.Bound<I,O> withSideInputs(java.lang.Iterable<? extends PCollectionView<?,?>> sideInputs)

Returns a new ParDo PTransform that's like this PTransform but with the specified side inputs. Does not modify this PTransform.

See the discussion of Side Inputs above and on ParDo.withSideInputs(com.google.cloud.dataflow.sdk.values.PCollectionView<?, ?>...) for more explanation.

withOutputTags

public ParDo.BoundMulti<I,O> withOutputTags(TupleTag<O> mainOutputTag,
                                   TupleTagList sideOutputTags)

Returns a new multi-output ParDo PTransform that's like this PTransform but with the specified main and side output tags. Does not modify this PTransform.

See the discussion of Side Outputs above and on ParDo.withOutputTags(com.google.cloud.dataflow.sdk.values.TupleTag<O>, com.google.cloud.dataflow.sdk.values.TupleTagList) for more explanation.

apply

public PCollection<O> apply(PCollection<? extends I> 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<PCollection<? extends I>,PCollection<O>>

getDefaultOutputCoder

protected Coder<O> 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<PCollection<? extends I>,PCollection<O>>

getDefaultName

protected java.lang.String getDefaultName()

Description copied from class: PTransform

Returns the name to use by default for this PTransform (not including the names of any enclosing PTransforms).

By default, returns PTransform.getKindString().

The caller is responsible for ensuring that names of applied PTransforms are unique, e.g., by adding a uniquifying suffix when needed.

Overrides:

getDefaultName in class PTransform<PCollection<? extends I>,PCollection<O>>

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<PCollection<? extends I>,PCollection<O>>

getFn

public DoFn<I,O> getFn()

getSideInputs

public java.util.List<PCollectionView<?,?>> getSideInputs()