Package org.apache.beam.sdk.transforms

Class DoFn.FinishBundleContext

java.lang.Object

org.apache.beam.sdk.transforms.DoFn.FinishBundleContext

Enclosing class:

DoFn<InputT extends @Nullable Object,OutputT extends @Nullable Object>

public abstract class DoFn.FinishBundleContext
extends Object

Information accessible while within the DoFn.FinishBundle method.

Constructor Summary

Constructors

Constructor	Description
FinishBundleContext()

Method Summary

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, 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 <T> void	output(TupleTag<T> tag, T output, Instant timestamp, BoundedWindow window, @Nullable String currentRecordId, @Nullable Long currentRecordOffset)
abstract void	output(OutputT output, Instant timestamp, BoundedWindow window)	Adds the given element to the main output PCollection at the given timestamp in the given window.
abstract void	output(OutputT output, Instant timestamp, BoundedWindow window, @Nullable String currentRecordId, @Nullable Long currentRecordOffset)

Methods inherited from class java.lang.Object

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

Constructor Details

FinishBundleContext

public FinishBundleContext()

Method Details

getPipelineOptions

@Pure
public abstract PipelineOptions getPipelineOptions()

Returns the PipelineOptions specified with the PipelineRunner invoking this DoFn.

output

public abstract void output(OutputT output,
 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 void output(OutputT output,
 Instant timestamp,
 BoundedWindow window,
 @Nullable String currentRecordId,
 @Nullable Long currentRecordOffset)

output

public abstract <T> void output(TupleTag<T> tag,
 T output,
 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.

output

public abstract <T> void output(TupleTag<T> tag,
 T output,
 Instant timestamp,
 BoundedWindow window,
 @Nullable String currentRecordId,
 @Nullable Long currentRecordOffset)