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

Class SpannerWriteResult

  • All Implemented Interfaces:
    org.apache.beam.sdk.values.POutput
    public class SpannerWriteResult
extends java.lang.Object
implements org.apache.beam.sdk.values.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​(org.apache.beam.sdk.Pipeline pipeline, org.apache.beam.sdk.values.PCollection<java.lang.Void> output, org.apache.beam.sdk.values.PCollection<MutationGroup> failedMutations, org.apache.beam.sdk.values.TupleTag<MutationGroup> failedMutationsTag)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<org.apache.beam.sdk.values.TupleTag<?>,​org.apache.beam.sdk.values.PValue> expand()  
      void finishSpecifyingOutput​(java.lang.String transformName, org.apache.beam.sdk.values.PInput input, org.apache.beam.sdk.transforms.PTransform<?,​?> transform)  
      org.apache.beam.sdk.values.PCollection<MutationGroup> getFailedMutations()  
      org.apache.beam.sdk.values.PCollection<java.lang.Void> getOutput()  
      org.apache.beam.sdk.Pipeline getPipeline()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SpannerWriteResult

        public SpannerWriteResult​(org.apache.beam.sdk.Pipeline pipeline,
                          org.apache.beam.sdk.values.PCollection<java.lang.Void> output,
                          org.apache.beam.sdk.values.PCollection<MutationGroup> failedMutations,
                          org.apache.beam.sdk.values.TupleTag<MutationGroup> failedMutationsTag)

    • Method Detail

      • getPipeline

        public org.apache.beam.sdk.Pipeline getPipeline()
        Specified by:
        getPipeline in interface org.apache.beam.sdk.values.POutput

      • expand

        public java.util.Map<org.apache.beam.sdk.values.TupleTag<?>,​org.apache.beam.sdk.values.PValue> expand()
        Specified by:
        expand in interface org.apache.beam.sdk.values.POutput

      • getFailedMutations

        public org.apache.beam.sdk.values.PCollection<MutationGroup> getFailedMutations()

      • getOutput

        public org.apache.beam.sdk.values.PCollection<java.lang.Void> getOutput()

      • finishSpecifyingOutput

        public void finishSpecifyingOutput​(java.lang.String transformName,
                                   org.apache.beam.sdk.values.PInput input,
                                   org.apache.beam.sdk.transforms.PTransform<?,​?> transform)
        Specified by:
        finishSpecifyingOutput in interface org.apache.beam.sdk.values.POutput