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

Class PubsubReadSchemaTransformConfiguration.Builder

java.lang.Object

org.apache.beam.sdk.io.gcp.pubsub.PubsubReadSchemaTransformConfiguration.Builder

Enclosing class:

PubsubReadSchemaTransformConfiguration

public abstract static class PubsubReadSchemaTransformConfiguration.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract PubsubReadSchemaTransformConfiguration	build() Builds a PubsubReadSchemaTransformConfiguration instance.
abstract PubsubReadSchemaTransformConfiguration.Builder	setDataSchema(Schema value) The expected schema of the Pub/Sub message.
abstract PubsubReadSchemaTransformConfiguration.Builder	setDeadLetterQueue(java.lang.String value) The Pub/Sub topic path to write failures.
abstract PubsubReadSchemaTransformConfiguration.Builder	setFormat(java.lang.String value) The expected format of the Pub/Sub message.
abstract PubsubReadSchemaTransformConfiguration.Builder	setIdAttribute(java.lang.String value) When reading from Cloud Pub/Sub where unique record identifiers are provided as Pub/Sub message attributes, specifies the name of the attribute containing the unique identifier.
abstract PubsubReadSchemaTransformConfiguration.Builder	setProtoClass(java.lang.String value) Used by the ProtoPayloadSerializerProvider when serializing from a Pub/Sub message.
abstract PubsubReadSchemaTransformConfiguration.Builder	setSubscription(java.lang.String value) The subscription from which to read Pub/Sub messages.
abstract PubsubReadSchemaTransformConfiguration.Builder	setThriftClass(java.lang.String value) Used by the ThriftPayloadSerializerProvider when serializing from a Pub/Sub message.
abstract PubsubReadSchemaTransformConfiguration.Builder	setThriftProtocolFactoryClass(java.lang.String value) Used by the ThriftPayloadSerializerProvider when serializing from a Pub/Sub message.
abstract PubsubReadSchemaTransformConfiguration.Builder	setTimestampAttribute(java.lang.String value) When reading from Cloud Pub/Sub where record timestamps are provided as Pub/Sub message attributes, specifies the name of the attribute that contains the timestamp.
abstract PubsubReadSchemaTransformConfiguration.Builder	setTopic(java.lang.String value) The topic from which to read Pub/Sub messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setDataSchema

public abstract PubsubReadSchemaTransformConfiguration.Builder setDataSchema(Schema value)

The expected schema of the Pub/Sub message.

setDeadLetterQueue

public abstract PubsubReadSchemaTransformConfiguration.Builder setDeadLetterQueue(java.lang.String value)

The Pub/Sub topic path to write failures.

See PubsubIO.PubsubTopic.fromPath(String) for more details on the format of the dead letter queue topic string.

setFormat

public abstract PubsubReadSchemaTransformConfiguration.Builder setFormat(java.lang.String value)

The expected format of the Pub/Sub message.

Used to retrieve the PayloadSerializer from PayloadSerializers.

setProtoClass

public abstract PubsubReadSchemaTransformConfiguration.Builder setProtoClass(java.lang.String value)

Used by the ProtoPayloadSerializerProvider when serializing from a Pub/Sub message.

setSubscription

public abstract PubsubReadSchemaTransformConfiguration.Builder setSubscription(java.lang.String value)

The subscription from which to read Pub/Sub messages.

See PubsubIO.PubsubSubscription.fromPath(String) for more details on the format of the subscription string.

setThriftClass

public abstract PubsubReadSchemaTransformConfiguration.Builder setThriftClass(java.lang.String value)

Used by the ThriftPayloadSerializerProvider when serializing from a Pub/Sub message.

setThriftProtocolFactoryClass

public abstract PubsubReadSchemaTransformConfiguration.Builder setThriftProtocolFactoryClass(java.lang.String value)

Used by the ThriftPayloadSerializerProvider when serializing from a Pub/Sub message.

setTimestampAttribute

public abstract PubsubReadSchemaTransformConfiguration.Builder setTimestampAttribute(java.lang.String value)

When reading from Cloud Pub/Sub where record timestamps are provided as Pub/Sub message attributes, specifies the name of the attribute that contains the timestamp.

setIdAttribute

public abstract PubsubReadSchemaTransformConfiguration.Builder setIdAttribute(java.lang.String value)

When reading from Cloud Pub/Sub where unique record identifiers are provided as Pub/Sub message attributes, specifies the name of the attribute containing the unique identifier.

setTopic

public abstract PubsubReadSchemaTransformConfiguration.Builder setTopic(java.lang.String value)

The topic from which to read Pub/Sub messages.

See PubsubIO.PubsubTopic.fromPath(String) for more details on the format of the topic string.

build

public abstract PubsubReadSchemaTransformConfiguration build()

Builds a PubsubReadSchemaTransformConfiguration instance.