com.spotify.google.cloud.pubsub.client

Class Pubsub

java.lang.Object

com.spotify.google.cloud.pubsub.client.Pubsub

All Implemented Interfaces:

Closeable, AutoCloseable

public class Pubsub
extends Object
implements Closeable

An async low-level Google Cloud Pub/Sub client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pubsub.Builder A Pubsub.Builder that can be used to build a new Pubsub client.

Method Summary

Modifier and Type	Method and Description
PubsubFuture<Void>	acknowledge(String canonicalSubscriptionName, List<String> ackIds) Acknowledge a batch of received messages.
PubsubFuture<Void>	acknowledge(String project, String subscription, List<String> ackIds) Acknowledge a batch of received messages.
PubsubFuture<Void>	acknowledge(String project, String subscription, String... ackIds) Acknowledge a batch of received messages.
static Pubsub.Builder	builder() Create a new Pubsub.Builder that can be used to build a new Pubsub client.
void	close() Close this Pubsub client.
CompletableFuture<Void>	closeFuture() Get a future that is completed when this Pubsub client is closed.
static Pubsub	create() Create a new Pubsub client with default configuration.
PubsubFuture<Subscription>	createSubscription(String canonicalSubscriptionName, String canonicalTopic) Create a Pub/Sub subscription.
PubsubFuture<Subscription>	createSubscription(String project, String subscriptionName, String topic) Create a Pub/Sub subscription.
PubsubFuture<Topic>	createTopic(String project, String topic) Create a Pub/Sub topic.
PubsubFuture<Void>	deleteSubscription(String canonicalSubscriptionName) Delete a Pub/Sub subscription.
PubsubFuture<Void>	deleteSubscription(String project, String subscription) Delete a Pub/Sub subscription.
PubsubFuture<Void>	deleteTopic(String canonicalTopic) Delete a Pub/Sub topic.
PubsubFuture<Void>	deleteTopic(String project, String topic) Delete a Pub/Sub topic.
PubsubFuture<Subscription>	getSubscription(String canonicalSubscriptionName) Get a Pub/Sub subscription.
PubsubFuture<Subscription>	getSubscription(String project, String subscription) Get a Pub/Sub subscription.
PubsubFuture<Topic>	getTopic(String canonicalTopic) Get a Pub/Sub topic.
PubsubFuture<Topic>	getTopic(String project, String topic) Get a Pub/Sub topic.
PubsubFuture<SubscriptionList>	listSubscriptions(String project) List the Pub/Sub subscriptions in a project.
PubsubFuture<SubscriptionList>	listSubscriptions(String project, String pageToken) Get a page of Pub/Sub subscriptions in a project using a specified page token.
PubsubFuture<TopicList>	listTopics(String project) List the Pub/Sub topics in a project.
PubsubFuture<TopicList>	listTopics(String project, String pageToken) Get a page of Pub/Sub topics in a project using a specified page token.
PubsubFuture<Void>	modifyAckDeadline(String canonicalSubscriptionName, int ackDeadlineSeconds, List<String> ackIds) Modify the ack deadline for a list of received messages.
PubsubFuture<Void>	modifyAckDeadline(String project, String subscription, int ackDeadlineSeconds, List<String> ackIds) Modify the ack deadline for a list of received messages.
PubsubFuture<Void>	modifyAckDeadline(String project, String subscription, int ackDeadlineSeconds, String... ackIds) Modify the ack deadline for a list of received messages.
PubsubFuture<List<String>>	publish(List<Message> messages, String canonicalTopic) Publish a batch of messages.
PubsubFuture<List<String>>	publish(String project, String topic, List<Message> messages) Publish a batch of messages.
PubsubFuture<List<String>>	publish(String project, String topic, Message... messages) Publish a batch of messages.
PubsubFuture<List<ReceivedMessage>>	pull(String canonicalSubscriptionName) Pull a batch of messages.
PubsubFuture<List<ReceivedMessage>>	pull(String canonicalSubscriptionName, boolean returnImmediately) Pull a batch of messages.
PubsubFuture<List<ReceivedMessage>>	pull(String canonicalSubscriptionName, boolean returnImmediately, int maxMessages) Pull a batch of messages.
PubsubFuture<List<ReceivedMessage>>	pull(String path, com.spotify.google.cloud.pubsub.client.PullRequest pullRequest) Pull a batch of messages.
PubsubFuture<List<ReceivedMessage>>	pull(String project, String subscription) Pull a batch of messages.
PubsubFuture<List<ReceivedMessage>>	pull(String project, String subscription, boolean returnImmediately) Pull a batch of messages.
PubsubFuture<List<ReceivedMessage>>	pull(String project, String subscription, boolean returnImmediately, int maxMessages) Pull a batch of messages.

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()

