org.apache.beam.it.gcp.pubsublite

Class PubsubliteResourceManager

java.lang.Object

org.apache.beam.it.gcp.pubsublite.PubsubliteResourceManager

All Implemented Interfaces:

org.apache.beam.it.common.ResourceManager

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

Client for managing Pub/Sub Lite resources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	DEFAULT_NUM_PARTITIONS
static java.lang.Long	DEFAULT_PARTITION_SIZE
static com.google.protobuf.Duration	DEFAULT_RETENTION_PERIOD

Constructor Summary

Constructors

Constructor and Description
PubsubliteResourceManager()

Method Summary

Modifier and Type	Method and Description
void	cleanupAll() Delete any topics or subscriptions created by this manager.
com.google.cloud.pubsublite.ReservationPath	createReservation(java.lang.String reservationName, java.lang.String cloudRegion, java.lang.String projectId, java.lang.Long capacity) Creates a new PubsubLite reservation with the specified number of capacity units.
com.google.cloud.pubsublite.SubscriptionName	createSubscription(com.google.cloud.pubsublite.ReservationPath reservationPath, com.google.cloud.pubsublite.TopicName topicName, java.lang.String subscriptionName) Creates a new Pub/Sub Lite subscription for a specified topic.
com.google.cloud.pubsublite.TopicName	createTopic(java.lang.String topicName, com.google.cloud.pubsublite.ReservationPath reservationPath) Creates a topic with the given name on Pub/Sub.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NUM_PARTITIONS

public static final java.lang.Integer DEFAULT_NUM_PARTITIONS

DEFAULT_RETENTION_PERIOD

public static final com.google.protobuf.Duration DEFAULT_RETENTION_PERIOD

DEFAULT_PARTITION_SIZE

public static final java.lang.Long DEFAULT_PARTITION_SIZE

Constructor Detail

PubsubliteResourceManager

public PubsubliteResourceManager()

Method Detail

createReservation

public com.google.cloud.pubsublite.ReservationPath createReservation(java.lang.String reservationName,
                                                                     java.lang.String cloudRegion,
                                                                     java.lang.String projectId,
                                                                     java.lang.Long capacity)

Creates a new PubsubLite reservation with the specified number of capacity units. Capacity units represent 0.25 MiBps on a regional reservation, and 1 MiBps on a zonal reservation.

Parameters:

reservationName - the name of the reservation to create.

cloudRegion - the region in which the reservation will be created.

projectId - the project id associated with the reservation.

capacity - the number of capacity units for the reservation.

Returns:

the path of the created reservation.

createTopic

public com.google.cloud.pubsublite.TopicName createTopic(java.lang.String topicName,
                                                         com.google.cloud.pubsublite.ReservationPath reservationPath)

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

https://cloud.google.com/pubsub/lite/docs/reservations

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.

reservationPath - the path of the reservation under which to create the topic.

Returns:

The instance of the TopicName that was just created.

createSubscription

public com.google.cloud.pubsublite.SubscriptionName createSubscription(com.google.cloud.pubsublite.ReservationPath reservationPath,
                                                                       com.google.cloud.pubsublite.TopicName topicName,
                                                                       java.lang.String subscriptionName)

Creates a new Pub/Sub Lite subscription for a specified topic.

Parameters:

reservationPath - the path of the reservation to add the subscription.

topicName - the name of the topic to add the subscription to.

subscriptionName - the name to use for the subscription.

Returns:

the created SubscriptionName instance.

cleanupAll

public void cleanupAll()

Delete any topics or subscriptions created by this manager.

Specified by:

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