com.google.pubsub.v1

Class SubscriberGrpc.SubscriberFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<SubscriberGrpc.SubscriberFutureStub>

com.google.pubsub.v1.SubscriberGrpc.SubscriberFutureStub

Enclosing class:

SubscriberGrpc

public static final class SubscriberGrpc.SubscriberFutureStub
extends io.grpc.stub.AbstractStub<SubscriberGrpc.SubscriberFutureStub>

 The service that an application uses to manipulate subscriptions and to
 consume messages from a subscription via the `Pull` method.
 

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	acknowledge(AcknowledgeRequest request) Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`.
protected SubscriberGrpc.SubscriberFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Snapshot>	createSnapshot(CreateSnapshotRequest request) Creates a snapshot from the requested subscription.
com.google.common.util.concurrent.ListenableFuture<Subscription>	createSubscription(Subscription request) Creates a subscription to a given topic.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteSnapshot(DeleteSnapshotRequest request) Removes an existing snapshot.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteSubscription(DeleteSubscriptionRequest request) Deletes an existing subscription.
com.google.common.util.concurrent.ListenableFuture<Subscription>	getSubscription(GetSubscriptionRequest request) Gets the configuration details of a subscription.
com.google.common.util.concurrent.ListenableFuture<ListSnapshotsResponse>	listSnapshots(ListSnapshotsRequest request) Lists the existing snapshots.
com.google.common.util.concurrent.ListenableFuture<ListSubscriptionsResponse>	listSubscriptions(ListSubscriptionsRequest request) Lists matching subscriptions.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	modifyAckDeadline(ModifyAckDeadlineRequest request) Modifies the ack deadline for a specific message.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	modifyPushConfig(ModifyPushConfigRequest request) Modifies the `PushConfig` for a specified subscription.
com.google.common.util.concurrent.ListenableFuture<PullResponse>	pull(PullRequest request) Pulls messages from the server.
com.google.common.util.concurrent.ListenableFuture<SeekResponse>	seek(SeekRequest request) Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.
com.google.common.util.concurrent.ListenableFuture<Subscription>	updateSubscription(UpdateSubscriptionRequest request) Updates an existing subscription.

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected SubscriberGrpc.SubscriberFutureStub build(io.grpc.Channel channel,
                                                    io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<SubscriberGrpc.SubscriberFutureStub>

createSubscription

public com.google.common.util.concurrent.ListenableFuture<Subscription> createSubscription(Subscription request)

 Creates a subscription to a given topic.
 If the subscription already exists, returns `ALREADY_EXISTS`.
 If the corresponding topic doesn't exist, returns `NOT_FOUND`.
 If the name is not provided in the request, the server will assign a random
 name for this subscription on the same project as the topic, conforming
 to the
 [resource name format](https://cloud.google.com/pubsub/docs/overview#names).
 The generated name is populated in the returned Subscription object.
 Note that for REST API requests, you must specify a name in the request.
 

getSubscription

public com.google.common.util.concurrent.ListenableFuture<Subscription> getSubscription(GetSubscriptionRequest request)

 Gets the configuration details of a subscription.
 

updateSubscription

public com.google.common.util.concurrent.ListenableFuture<Subscription> updateSubscription(UpdateSubscriptionRequest request)

 Updates an existing subscription. Note that certain properties of a
 subscription, such as its topic, are not modifiable.
 

listSubscriptions

public com.google.common.util.concurrent.ListenableFuture<ListSubscriptionsResponse> listSubscriptions(ListSubscriptionsRequest request)

 Lists matching subscriptions.
 

deleteSubscription

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteSubscription(DeleteSubscriptionRequest request)

 Deletes an existing subscription. All messages retained in the subscription
 are immediately dropped. Calls to `Pull` after deletion will return
 `NOT_FOUND`. After a subscription is deleted, a new one may be created with
 the same name, but the new one has no association with the old
 subscription or its topic unless the same topic is specified.
 

modifyAckDeadline

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> modifyAckDeadline(ModifyAckDeadlineRequest request)

 Modifies the ack deadline for a specific message. This method is useful
 to indicate that more time is needed to process a message by the
 subscriber, or to make the message available for redelivery if the
 processing was interrupted. Note that this does not modify the
 subscription-level `ackDeadlineSeconds` used for subsequent messages.
 

acknowledge

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> acknowledge(AcknowledgeRequest request)

 Acknowledges the messages associated with the `ack_ids` in the
 `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
 from the subscription.
 Acknowledging a message whose ack deadline has expired may succeed,
 but such a message may be redelivered later. Acknowledging a message more
 than once will not result in an error.
 

pull

public com.google.common.util.concurrent.ListenableFuture<PullResponse> pull(PullRequest request)

 Pulls messages from the server. Returns an empty list if there are no
 messages available in the backlog. The server may return `UNAVAILABLE` if
 there are too many concurrent pull requests pending for the given
 subscription.
 

modifyPushConfig

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> modifyPushConfig(ModifyPushConfigRequest request)

 Modifies the `PushConfig` for a specified subscription.
 This may be used to change a push subscription to a pull one (signified by
 an empty `PushConfig`) or vice versa, or change the endpoint URL and other
 attributes of a push subscription. Messages will accumulate for delivery
 continuously through the call regardless of changes to the `PushConfig`.
 

listSnapshots

public com.google.common.util.concurrent.ListenableFuture<ListSnapshotsResponse> listSnapshots(ListSnapshotsRequest request)

 Lists the existing snapshots.
 

createSnapshot

public com.google.common.util.concurrent.ListenableFuture<Snapshot> createSnapshot(CreateSnapshotRequest request)

 Creates a snapshot from the requested subscription.
 If the snapshot already exists, returns `ALREADY_EXISTS`.
 If the requested subscription doesn't exist, returns `NOT_FOUND`.
 If the name is not provided in the request, the server will assign a random
 name for this snapshot on the same project as the subscription, conforming
 to the
 [resource name format](https://cloud.google.com/pubsub/docs/overview#names).
 The generated name is populated in the returned Snapshot object.
 Note that for REST API requests, you must specify a name in the request.
 

deleteSnapshot

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteSnapshot(DeleteSnapshotRequest request)

 Removes an existing snapshot. All messages retained in the snapshot
 are immediately dropped. After a snapshot is deleted, a new one may be
 created with the same name, but the new one has no association with the old
 snapshot or its subscription, unless the same subscription is specified.
 

seek

public com.google.common.util.concurrent.ListenableFuture<SeekResponse> seek(SeekRequest request)

 Seeks an existing subscription to a point in time or to a given snapshot,
 whichever is provided in the request.