org.apache.beam.it.gcp.pubsub

Class PubsubResourceManager

java.lang.Object

org.apache.beam.it.gcp.pubsub.PubsubResourceManager

All Implemented Interfaces:

org.apache.beam.it.common.ResourceManager

public final class PubsubResourceManager
extends java.lang.Object
implements org.apache.beam.it.common.ResourceManager

Client for managing Pub/Sub resources.

The class provides an interaction with the real Pub/Sub client, with operations related to management of topics and subscriptions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubsubResourceManager.Builder Builder for PubsubResourceManager.

Method Summary

Modifier and Type	Method and Description
static PubsubResourceManager.Builder	builder(java.lang.String testName, java.lang.String projectId, com.google.api.gax.core.CredentialsProvider credentialsProvider)
void	cleanupAll() Delete any topics or subscriptions created by this manager.
java.lang.String	createSchema(com.google.pubsub.v1.Schema.Type schemaType, java.lang.String schemaDefinition, com.google.pubsub.v1.Encoding dataEncoding, com.google.pubsub.v1.TopicName schemaTopic) Registers a new schema of the given type and definition, then assigns it to the specified topic.
com.google.pubsub.v1.SubscriptionName	createSubscription(com.google.pubsub.v1.TopicName topicName, java.lang.String subscriptionName) Creates a subscription at the specific topic, with a given name.
com.google.pubsub.v1.TopicName	createTopic(java.lang.String topicName) Creates a topic with the given name on Pub/Sub.
com.google.pubsub.v1.TopicName	createTopicWithoutPrefix(java.lang.String topicName) Creates a topic with the given name on Pub/Sub.
java.lang.String	getTestId() Return the test ID this Resource Manager uses to manage Pub/Sub instances.
java.lang.String	publish(com.google.pubsub.v1.TopicName topic, java.util.Map<java.lang.String,java.lang.String> attributes, com.google.protobuf.ByteString data) Publishes a message with the given data to the publisher context's topic.
com.google.pubsub.v1.PullResponse	pull(com.google.pubsub.v1.SubscriptionName subscriptionName, int maxMessages) Pulls messages from the given subscription.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static PubsubResourceManager.Builder builder(java.lang.String testName,
                                                    java.lang.String projectId,
                                                    com.google.api.gax.core.CredentialsProvider credentialsProvider)

getTestId

public java.lang.String getTestId()

Return the test ID this Resource Manager uses to manage Pub/Sub instances.

Returns:

the test ID.

createTopic

public com.google.pubsub.v1.TopicName createTopic(java.lang.String topicName)

Creates a topic with the given name on Pub/Sub.

Parameters:

topicName - Topic name to create. The underlying implementation may not use the topic name directly, and can add a prefix or a suffix to identify specific executions.

Returns:

The instance of the TopicName that was just created.

createTopicWithoutPrefix

public com.google.pubsub.v1.TopicName createTopicWithoutPrefix(java.lang.String topicName)

Creates a topic with the given name on Pub/Sub.

Parameters:

topicName - Topic name to create. The underlying implementation will use the topic name directly.

Returns:

The instance of the TopicName that was just created.

createSubscription

public com.google.pubsub.v1.SubscriptionName createSubscription(com.google.pubsub.v1.TopicName topicName,
                                                                java.lang.String subscriptionName)

Creates a subscription at the specific topic, with a given name.

Parameters:

topicName - Topic Name reference to add the subscription.

subscriptionName - Name of the subscription to use. Note that the underlying implementation may not use the subscription name literally, and can use a prefix or a suffix to identify specific executions.

Returns:

The instance of the SubscriptionName that was just created.

publish

public java.lang.String publish(com.google.pubsub.v1.TopicName topic,
                                java.util.Map<java.lang.String,java.lang.String> attributes,
                                com.google.protobuf.ByteString data)
                         throws org.apache.beam.it.gcp.pubsub.PubsubResourceManagerException

Publishes a message with the given data to the publisher context's topic.

Parameters:

topic - Reference to the topic to send the message.

attributes - Attributes to send with the message.

data - Byte data to send.

Returns:

The message id that was generated.

Throws:

org.apache.beam.it.gcp.pubsub.PubsubResourceManagerException

pull

public com.google.pubsub.v1.PullResponse pull(com.google.pubsub.v1.SubscriptionName subscriptionName,
                                              int maxMessages)

Pulls messages from the given subscription.

Parameters:

subscriptionName - Name of the subscription to use.

Returns:

The message id that was generated.

createSchema

public java.lang.String createSchema(com.google.pubsub.v1.Schema.Type schemaType,
                                     java.lang.String schemaDefinition,
                                     com.google.pubsub.v1.Encoding dataEncoding,
                                     com.google.pubsub.v1.TopicName schemaTopic)

Registers a new schema of the given type and definition, then assigns it to the specified topic.

Parameters:

schemaType - the type of schema to create (e.g. AVRO, PROTOBUF)

schemaDefinition - the definition of the schema to create in AVRO or Protobuf syntax.

dataEncoding - the encoding of the data in pubsub (e.g. BINARY_ENCODING, JSON)

schemaTopic - the name of the topic to which assign the schema.

Returns:

the name of the newly created schema

cleanupAll

public void cleanupAll()

Delete any topics or subscriptions created by this manager.

Specified by:

cleanupAll in interface org.apache.beam.it.common.ResourceManager