org.springframework.cloud.gcp.pubsub.support

Interface SubscriberFactory

All Known Implementing Classes:

DefaultSubscriberFactory

public interface SubscriberFactory

Interface used by the PubSubTemplate to create supporting objects for consuming messages from Pub/Sub subscriptions.

Author:

João André Martins, Mike Eltsufin, Artem Bilan, Doug Hoard, Chengyuan Zhao, Maurice Zeijen

Method Summary

Modifier and Type	Method and Description
com.google.pubsub.v1.PullRequest	createPullRequest(String subscriptionName, Integer maxMessages, Boolean returnImmediately) Create a PullRequest for synchronously pulling a number of messages from a Google Cloud Pub/Sub subscription.
Subscriber	createSubscriber(String subscriptionName, MessageReceiver receiver) Create a Subscriber for the specified subscription name and wired it up to asynchronously deliver messages to the provided MessageReceiver.
SubscriberStub	createSubscriberStub() Create a SubscriberStub that is needed to execute PullRequests.
String	getProjectId() Method to get the project id.

Method Detail

getProjectId

String getProjectId()

Method to get the project id.

Returns:

the project id

Since:

1.1

createSubscriber

Subscriber createSubscriber(String subscriptionName,
                            MessageReceiver receiver)

Create a Subscriber for the specified subscription name and wired it up to asynchronously deliver messages to the provided MessageReceiver.

Parameters:

subscriptionName - the name of the subscription

receiver - the callback for receiving messages asynchronously

Returns:

the Subscriber that was created to bind the receiver to the subscription

createPullRequest

com.google.pubsub.v1.PullRequest createPullRequest(String subscriptionName,
                                                   Integer maxMessages,
                                                   Boolean returnImmediately)

Create a PullRequest for synchronously pulling a number of messages from a Google Cloud Pub/Sub subscription.

Parameters:

subscriptionName - the name of the subscription

maxMessages - the maximum number of pulled messages; must be greater than zero. If null is passed in, then up to Integer.MAX_VALUE messages will be requested.

returnImmediately - causes the pull request to return immediately even if subscription doesn't contain enough messages to satisfy maxMessages

Returns:

the pull request that can be executed using a SubscriberStub

createSubscriberStub

SubscriberStub createSubscriberStub()

Create a SubscriberStub that is needed to execute PullRequests.

Returns:

the SubscriberStub used for executing PullRequests