Package org.apache.beam.sdk.transforms

Class DoFn.FinishBundleContext

  • Enclosing class:
    DoFn<InputT extends @Nullable java.lang.Object,​OutputT extends @Nullable java.lang.Object>
    public abstract class DoFn.FinishBundleContext
extends java.lang.Object
    Information accessible while within the DoFn.FinishBundle method.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract PipelineOptions getPipelineOptions()
      Returns the PipelineOptions specified with the PipelineRunner invoking this DoFn.
      abstract <T> void output​(TupleTag<T> tag, T output, org.joda.time.Instant timestamp, BoundedWindow window)
      Adds the given element to the output PCollection with the given tag at the given timestamp in the given window.
      abstract void output​(OutputT output, org.joda.time.Instant timestamp, BoundedWindow window)
      Adds the given element to the main output PCollection at the given timestamp in the given window.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FinishBundleContext

        public FinishBundleContext()

    • Method Detail

      • getPipelineOptions

        @Pure
public abstract PipelineOptions getPipelineOptions()
        Returns the PipelineOptions specified with the PipelineRunner invoking this DoFn.

      • output

        public abstract void output​(OutputT output,
                            org.joda.time.Instant timestamp,
                            BoundedWindow window)
        Adds the given element to the main output PCollection at the given timestamp in the given window.

        Once passed to output the element should not be modified in any way.

        Note: A splittable DoFn is not allowed to output from the DoFn.FinishBundle method.

      • output

        public abstract <T> void output​(TupleTag<T> tag,
                                T output,
                                org.joda.time.Instant timestamp,
                                BoundedWindow window)
        Adds the given element to the output PCollection with the given tag at the given timestamp in the given window.

        Once passed to output the element should not be modified in any way.

        Note: A splittable DoFn is not allowed to output from the DoFn.FinishBundle method.