org.apache.beam.sdk.io

Class PubsubIO.Write.Bound.PubsubBoundedWriter

java.lang.Object

org.apache.beam.sdk.transforms.DoFn<T,Void>

org.apache.beam.sdk.io.PubsubIO.Write.Bound.PubsubBoundedWriter

All Implemented Interfaces:

Serializable, HasDisplayData

Enclosing class:

PubsubIO.Write.Bound<T>

public class PubsubIO.Write.Bound.PubsubBoundedWriter
extends DoFn<T,Void>

Writer to Pubsub which batches messages from bounded collections.

NOTE: This is not the implementation used when running on the Google Cloud Dataflow service in streaming mode.

Public so can be suppressed by runners.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.sdk.transforms.DoFn

DoFn.Context, DoFn.ProcessContext, DoFn.RequiresWindowAccess

Constructor Summary

Constructors

Constructor and Description
PubsubBoundedWriter()

Method Summary

Modifier and Type	Method and Description
void	finishBundle(DoFn.Context c) Finishes processing this batch of elements.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
void	processElement(DoFn.ProcessContext c) Processes one input element.
void	startBundle(DoFn.Context c) Prepares this DoFn instance for processing a batch of elements.

Methods inherited from class org.apache.beam.sdk.transforms.DoFn

createAggregator, createAggregator, getAllowedTimestampSkew, getInputTypeDescriptor, getOutputTypeDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

PubsubBoundedWriter

public PubsubBoundedWriter()

Method Detail

startBundle

public void startBundle(DoFn.Context c)
                 throws IOException

Description copied from class: DoFn

Prepares this DoFn instance for processing a batch of elements.

By default, does nothing.

Overrides:

startBundle in class DoFn<T,Void>

Throws:

IOException

processElement

public void processElement(DoFn.ProcessContext c)
                    throws IOException

Description copied from class: DoFn

Processes one input element.

The current element of the input PCollection is returned by c.element(). It should be considered immutable. The Dataflow runtime will not mutate the element, so it is safe to cache, etc. The element should not be mutated by any of the DoFn methods, because it may be cached elsewhere, retained by the Dataflow runtime, or used in other unspecified ways.

A value is added to the main output PCollection by DoFn.Context.output(OutputT). Once passed to output the element should be considered immutable and not be modified in any way. It may be cached elsewhere, retained by the Dataflow runtime, or used in other unspecified ways.

Specified by:

processElement in class DoFn<T,Void>

Throws:

IOException

See Also:

DoFn.ProcessContext

finishBundle

public void finishBundle(DoFn.Context c)
                  throws IOException

Description copied from class: DoFn

Finishes processing this batch of elements.

By default, does nothing.

Overrides:

finishBundle in class DoFn<T,Void>

Throws:

IOException

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: DoFn

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class DoFn<T,Void>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData