com.google.cloud.dataflow.sdk.io

Class PubsubIO.Read

java.lang.Object

com.google.cloud.dataflow.sdk.io.PubsubIO.Read

Enclosing class:

PubsubIO

public static class PubsubIO.Read
extends java.lang.Object

A PTransform that continuously reads from a Pubsub stream and returns a PCollection<String> containing the items from the stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubsubIO.Read.Bound A PTransform that reads from a PubSub source and returns a unbounded PCollection containing the items from the stream.

Constructor Summary

Constructors

Constructor and Description
PubsubIO.Read()

Method Summary

Methods

Modifier and Type	Method and Description
static PubsubIO.Read.Bound	named(java.lang.String name)
static PubsubIO.Read.Bound	subscription(java.lang.String subscription) Creates and returns a PubsubIO.Read PTransform for reading from a specific Pubsub subscription.
static PubsubIO.Read.Bound	topic(java.lang.String topic) Creates and returns a PubsubIO.Read PTransform for reading from a Pubsub topic with the specified publisher topic.

Methods inherited from class java.lang.Object

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

Constructor Detail

PubsubIO.Read

public PubsubIO.Read()

Method Detail

named

public static PubsubIO.Read.Bound named(java.lang.String name)

topic

public static PubsubIO.Read.Bound topic(java.lang.String topic)

Creates and returns a PubsubIO.Read PTransform for reading from a Pubsub topic with the specified publisher topic. Format for Cloud Pubsub topic names should be of the form /topics/<project>/<topic>, where <project> is the name of the publishing project. The <topic> component must comply with the below requirements.

• Can only contain lowercase letters, numbers, dashes ('-'), underscores ('_') and periods ('.').
• Must be between 3 and 255 characters.
• Must begin with a letter.
• Must end with a letter or a number.
• Cannot begin with 'goog' prefix.

subscription

public static PubsubIO.Read.Bound subscription(java.lang.String subscription)

Creates and returns a PubsubIO.Read PTransform for reading from a specific Pubsub subscription. Mutually exclusive with PubsubIO.Read.topic(). Cloud Pubsub subscription names should be of the form /subscriptions/<project>/<<subscription>, where <project> is the name of the project the subscription belongs to. The <subscription> component must comply with the below requirements.

• Can only contain lowercase letters, numbers, dashes ('-'), underscores ('_') and periods ('.').
• Must be between 3 and 255 characters.
• Must begin with a letter.
• Must end with a letter or a number.
• Cannot begin with 'goog' prefix.