Google Cloud Dataflow SDK for Java, version 1.9.1
Class ParDo.BoundMulti<InputT,OutputT>
- java.lang.Object
-
- com.google.cloud.dataflow.sdk.transforms.PTransform<PCollection<? extends InputT>,PCollectionTuple>
-
- com.google.cloud.dataflow.sdk.transforms.ParDo.BoundMulti<InputT,OutputT>
-
- Type Parameters:
InputT
- the type of the (main) inputPCollection
elementsOutputT
- the type of the main outputPCollection
elements
- All Implemented Interfaces:
- HasDisplayData, Serializable
- Enclosing class:
- ParDo
public static class ParDo.BoundMulti<InputT,OutputT> extends PTransform<PCollection<? extends InputT>,PCollectionTuple>
APTransform
that, when applied to aPCollection<InputT>
, invokes a user-specifiedDoFn<InputT, OutputT>
on all its elements, which can emit elements to any of thePTransform
's main and side outputPCollection
s, which are bundled into a resultPCollectionTuple
.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.google.cloud.dataflow.sdk.transforms.PTransform
name
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description PCollectionTuple
apply(PCollection<? extends InputT> input)
Applies thisPTransform
on the givenInputT
, and returns itsOutput
.protected Coder<OutputT>
getDefaultOutputCoder()
Returns the defaultCoder
to use for the output of this single-outputPTransform
.<T> Coder<T>
getDefaultOutputCoder(PCollection<? extends InputT> input, TypedPValue<T> output)
Returns the defaultCoder
to use for the given output of this single-outputPTransform
when applied to the given input.DoFn<InputT,OutputT>
getFn()
protected String
getKindString()
Returns the name to use by default for thisPTransform
(not including the names of any enclosingPTransform
s).TupleTag<OutputT>
getMainOutputTag()
List<PCollectionView<?>>
getSideInputs()
TupleTagList
getSideOutputTags()
ParDo.BoundMulti<InputT,OutputT>
named(String name)
Returns a new multi-outputParDo
PTransform
that's like thisPTransform
but with the specified name.void
populateDisplayData(DisplayData.Builder builder)
Register display data for the given transform or component.ParDo.BoundMulti<InputT,OutputT>
withSideInputs(Iterable<? extends PCollectionView<?>> sideInputs)
Returns a new multi-outputParDo
PTransform
that's like thisPTransform
but with the specified additional side inputs.ParDo.BoundMulti<InputT,OutputT>
withSideInputs(PCollectionView<?>... sideInputs)
Returns a new multi-outputParDo
PTransform
that's like thisPTransform
but with the specified additional side inputs.-
Methods inherited from class com.google.cloud.dataflow.sdk.transforms.PTransform
getDefaultOutputCoder, getName, toString, validate
-
-
-
-
Method Detail
-
named
public ParDo.BoundMulti<InputT,OutputT> named(String name)
Returns a new multi-outputParDo
PTransform
that's like thisPTransform
but with the specified name. Does not modify thisPTransform
.See the discussion of Naming above for more explanation.
-
withSideInputs
public ParDo.BoundMulti<InputT,OutputT> withSideInputs(PCollectionView<?>... sideInputs)
Returns a new multi-outputParDo
PTransform
that's like thisPTransform
but with the specified additional side inputs. Does not modify thisPTransform
.See the discussion of Side Inputs above and on
ParDo.withSideInputs(com.google.cloud.dataflow.sdk.values.PCollectionView<?>...)
for more explanation.
-
withSideInputs
public ParDo.BoundMulti<InputT,OutputT> withSideInputs(Iterable<? extends PCollectionView<?>> sideInputs)
Returns a new multi-outputParDo
PTransform
that's like thisPTransform
but with the specified additional side inputs. Does not modify thisPTransform
.See the discussion of Side Inputs above and on
ParDo.withSideInputs(com.google.cloud.dataflow.sdk.values.PCollectionView<?>...)
for more explanation.
-
apply
public PCollectionTuple apply(PCollection<? extends InputT> input)
Description copied from class:PTransform
Applies thisPTransform
on the givenInputT
, and returns itsOutput
.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<InputT, OutputT>, InputT)
.- Overrides:
apply
in classPTransform<PCollection<? extends InputT>,PCollectionTuple>
-
getDefaultOutputCoder
protected Coder<OutputT> getDefaultOutputCoder()
Description copied from class:PTransform
Returns the defaultCoder
to use for the output of this single-outputPTransform
.By default, always throws
- Overrides:
getDefaultOutputCoder
in classPTransform<PCollection<? extends InputT>,PCollectionTuple>
-
getDefaultOutputCoder
public <T> Coder<T> getDefaultOutputCoder(PCollection<? extends InputT> input, TypedPValue<T> output) throws CannotProvideCoderException
Description copied from class:PTransform
Returns the defaultCoder
to use for the given output of this single-outputPTransform
when applied to the given input.By default, always throws.
- Overrides:
getDefaultOutputCoder
in classPTransform<PCollection<? extends InputT>,PCollectionTuple>
- Throws:
CannotProvideCoderException
- if none can be inferred.
-
getKindString
protected String getKindString()
Description copied from class:PTransform
Returns the name to use by default for thisPTransform
(not including the names of any enclosingPTransform
s).By default, returns the base name of this
PTransform
's class.The caller is responsible for ensuring that names of applied
PTransform
s are unique, e.g., by adding a uniquifying suffix when needed.- Overrides:
getKindString
in classPTransform<PCollection<? extends InputT>,PCollectionTuple>
-
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 viaDisplayData.from(HasDisplayData)
. Implementations may callsuper.populateDisplayData(builder)
in order to register display data in the current namespace, but should otherwise usesubcomponent.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 interfaceHasDisplayData
- Overrides:
populateDisplayData
in classPTransform<PCollection<? extends InputT>,PCollectionTuple>
- Parameters:
builder
- The builder to populate with display data.- See Also:
HasDisplayData
-
getSideOutputTags
public TupleTagList getSideOutputTags()
-
getSideInputs
public List<PCollectionView<?>> getSideInputs()
-
-