Package org.apache.beam.sdk.transforms

Class WithFailures.Result<OutputT extends POutput,FailureElementT>

java.lang.Object

org.apache.beam.sdk.transforms.WithFailures.Result<OutputT,FailureElementT>

Type Parameters:

OutputT - Output type

FailureElementT - Element type for the failure PCollection

All Implemented Interfaces:

PInput, POutput

Enclosing class:

WithFailures

public abstract static class WithFailures.Result<OutputT extends POutput,FailureElementT>
extends java.lang.Object
implements PInput, POutput

An intermediate output type for PTransforms that allows an output collection to live alongside a collection of elements that failed the transform.

Constructor Summary

Constructors

Constructor	Description
Result()

Method Summary

Modifier and Type	Method	Description
java.util.Map<TupleTag<?>,PValue>	expand()	Expands this PInput into a list of its component output PValues.
abstract PCollection<FailureElementT>	failures()
OutputT	failuresTo(java.util.List<PCollection<FailureElementT>> failureCollections)	Adds the failure collection to the passed list and returns just the output collection.
void	finishSpecifyingOutput(java.lang.String transformName, PInput input, PTransform<?,?> transform)	As part of applying the producing PTransform, finalizes this output to make it ready for being used as an input and for running.
Pipeline	getPipeline()	Returns the owning Pipeline of this PInput.
static <OutputElementT,FailureElementT> WithFailures.Result<PCollection<OutputElementT>,FailureElementT>	of(PCollection<OutputElementT> output, PCollection<FailureElementT> failures)
static <OutputElementT,FailureElementT> WithFailures.Result<PCollection<OutputElementT>,FailureElementT>	of(PCollectionTuple tuple, TupleTag<OutputElementT> outputTag, TupleTag<FailureElementT> failureTag)
static <OutputT extends POutput,FailureElementT> WithFailures.Result<OutputT,FailureElementT>	of(OutputT output, PCollection<FailureElementT> failures)
abstract OutputT	output()

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

public Result()

Method Detail

output

public abstract OutputT output()

failures

public abstract PCollection<FailureElementT> failures()

of

public static <OutputT extends POutput,FailureElementT> WithFailures.Result<OutputT,FailureElementT> of(OutputT output,
                                                                                                                    PCollection<FailureElementT> failures)

of

public static <OutputElementT,FailureElementT> WithFailures.Result<PCollection<OutputElementT>,FailureElementT> of(PCollection<OutputElementT> output,
                                                                                                                               PCollection<FailureElementT> failures)

of

public static <OutputElementT,FailureElementT> WithFailures.Result<PCollection<OutputElementT>,FailureElementT> of(PCollectionTuple tuple,
                                                                                                                               TupleTag<OutputElementT> outputTag,
                                                                                                                               TupleTag<FailureElementT> failureTag)

failuresTo

public OutputT failuresTo(java.util.List<PCollection<FailureElementT>> failureCollections)

Adds the failure collection to the passed list and returns just the output collection.

getPipeline

public Pipeline getPipeline()

Description copied from interface: PInput

Returns the owning Pipeline of this PInput.

Specified by:

getPipeline in interface PInput

Specified by:

getPipeline in interface POutput

expand

public java.util.Map<TupleTag<?>,PValue> expand()

Description copied from interface: PInput

Expands this PInput into a list of its component output PValues.

• A PValue expands to itself.
• A tuple or list of PValues (such as PCollectionTuple or PCollectionList) expands to its component PValue PValues.

Not intended to be invoked directly by user code.

Specified by:

expand in interface PInput

Specified by:

expand in interface POutput

finishSpecifyingOutput

public void finishSpecifyingOutput(java.lang.String transformName,
                                   PInput input,
                                   PTransform<?,?> transform)

Description copied from interface: POutput

As part of applying the producing PTransform, finalizes this output to make it ready for being used as an input and for running.

This includes ensuring that all PCollections have Coders specified or defaulted.

Automatically invoked whenever this POutput is output, after POutput.finishSpecifyingOutput(String, PInput, PTransform) has been called on each component PValue returned by POutput.expand().

Specified by:

finishSpecifyingOutput in interface POutput