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

Class PubsubSchemaTransformReadConfiguration.Builder

java.lang.Object

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

Enclosing class:

PubsubSchemaTransformReadConfiguration

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract PubsubSchemaTransformReadConfiguration	build() Builds a PubsubSchemaTransformReadConfiguration instance.
abstract PubsubSchemaTransformReadConfiguration.Builder	setDataSchema(Schema value) The expected schema of the Pub/Sub message.
abstract PubsubSchemaTransformReadConfiguration.Builder	setDeadLetterQueue(java.lang.String value) The Pub/Sub topic path to write failures.
abstract PubsubSchemaTransformReadConfiguration.Builder	setFormat(java.lang.String value) The expected format of the Pub/Sub message.
abstract PubsubSchemaTransformReadConfiguration.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 PubsubSchemaTransformReadConfiguration.Builder	setProtoClass(java.lang.String value) Used by the ProtoPayloadSerializerProvider when serializing from a Pub/Sub message.
abstract PubsubSchemaTransformReadConfiguration.Builder	setSubscription(java.lang.String value) The subscription from which to read Pub/Sub messages.
abstract PubsubSchemaTransformReadConfiguration.Builder	setThriftClass(java.lang.String value) Used by the ThriftPayloadSerializerProvider when serializing from a Pub/Sub message.
abstract PubsubSchemaTransformReadConfiguration.Builder	setThriftProtocolFactoryClass(java.lang.String value) Used by the ThriftPayloadSerializerProvider when serializing from a Pub/Sub message.
abstract PubsubSchemaTransformReadConfiguration.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 PubsubSchemaTransformReadConfiguration.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 PubsubSchemaTransformReadConfiguration.Builder setDataSchema(Schema value)

The expected schema of the Pub/Sub message.

setDeadLetterQueue

public abstract PubsubSchemaTransformReadConfiguration.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 PubsubSchemaTransformReadConfiguration.Builder setFormat(java.lang.String value)

The expected format of the Pub/Sub message.

Used to retrieve the PayloadSerializer from PayloadSerializers.

setProtoClass

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

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

setSubscription

public abstract PubsubSchemaTransformReadConfiguration.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 PubsubSchemaTransformReadConfiguration.Builder setThriftClass(java.lang.String value)

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

setThriftProtocolFactoryClass

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

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

setTimestampAttribute

public abstract PubsubSchemaTransformReadConfiguration.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 PubsubSchemaTransformReadConfiguration.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 PubsubSchemaTransformReadConfiguration.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 PubsubSchemaTransformReadConfiguration build()

Builds a PubsubSchemaTransformReadConfiguration instance.