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

Class PubsubWriteSchemaTransformConfiguration

java.lang.Object

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

@Experimental
 @DefaultSchema(value=AutoValueSchema.class)
public abstract class PubsubWriteSchemaTransformConfiguration
extends java.lang.Object

Configuration for writing to Pub/Sub.

Internal only: This class is actively being worked on, and it will likely change. We provide no backwards compatibility guarantees, and it should not be implemented outside the Beam repository.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubsubWriteSchemaTransformConfiguration.Builder Builder for PubsubWriteSchemaTransformConfiguration.
static class	PubsubWriteSchemaTransformConfiguration.SourceConfiguration
static class	PubsubWriteSchemaTransformConfiguration.TargetConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_TIMESTAMP_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
PubsubWriteSchemaTransformConfiguration()

Method Summary

Modifier and Type	Method and Description
static PubsubWriteSchemaTransformConfiguration.Builder	builder()
abstract java.lang.String	getFormat() The expected format of the Pub/Sub message.
abstract java.lang.String	getIdAttribute() When writing to 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 PubsubWriteSchemaTransformConfiguration.SourceConfiguration	getSource() Configuration details of the source Row Schema.
abstract PubsubWriteSchemaTransformConfiguration.TargetConfiguration	getTarget() Configuration details of the target PubsubMessage.
abstract java.lang.String	getTopic() The topic to which to write Pub/Sub messages.
static PubsubWriteSchemaTransformConfiguration.SourceConfiguration.Builder	sourceConfigurationBuilder()
static PubsubWriteSchemaTransformConfiguration.TargetConfiguration.Builder	targetConfigurationBuilder()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMESTAMP_ATTRIBUTE

public static final java.lang.String DEFAULT_TIMESTAMP_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

PubsubWriteSchemaTransformConfiguration

public PubsubWriteSchemaTransformConfiguration()

Method Detail

builder

public static PubsubWriteSchemaTransformConfiguration.Builder builder()

targetConfigurationBuilder

public static PubsubWriteSchemaTransformConfiguration.TargetConfiguration.Builder targetConfigurationBuilder()

sourceConfigurationBuilder

public static PubsubWriteSchemaTransformConfiguration.SourceConfiguration.Builder sourceConfigurationBuilder()

getSource

@Nullable
public abstract PubsubWriteSchemaTransformConfiguration.SourceConfiguration getSource()

Configuration details of the source Row Schema.

getTarget

public abstract PubsubWriteSchemaTransformConfiguration.TargetConfiguration getTarget()

Configuration details of the target PubsubMessage.

getTopic

public abstract java.lang.String getTopic()

The topic to which to write Pub/Sub messages.

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

getFormat

@Nullable
public abstract java.lang.String getFormat()

The expected format of the Pub/Sub message.

Used to retrieve the PayloadSerializer from PayloadSerializers. See list of supported values by invoking Providers.loadProviders(Class).

 Providers.loadProviders(PayloadSerializer.class).keySet()

getIdAttribute

@Nullable
public abstract java.lang.String getIdAttribute()

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