Close this Pubsub client.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

closeFuture

public CompletableFuture<Void> closeFuture()

Get a future that is completed when this Pubsub client is closed.

listTopics

public PubsubFuture<TopicList> listTopics(String project)

List the Pub/Sub topics in a project. This will get the first page of topics. To enumerate all topics you might have to make further calls to listTopics(String, String) with the page token in order to get further pages.

Parameters:

project - The Google Cloud project.

Returns:

A future that is completed when this request is completed.

listTopics

public PubsubFuture<TopicList> listTopics(String project,
                                          String pageToken)

Get a page of Pub/Sub topics in a project using a specified page token.

Parameters:

project - The Google Cloud project.

pageToken - A token for the page of topics to get.

Returns:

A future that is completed when this request is completed.

createTopic

public PubsubFuture<Topic> createTopic(String project,
                                       String topic)

Create a Pub/Sub topic.

Parameters:

project - The Google Cloud project.

topic - The name of the topic to create.

Returns:

A future that is completed when this request is completed.

getTopic

public PubsubFuture<Topic> getTopic(String project,
                                    String topic)

Get a Pub/Sub topic.

Parameters:

project - The Google Cloud project.

topic - The name of the topic to get.

Returns:

A future that is completed when this request is completed. The future will be completed with null if the response is 404.

getTopic

public PubsubFuture<Topic> getTopic(String canonicalTopic)

Get a Pub/Sub topic.

Parameters:

canonicalTopic - The canonical (including project) name of the topic to get.

Returns:

A future that is completed when this request is completed. The future will be completed with null if the response is 404.

deleteTopic

public PubsubFuture<Void> deleteTopic(String project,
                                      String topic)

Delete a Pub/Sub topic.

Parameters:

project - The Google Cloud project.

topic - The name of the topic to delete.

Returns:

A future that is completed when this request is completed. The future will be completed with null if the response is 404.

deleteTopic

public PubsubFuture<Void> deleteTopic(String canonicalTopic)

Delete a Pub/Sub topic.

Parameters:

canonicalTopic - The canonical (including project) name of the topic to delete.

Returns:

A future that is completed when this request is completed. The future will be completed with null if the response is 404.

createSubscription

public PubsubFuture<Subscription> createSubscription(String project,
                                                     String subscriptionName,
                                                     String topic)

Create a Pub/Sub subscription.

Parameters:

project - The Google Cloud project.

subscriptionName - The name of the subscription to create.

topic - The name of the topic to subscribe to.

Returns:

A future that is completed when this request is completed.

listSubscriptions

public PubsubFuture<SubscriptionList> listSubscriptions(String project)

List the Pub/Sub subscriptions in a project. This will get the first page of subscriptions. To enumerate all subscriptions you might have to make further calls to listTopics(String, String) with the page token in order to get further pages.

Parameters:

project - The Google Cloud project.

Returns:

A future that is completed when this request is completed.

listSubscriptions

public PubsubFuture<SubscriptionList> listSubscriptions(String project,
                                                        String pageToken)

Get a page of Pub/Sub subscriptions in a project using a specified page token.

Parameters:

project - The Google Cloud project.

