Package org.apache.beam.sdk.io.gcp.spanner

Class SpannerWriteResult

java.lang.Object

org.apache.beam.sdk.io.gcp.spanner.SpannerWriteResult

All Implemented Interfaces:

POutput

public class SpannerWriteResult
extends Object
implements POutput

The results of a SpannerIO.write() transform.

Use getFailedMutations() to access a PCollection of MutationGroups that failed to write.

The PCollection returned by getOutput() can be used in batch pipelines as a completion signal to Wait.OnSignal to indicate when all input has been written. Note that in streaming pipelines, this signal will never be triggered as the input is unbounded and this PCollection is using the GlobalWindow.

Constructor Summary

Constructors

Constructor	Description
SpannerWriteResult(Pipeline pipeline, PCollection<Void> output, PCollection<MutationGroup> failedMutations, TupleTag<MutationGroup> failedMutationsTag)

Method Summary

Modifier and Type	Method	Description
Map<TupleTag<?>,PValue>	expand()	Expands this POutput into a list of its component output PValues.
void	finishSpecifyingOutput(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.
PCollection<MutationGroup>	getFailedMutations()
PCollection<Void>	getOutput()
Pipeline	getPipeline()	Returns the owning Pipeline of this POutput.

Methods inherited from class java.lang.Object

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

Constructor Details

SpannerWriteResult

public SpannerWriteResult(Pipeline pipeline,
 PCollection<Void> output,
 PCollection<MutationGroup> failedMutations,
 TupleTag<MutationGroup> failedMutationsTag)

Method Details

getPipeline

public Pipeline getPipeline()

Description copied from interface: POutput

Returns the owning Pipeline of this POutput.

Specified by:

getPipeline in interface POutput

expand

public Map<TupleTag<?>,PValue> expand()

Description copied from interface: POutput

Expands this POutput 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 POutput

getFailedMutations

public PCollection<MutationGroup> getFailedMutations()

getOutput

public PCollection<Void> getOutput()

finishSpecifyingOutput

public void finishSpecifyingOutput(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