org.springframework.cloud.gcp.pubsub.core

Interface PubSubOperations

All Known Implementing Classes:

PubSubTemplate

public interface PubSubOperations

An abstraction for Google Cloud Pub/Sub.

Author:

Vinicius Carvalho, João André Martins, Mike Eltsufin, Chengyuan Zhao

Method Summary

Modifier and Type	Method and Description
void	ack(Collection<AcknowledgeablePubsubMessage> acknowledgeablePubsubMessages) Acknowledge a batch of messages.
void	nack(Collection<AcknowledgeablePubsubMessage> acknowledgeablePubsubMessages) Negatively acknowledge a batch of messages.
org.springframework.util.concurrent.ListenableFuture<String>	publish(String topic, com.google.pubsub.v1.PubsubMessage pubsubMessage) Send a message to Pub/Sub.
<T> org.springframework.util.concurrent.ListenableFuture<String>	publish(String topic, T payload) Send a message to Pub/Sub.
<T> org.springframework.util.concurrent.ListenableFuture<String>	publish(String topic, T payload, Map<String,String> headers) Send a message to Pub/Sub.
List<AcknowledgeablePubsubMessage>	pull(String subscription, Integer maxMessages, Boolean returnImmediately) Pull a number of messages from a Google Cloud Pub/Sub subscription.
List<com.google.pubsub.v1.PubsubMessage>	pullAndAck(String subscription, Integer maxMessages, Boolean returnImmediately) Pull and auto-acknowledge a number of messages from a Google Cloud Pub/Sub subscription.
com.google.pubsub.v1.PubsubMessage	pullNext(String subscription) Pull and auto-acknowledge a message from a Google Cloud Pub/Sub subscription.
com.google.cloud.pubsub.v1.Subscriber	subscribe(String subscription, com.google.cloud.pubsub.v1.MessageReceiver messageReceiver) Add a callback method to an existing subscription.

Method Detail

publish

<T> org.springframework.util.concurrent.ListenableFuture<String> publish(String topic,
                                                                         T payload,
                                                                         Map<String,String> headers)

Send a message to Pub/Sub.

Parameters:

topic - the name of an existing topic

payload - an object that will be serialized and sent

Returns:

the listenable future of the call

publish

<T> org.springframework.util.concurrent.ListenableFuture<String> publish(String topic,
                                                                         T payload)

Send a message to Pub/Sub.

Parameters:

topic - the name of an existing topic

payload - an object that will be serialized and sent

Returns:

the listenable future of the call

publish

org.springframework.util.concurrent.ListenableFuture<String> publish(String topic,
                                                                     com.google.pubsub.v1.PubsubMessage pubsubMessage)

Send a message to Pub/Sub.

Parameters:

topic - the name of an existing topic

pubsubMessage - a Google Cloud Pub/Sub API message

Returns:

the listenable future of the call

subscribe

com.google.cloud.pubsub.v1.Subscriber subscribe(String subscription,
                                                com.google.cloud.pubsub.v1.MessageReceiver messageReceiver)

Add a callback method to an existing subscription.

The created Subscriber is returned so it can be stopped.

Parameters:

subscription - the name of an existing subscription

messageReceiver - the callback method triggered when new messages arrive

Returns:

subscriber listening to new messages

pullAndAck

List<com.google.pubsub.v1.PubsubMessage> pullAndAck(String subscription,
                                                    Integer maxMessages,
                                                    Boolean returnImmediately)

Pull and auto-acknowledge a number of messages from a Google Cloud Pub/Sub subscription.

Parameters:

subscription - the subscription name

maxMessages - the maximum number of pulled messages

returnImmediately - returns immediately even if subscription doesn't contain enough messages to satisfy maxMessages

Returns:

the list of received messages

pull

List<AcknowledgeablePubsubMessage> pull(String subscription,
                                        Integer maxMessages,
                                        Boolean returnImmediately)

Pull a number of messages from a Google Cloud Pub/Sub subscription.

Parameters:

subscription - the subscription name

maxMessages - the maximum number of pulled messages

returnImmediately - returns immediately even if subscription doesn't contain enough messages to satisfy maxMessages

Returns:

the list of received acknowledgeable messages

pullNext

com.google.pubsub.v1.PubsubMessage pullNext(String subscription)

Pull and auto-acknowledge a message from a Google Cloud Pub/Sub subscription.

Parameters:

subscription - the subscription name

Returns:

a received message, or null if none exists in the subscription

ack

void ack(Collection<AcknowledgeablePubsubMessage> acknowledgeablePubsubMessages)

Acknowledge a batch of messages. The method will group the messages by subscription name and acknowledge them in batches if possible.

Parameters:

acknowledgeablePubsubMessages - messages to be acknowledged

nack

void nack(Collection<AcknowledgeablePubsubMessage> acknowledgeablePubsubMessages)

Negatively acknowledge a batch of messages. The method will group the messages by subscription name and acknowledge them in batches if possible.

Parameters:

acknowledgeablePubsubMessages - messages to be negatively acknowledged