pageToken - A token for the page of subscriptions to get.

Returns:

A future that is completed when this request is completed.

createSubscription

public PubsubFuture<Subscription> createSubscription(String canonicalSubscriptionName,
                                                     String canonicalTopic)

Create a Pub/Sub subscription.

Parameters:

canonicalSubscriptionName - The canonical (including project) name of the scubscription to create.

canonicalTopic - The canonical (including project) name of the topic to subscribe to.

Returns:

A future that is completed when this request is completed.

getSubscription

public PubsubFuture<Subscription> getSubscription(String project,
                                                  String subscription)

Get a Pub/Sub subscription.

Parameters:

project - The Google Cloud project.

subscription - The name of the subscription to get.

Returns:

A future that is completed when this request is completed. The future will be completed with null if the response is 404.

getSubscription

public PubsubFuture<Subscription> getSubscription(String canonicalSubscriptionName)

Get a Pub/Sub subscription.

Parameters:

canonicalSubscriptionName - The canonical (including project) name of the subscription to get.

Returns:

A future that is completed when this request is completed. The future will be completed with null if the response is 404.

deleteSubscription

public PubsubFuture<Void> deleteSubscription(String project,
                                             String subscription)

Delete a Pub/Sub subscription.

Parameters:

project - The Google Cloud project.

subscription - The name of the subscription to delete.

Returns:

A future that is completed when this request is completed. The future will be completed with null if the response is 404.

deleteSubscription

public PubsubFuture<Void> deleteSubscription(String canonicalSubscriptionName)

Delete a Pub/Sub subscription.

Parameters:

canonicalSubscriptionName - The canonical (including project) name of the subscription to delete.

Returns:

A future that is completed when this request is completed. The future will be completed with null if the response is 404.

publish

public PubsubFuture<List<String>> publish(String project,
                                          String topic,
                                          Message... messages)

Publish a batch of messages.

Parameters:

project - The Google Cloud project.

topic - The topic to publish on.

messages - The batch of messages.

Returns:

a future that is completed with a list of message ID's for the published messages.

publish

public PubsubFuture<List<String>> publish(String project,
                                          String topic,
                                          List<Message> messages)

Publish a batch of messages.

Parameters:

project - The Google Cloud project.

topic - The topic to publish on.

messages - The batch of messages.

Returns:

a future that is completed with a list of message ID's for the published messages.

publish

public PubsubFuture<List<String>> publish(List<Message> messages,
                                          String canonicalTopic)

Publish a batch of messages.

Parameters:

messages - The batch of messages.

canonicalTopic - The canonical topic to publish on.

Returns:

a future that is completed with a list of message ID's for the published messages.

pull

public PubsubFuture<List<ReceivedMessage>> pull(String project,
                                                String subscription)

Pull a batch of messages.

Parameters:

project - The Google Cloud project.

subscription - The subscription to pull from.

Returns:

a future that is completed with a list of received messages.

pull

public PubsubFuture<List<ReceivedMessage>> pull(String project,
                                                String subscription,
                                                boolean returnImmediately)

Pull a batch of messages.

Parameters:

project - The Google Cloud project.

subscription - The subscription to pull from.

returnImmediately - true to return immediately if the queue is empty. false to wait for at least one message before returning.

Returns:

a future that is completed with a list of received messages.

pull

public PubsubFuture<List<ReceivedMessage>> pull(String project,
                                                String subscription,
                                                boolean returnImmediately,
                                                int maxMessages)

Pull a batch of messages.

Parameters:

project - The Google Cloud project.

subscription - The subscription to pull from.

returnImmediately - true to return immediately if the queue is empty. false to wait for at least one message before returning.

maxMessages - Maximum number of messages to return in batch.

Returns:

a future that is completed with a list of received messages.

pull

public PubsubFuture<List<ReceivedMessage>> pull(String canonicalSubscriptionName)

Pull a batch of messages.

Parameters:

canonicalSubscriptionName - The canonical (including project name) subscription to pull from.

Returns:

