com.google.cloud.pubsub.spi

Interface PubSubRpc

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DefaultPubSubRpc

public interface PubSubRpc
extends AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PubSubRpc.PullCallback A callback that can be registered to PubSubRpc.PullFuture objects.
static interface	PubSubRpc.PullFuture A Future implementation for pull RPCs.

Method Summary

Methods

Modifier and Type	Method and Description
Future<com.google.protobuf.Empty>	acknowledge(com.google.pubsub.v1.AcknowledgeRequest request) Sends a request to acknowledge messages for a subscription.
Future<com.google.pubsub.v1.Subscription>	create(com.google.pubsub.v1.Subscription subscription) Sends a request to create a subscription.
Future<com.google.pubsub.v1.Topic>	create(com.google.pubsub.v1.Topic topic) Sends a request to create a topic.
Future<com.google.protobuf.Empty>	delete(com.google.pubsub.v1.DeleteSubscriptionRequest request) Sends a request to delete a subscription.
Future<com.google.protobuf.Empty>	delete(com.google.pubsub.v1.DeleteTopicRequest request) Sends a request to delete a topic.
Future<com.google.pubsub.v1.Subscription>	get(com.google.pubsub.v1.GetSubscriptionRequest request) Sends a request to get a subscription.
Future<com.google.pubsub.v1.Topic>	get(com.google.pubsub.v1.GetTopicRequest request) Sends a request to get a topic.
Future<com.google.pubsub.v1.ListSubscriptionsResponse>	list(com.google.pubsub.v1.ListSubscriptionsRequest request) Sends a request to list the subscriptions in a project.
Future<com.google.pubsub.v1.ListTopicsResponse>	list(com.google.pubsub.v1.ListTopicsRequest request) Sends a request to list the topics in a project.
Future<com.google.pubsub.v1.ListTopicSubscriptionsResponse>	list(com.google.pubsub.v1.ListTopicSubscriptionsRequest request) Sends a request to list the subscriptions for a topic.
Future<com.google.protobuf.Empty>	modify(com.google.pubsub.v1.ModifyAckDeadlineRequest request) Sends a request to modify the acknowledge deadline of a subscription.
Future<com.google.protobuf.Empty>	modify(com.google.pubsub.v1.ModifyPushConfigRequest request) Sends a request to modify the push configuration of a subscription.
Future<com.google.pubsub.v1.PublishResponse>	publish(com.google.pubsub.v1.PublishRequest request) Sends a request to publish messages.
PubSubRpc.PullFuture	pull(com.google.pubsub.v1.PullRequest request) Sends a request to pull messages from a subscription.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

Future<com.google.pubsub.v1.Topic> create(com.google.pubsub.v1.Topic topic)

Sends a request to create a topic. This method returns a Future object to consume the result. Future.get() returns the created topic.

Parameters:

topic - the topic to create

publish

Future<com.google.pubsub.v1.PublishResponse> publish(com.google.pubsub.v1.PublishRequest request)

Sends a request to publish messages. This method returns a Future object to consume the result. Future.get() returns a response object containing the publish result.

Parameters:

request - the request object containing all of the parameters for the API call

get

Future<com.google.pubsub.v1.Topic> get(com.google.pubsub.v1.GetTopicRequest request)

Sends a request to get a topic. This method returns a Future object to consume the result. Future.get() returns the requested topic or null if not found.

Parameters:

request - the request object containing all of the parameters for the API call

list

Future<com.google.pubsub.v1.ListTopicsResponse> list(com.google.pubsub.v1.ListTopicsRequest request)

Sends a request to list the topics in a project. This method returns a Future object to consume the result. Future.get() returns a response object containing the listing result.

Parameters:

request - the request object containing all of the parameters for the API call

list

Future<com.google.pubsub.v1.ListTopicSubscriptionsResponse> list(com.google.pubsub.v1.ListTopicSubscriptionsRequest request)

Sends a request to list the subscriptions for a topic. This method returns a Future object to consume the result. Future.get() returns a response object containing the listing result.

Parameters:

request - the request object containing all of the parameters for the API call

delete

Future<com.google.protobuf.Empty> delete(com.google.pubsub.v1.DeleteTopicRequest request)

Sends a request to delete a topic. This method returns a Future object to consume the result. Future.get() returns Empty.getDefaultInstance() or null if the topic was not found.

Parameters:

request - the request object containing all of the parameters for the API call

create

Future<com.google.pubsub.v1.Subscription> create(com.google.pubsub.v1.Subscription subscription)

Sends a request to create a subscription. This method returns a Future object to consume the result. Future.get() returns the created subscription.

Parameters:

subscription - the subscription to create

get

Future<com.google.pubsub.v1.Subscription> get(com.google.pubsub.v1.GetSubscriptionRequest request)

Sends a request to get a subscription. This method returns a Future object to consume the result. Future.get() returns the requested subscription or null if not found.

Parameters:

request - the request object containing all of the parameters for the API call

list

Future<com.google.pubsub.v1.ListSubscriptionsResponse> list(com.google.pubsub.v1.ListSubscriptionsRequest request)

Sends a request to list the subscriptions in a project. This method returns a Future object to consume the result. Future.get() returns a response object containing the listing result.

Parameters:

request - the request object containing all of the parameters for the API call

delete

Future<com.google.protobuf.Empty> delete(com.google.pubsub.v1.DeleteSubscriptionRequest request)

Sends a request to delete a subscription. This method returns a Future object to consume the result. Future.get() returns Empty.getDefaultInstance() or null if the subscription was not found.

Parameters:

request - the request object containing all of the parameters for the API call

modify

Future<com.google.protobuf.Empty> modify(com.google.pubsub.v1.ModifyAckDeadlineRequest request)

Sends a request to modify the acknowledge deadline of a subscription. This method returns a Future object to consume the result. Future.get() returns Empty.getDefaultInstance() if the request was issued correctly.

Parameters:

request - the request object containing all of the parameters for the API call

acknowledge

Future<com.google.protobuf.Empty> acknowledge(com.google.pubsub.v1.AcknowledgeRequest request)

Sends a request to acknowledge messages for a subscription. This method returns a Future object to consume the result. Future.get() returns Empty.getDefaultInstance() if the request was issued correctly.

Parameters:

request - the request object containing all of the parameters for the API call

pull

PubSubRpc.PullFuture pull(com.google.pubsub.v1.PullRequest request)

Sends a request to pull messages from a subscription. This method returns a PubSubRpc.PullFuture object to consume the result. Future.get() returns a response object containing the pulled messages. PullFuture#addCallback(PullCallback) can be used to register a callback for the request's completion.

Parameters:

request - the request object containing all of the parameters for the API call

modify

Future<com.google.protobuf.Empty> modify(com.google.pubsub.v1.ModifyPushConfigRequest request)

Sends a request to modify the push configuration of a subscription. This method returns a Future object to consume the result. Future.get() returns Empty.getDefaultInstance() if the request was issued correctly.

Parameters:

request - the request object containing all of the parameters for the API call