org.apache.beam.sdk.extensions.sql.meta.provider.pubsub

Class PubsubMessageToRow

java.lang.Object

org.apache.beam.sdk.transforms.DoFn<org.apache.beam.sdk.io.gcp.pubsub.PubsubMessage,org.apache.beam.sdk.values.Row>

org.apache.beam.sdk.extensions.sql.meta.provider.pubsub.PubsubMessageToRow

All Implemented Interfaces:

java.io.Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData

@Internal
 @Experimental
public abstract class PubsubMessageToRow
extends org.apache.beam.sdk.transforms.DoFn<org.apache.beam.sdk.io.gcp.pubsub.PubsubMessage,org.apache.beam.sdk.values.Row>

A DoFn to convert PubsubMessage with JSON payload to Row.

See Also:

Serialized Form

Nested Class Summary

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

org.apache.beam.sdk.transforms.DoFn.BoundedPerElement, org.apache.beam.sdk.transforms.DoFn.BundleFinalizer, org.apache.beam.sdk.transforms.DoFn.Element, org.apache.beam.sdk.transforms.DoFn.FieldAccess, org.apache.beam.sdk.transforms.DoFn.FinishBundle, org.apache.beam.sdk.transforms.DoFn.FinishBundleContext, org.apache.beam.sdk.transforms.DoFn.GetInitialRestriction, org.apache.beam.sdk.transforms.DoFn.GetRestrictionCoder, org.apache.beam.sdk.transforms.DoFn.MultiOutputReceiver, org.apache.beam.sdk.transforms.DoFn.NewTracker, org.apache.beam.sdk.transforms.DoFn.OnTimer, org.apache.beam.sdk.transforms.DoFn.OnTimerContext, org.apache.beam.sdk.transforms.DoFn.OnWindowExpiration, org.apache.beam.sdk.transforms.DoFn.OutputReceiver<T>, org.apache.beam.sdk.transforms.DoFn.ProcessContext, org.apache.beam.sdk.transforms.DoFn.ProcessContinuation, org.apache.beam.sdk.transforms.DoFn.ProcessElement, org.apache.beam.sdk.transforms.DoFn.RequiresStableInput, org.apache.beam.sdk.transforms.DoFn.Setup, org.apache.beam.sdk.transforms.DoFn.SplitRestriction, org.apache.beam.sdk.transforms.DoFn.StartBundle, org.apache.beam.sdk.transforms.DoFn.StartBundleContext, org.apache.beam.sdk.transforms.DoFn.StateId, org.apache.beam.sdk.transforms.DoFn.Teardown, org.apache.beam.sdk.transforms.DoFn.TimerId, org.apache.beam.sdk.transforms.DoFn.Timestamp, org.apache.beam.sdk.transforms.DoFn.UnboundedPerElement, org.apache.beam.sdk.transforms.DoFn.WindowedContext

Constructor Summary

Constructors

Constructor and Description
PubsubMessageToRow()

Method Summary

Modifier and Type	Method and Description
static org.apache.beam.sdk.extensions.sql.meta.provider.pubsub.PubsubMessageToRow.Builder	builder()
abstract org.apache.beam.sdk.schemas.Schema	messageSchema() Schema of the Pubsub message.
void	processElement(org.apache.beam.sdk.transforms.DoFn.ProcessContext context)
abstract boolean	useDlq()

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

getAllowedTimestampSkew, getInputTypeDescriptor, getOutputTypeDescriptor, populateDisplayData, prepareForProcessing

Methods inherited from class java.lang.Object

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

Constructor Detail

PubsubMessageToRow

public PubsubMessageToRow()

Method Detail

messageSchema

public abstract org.apache.beam.sdk.schemas.Schema messageSchema()

Schema of the Pubsub message.

Required to have exactly 3 top level fields at the moment:

• 'event_timestamp' of type Schema.FieldType#DATETIME
• 'attributes' of type MAP<VARCHAR,VARCHAR>
• 'payload' of type ROW<...>

Only UTF-8 JSON objects are supported.

useDlq

public abstract boolean useDlq()

builder

public static org.apache.beam.sdk.extensions.sql.meta.provider.pubsub.PubsubMessageToRow.Builder builder()

processElement

@DoFn.ProcessElement
public void processElement(org.apache.beam.sdk.transforms.DoFn.ProcessContext context)