InputT
- the type of the (main) input PCollection
elementsOutputT
- the type of the main output PCollection
elementspublic static class ParDo.MultiOutput<InputT,OutputT> extends PTransform<PCollection<? extends InputT>,PCollectionTuple>
PTransform
that, when applied to a PCollection<InputT>
, invokes a
user-specified DoFn<InputT, OutputT>
on all its elements, which can emit elements to
any of the PTransform
's output PCollection
s, which are bundled into a result
PCollectionTuple
.name, resourceHints
Modifier and Type | Method and Description |
---|---|
PCollectionTuple |
expand(PCollection<? extends InputT> input)
Override this method to specify how this
PTransform should be expanded on the given
InputT . |
java.util.Map<TupleTag<?>,PValue> |
getAdditionalInputs()
Returns the side inputs of this
ParDo , tagged with the tag of the PCollectionView . |
TupleTagList |
getAdditionalOutputTags() |
DoFn<InputT,OutputT> |
getFn() |
protected java.lang.String |
getKindString()
Returns the name to use by default for this
PTransform (not including the names of any
enclosing PTransform s). |
TupleTag<OutputT> |
getMainOutputTag() |
java.util.Map<java.lang.String,PCollectionView<?>> |
getSideInputs() |
void |
populateDisplayData(DisplayData.Builder builder)
Register display data for the given transform or component.
|
java.lang.String |
toString() |
ParDo.MultiOutput<InputT,OutputT> |
withSideInput(java.lang.String tagId,
PCollectionView<?> pCollectionView)
Returns a new multi-output
ParDo PTransform that's like this PTransform but with the specified additional side inputs. |
ParDo.MultiOutput<InputT,OutputT> |
withSideInputs(java.lang.Iterable<? extends PCollectionView<?>> sideInputs) |
ParDo.MultiOutput<InputT,OutputT> |
withSideInputs(java.util.Map<java.lang.String,PCollectionView<?>> sideInputs)
Returns a new multi-output
ParDo PTransform that's like this PTransform but with the specified additional side inputs. |
ParDo.MultiOutput<InputT,OutputT> |
withSideInputs(PCollectionView<?>... sideInputs)
Returns a new multi-output
ParDo PTransform that's like this PTransform but with the specified additional side inputs. |
compose, compose, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getName, getResourceHints, setResourceHints, validate
public ParDo.MultiOutput<InputT,OutputT> withSideInputs(PCollectionView<?>... sideInputs)
ParDo
PTransform
that's like this PTransform
but with the specified additional side inputs. Does not modify this PTransform
.
See the discussion of Side Inputs above for more explanation.
public ParDo.MultiOutput<InputT,OutputT> withSideInputs(java.lang.Iterable<? extends PCollectionView<?>> sideInputs)
public ParDo.MultiOutput<InputT,OutputT> withSideInputs(java.util.Map<java.lang.String,PCollectionView<?>> sideInputs)
ParDo
PTransform
that's like this PTransform
but with the specified additional side inputs. Does not modify this PTransform
.
See the discussion of Side Inputs above for more explanation.
public ParDo.MultiOutput<InputT,OutputT> withSideInput(java.lang.String tagId, PCollectionView<?> pCollectionView)
ParDo
PTransform
that's like this PTransform
but with the specified additional side inputs. Does not modify this PTransform
.public PCollectionTuple expand(PCollection<? extends InputT> input)
PTransform
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).
expand
in class PTransform<PCollection<? extends InputT>,PCollectionTuple>
protected java.lang.String getKindString()
PTransform
PTransform
(not including the names of any
enclosing PTransform
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.
getKindString
in class PTransform<PCollection<? extends InputT>,PCollectionTuple>
public void populateDisplayData(DisplayData.Builder builder)
PTransform
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.
populateDisplayData
in interface HasDisplayData
populateDisplayData
in class PTransform<PCollection<? extends InputT>,PCollectionTuple>
builder
- The builder to populate with display data.HasDisplayData
public TupleTagList getAdditionalOutputTags()
public java.util.Map<java.lang.String,PCollectionView<?>> getSideInputs()
public java.util.Map<TupleTag<?>,PValue> getAdditionalInputs()
ParDo
, tagged with the tag of the PCollectionView
. The values of the returned map will be equal to the result of getSideInputs()
.getAdditionalInputs
in class PTransform<PCollection<? extends InputT>,PCollectionTuple>
public java.lang.String toString()
toString
in class PTransform<PCollection<? extends InputT>,PCollectionTuple>