a future that is completed with a list of received messages.

pull

public PubsubFuture<List<ReceivedMessage>> pull(String canonicalSubscriptionName,
                                                boolean returnImmediately)

Pull a batch of messages.

Parameters:

canonicalSubscriptionName - The canonical (including project name) subscription to pull from.

returnImmediately - true to return immediately if the queue is empty. false to wait for at least one message before returning.

Returns:

a future that is completed with a list of received messages.

pull

public PubsubFuture<List<ReceivedMessage>> pull(String canonicalSubscriptionName,
                                                boolean returnImmediately,
                                                int maxMessages)

Pull a batch of messages.

Parameters:

canonicalSubscriptionName - The canonical (including project name) subscription to pull from.

returnImmediately - true to return immediately if the queue is empty. false to wait for at least one message before returning.

maxMessages - Maximum number of messages to return in batch.

Returns:

a future that is completed with a list of received messages.

pull

public PubsubFuture<List<ReceivedMessage>> pull(String path,
                                                com.spotify.google.cloud.pubsub.client.PullRequest pullRequest)

Pull a batch of messages.

Parameters:

pullRequest - The pull request.

Returns:

a future that is completed with a list of received messages.

acknowledge

public PubsubFuture<Void> acknowledge(String project,
                                      String subscription,
                                      String... ackIds)

Acknowledge a batch of received messages.

Parameters:

project - The Google Cloud project.

subscription - The subscription to acknowledge messages on.

ackIds - List of message ID's to acknowledge.

Returns:

A future that is completed when this request is completed.

acknowledge

public PubsubFuture<Void> acknowledge(String project,
                                      String subscription,
                                      List<String> ackIds)

Acknowledge a batch of received messages.

Parameters:

project - The Google Cloud project.

subscription - The subscription to acknowledge messages on.

ackIds - List of message ID's to acknowledge.

Returns:

A future that is completed when this request is completed.

acknowledge

public PubsubFuture<Void> acknowledge(String canonicalSubscriptionName,
                                      List<String> ackIds)

Acknowledge a batch of received messages.

Parameters:

canonicalSubscriptionName - The canonical (including project name) subscription to acknowledge messages on.

ackIds - List of message ID's to acknowledge.

Returns:

A future that is completed when this request is completed.

modifyAckDeadline

public PubsubFuture<Void> modifyAckDeadline(String project,
                                            String subscription,
                                            int ackDeadlineSeconds,
                                            String... ackIds)

Modify the ack deadline for a list of received messages.

Parameters:

project - The Google Cloud project.

subscription - The subscription of the received message to modify the ack deadline on.

ackDeadlineSeconds - The new ack deadline.

ackIds - List of message ID's to modify the ack deadline on.

Returns:

A future that is completed when this request is completed.

modifyAckDeadline

public PubsubFuture<Void> modifyAckDeadline(String project,
                                            String subscription,
                                            int ackDeadlineSeconds,
                                            List<String> ackIds)

Modify the ack deadline for a list of received messages.

Parameters:

project - The Google Cloud project.

subscription - The subscription of the received message to modify the ack deadline on.

ackDeadlineSeconds - The new ack deadline.

ackIds - List of message ID's to modify the ack deadline on.

Returns:

A future that is completed when this request is completed.

modifyAckDeadline

public PubsubFuture<Void> modifyAckDeadline(String canonicalSubscriptionName,
                                            int ackDeadlineSeconds,
                                            List<String> ackIds)

Modify the ack deadline for a list of received messages.

Parameters:

canonicalSubscriptionName - The canonical (including project name) subscription of the received message to modify the ack deadline on.

ackDeadlineSeconds - The new ack deadline.

ackIds - List of message ID's to modify the ack deadline on.

Returns:

A future that is completed when this request is completed.

create

public static Pubsub create()

Create a new Pubsub client with default configuration.

builder

public static Pubsub.Builder builder()

Create a new Pubsub.Builder that can be used to build a new Pubsub client.