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

Class PubsubReadSchemaTransformConfiguration

java.lang.Object

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

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

Configuration for reading from 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	PubsubReadSchemaTransformConfiguration.Builder

Constructor Summary

Constructors

Constructor and Description
PubsubReadSchemaTransformConfiguration()

Method Summary

Modifier and Type	Method and Description
static PubsubReadSchemaTransformConfiguration.Builder	builder()
abstract PubsubTestClient.PubsubTestClientFactory	getClientFactory()
abstract com.google.api.client.util.Clock	getClock()
abstract java.lang.String	getFormat()
abstract java.lang.String	getSchema()
abstract java.lang.String	getSubscription()
abstract java.lang.String	getTopic()

Methods inherited from class java.lang.Object

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

Constructor Detail

PubsubReadSchemaTransformConfiguration

public PubsubReadSchemaTransformConfiguration()

Method Detail

getTopic

@SchemaFieldDescription(value="The name of the topic to consume data from. If a topic is specified,  will create a new subscription for that topic and start consuming from that point. Either a topic or a subscription must be provided. Format: projects/${PROJECT}/topics/${TOPIC}")
 @Nullable
public abstract java.lang.String getTopic()

getSubscription

@SchemaFieldDescription(value="The name of the subscription to consume data. Either a topic or subscription must be provided. Format: projects/${PROJECT}/subscriptions/${SUBSCRIPTION}")
 @Nullable
public abstract java.lang.String getSubscription()

getFormat

@SchemaFieldDescription(value="The encoding format for the data stored in Pubsub. Valid options are: AVRO,JSON")
public abstract java.lang.String getFormat()

getSchema

@SchemaFieldDescription(value="The schema in which the data is encoded in the Pubsub topic. For AVRO data, this is a schema defined with AVRO schema syntax (https://avro.apache.org/docs/1.10.2/spec.html#schemas). For JSON data, this is a schema defined with JSON-schema syntax (https://json-schema.org/).")
public abstract java.lang.String getSchema()

getClientFactory

@Nullable
public abstract PubsubTestClient.PubsubTestClientFactory getClientFactory()

getClock

@Nullable
public abstract com.google.api.client.util.Clock getClock()

builder

public static PubsubReadSchemaTransformConfiguration.Builder builder()