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

Class PubsubIO.Write.PubsubBoundedWriter

java.lang.Object

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

org.apache.beam.sdk.io.gcp.pubsub.PubsubIO.Write.PubsubBoundedWriter

All Implemented Interfaces:

Serializable, HasDisplayData

Enclosing class:

PubsubIO.Write<T>

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

Writer to Pubsub which batches messages from bounded collections.

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.AlwaysFetched, DoFn.BoundedPerElement, DoFn.BundleFinalizer, DoFn.Element, DoFn.FieldAccess, DoFn.FinishBundle, DoFn.FinishBundleContext, DoFn.GetInitialRestriction, DoFn.GetInitialWatermarkEstimatorState, DoFn.GetRestrictionCoder, DoFn.GetSize, DoFn.GetWatermarkEstimatorStateCoder, DoFn.Key, DoFn.MultiOutputReceiver, DoFn.NewTracker, DoFn.NewWatermarkEstimator, DoFn.OnTimer, DoFn.OnTimerContext, DoFn.OnTimerFamily, DoFn.OnWindowExpiration, DoFn.OnWindowExpirationContext, DoFn.OutputReceiver<T>, DoFn.ProcessContext, DoFn.ProcessContinuation, DoFn.ProcessElement, DoFn.RequiresStableInput, DoFn.RequiresTimeSortedInput, DoFn.Restriction, DoFn.Setup, DoFn.SideInput, DoFn.SplitRestriction, DoFn.StartBundle, DoFn.StartBundleContext, DoFn.StateId, DoFn.Teardown, DoFn.TimerFamily, DoFn.TimerId, DoFn.Timestamp, DoFn.TruncateRestriction, DoFn.UnboundedPerElement, DoFn.WatermarkEstimatorState, DoFn.WindowedContext

Method Summary

Modifier and Type	Method	Description
void	finishBundle()
void	populateDisplayData(DisplayData.Builder builder)	Register display data for the given transform or component.
void	processElement(PubsubMessage message, Instant timestamp)
void	startBundle(DoFn<PubsubMessage,Void>.StartBundleContext c)

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

getAllowedTimestampSkew, getInputTypeDescriptor, getOutputTypeDescriptor, prepareForProcessing

Methods inherited from class java.lang.Object

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

Method Details

startBundle

@StartBundle
public void startBundle(DoFn<PubsubMessage,Void>.StartBundleContext c)
                 throws IOException

Throws:

IOException

processElement

@ProcessElement
public void processElement(@Element
 PubsubMessage message,
 @Timestamp
 Instant timestamp)
                    throws IOException,
SizeLimitExceededException

Throws:

IOException

SizeLimitExceededException

finishBundle

@FinishBundle
public void finishBundle()
                  throws IOException

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<PubsubMessage,Void>

Parameters:

builder - The builder to populate with display data.

See Also:

• HasDisplayData