com.google.pubsub.v1

Class SubscriberGrpc.SubscriberStub

java.lang.Object

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

com.google.pubsub.v1.SubscriberGrpc.SubscriberStub

Enclosing class:

SubscriberGrpc

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

 The service that an application uses to manipulate subscriptions and to
 consume messages from a subscription via the `Pull` method or by
 establishing a bi-directional stream using the `StreamingPull` method.
 

Method Summary

Modifier and Type	Method and Description
void	acknowledge(AcknowledgeRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`.
protected SubscriberGrpc.SubscriberStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	createSnapshot(CreateSnapshotRequest request, io.grpc.stub.StreamObserver<Snapshot> responseObserver) Creates a snapshot from the requested subscription.<br><br> <b>ALPHA:</b> This feature is part of an alpha release.
void	createSubscription(Subscription request, io.grpc.stub.StreamObserver<Subscription> responseObserver) Creates a subscription to a given topic.
void	deleteSnapshot(DeleteSnapshotRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Removes an existing snapshot.
void	deleteSubscription(DeleteSubscriptionRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes an existing subscription.
void	getSnapshot(GetSnapshotRequest request, io.grpc.stub.StreamObserver<Snapshot> responseObserver) Gets the configuration details of a snapshot.<br><br> <b>ALPHA:</b> This feature is part of an alpha release.
void	getSubscription(GetSubscriptionRequest request, io.grpc.stub.StreamObserver<Subscription> responseObserver) Gets the configuration details of a subscription.
void	listSnapshots(ListSnapshotsRequest request, io.grpc.stub.StreamObserver<ListSnapshotsResponse> responseObserver) Lists the existing snapshots.<br><br> <b>ALPHA:</b> This feature is part of an alpha release.
void	listSubscriptions(ListSubscriptionsRequest request, io.grpc.stub.StreamObserver<ListSubscriptionsResponse> responseObserver) Lists matching subscriptions.
void	modifyAckDeadline(ModifyAckDeadlineRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Modifies the ack deadline for a specific message.
void	modifyPushConfig(ModifyPushConfigRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Modifies the `PushConfig` for a specified subscription.
void	pull(PullRequest request, io.grpc.stub.StreamObserver<PullResponse> responseObserver) Pulls messages from the server.
void	seek(SeekRequest request, io.grpc.stub.StreamObserver<SeekResponse> responseObserver) Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.<br><br> <b>ALPHA:</b> This feature is part of an alpha release.
io.grpc.stub.StreamObserver<StreamingPullRequest>	streamingPull(io.grpc.stub.StreamObserver<StreamingPullResponse> responseObserver) Establishes a stream with the server, which sends messages down to the client.
void	updateSnapshot(UpdateSnapshotRequest request, io.grpc.stub.StreamObserver<Snapshot> responseObserver) Updates an existing snapshot.<br><br> <b>ALPHA:</b> This feature is part of an alpha release.
void	updateSubscription(UpdateSubscriptionRequest request, io.grpc.stub.StreamObserver<Subscription> responseObserver) Updates an existing subscription.

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, 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.SubscriberStub build(io.grpc.Channel channel,
                                              io.grpc.CallOptions callOptions)

Specified by:

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

createSubscription

public void createSubscription(Subscription request,
                               io.grpc.stub.StreamObserver<Subscription> responseObserver)

 Creates a subscription to a given topic. See the
 <a href="/pubsub/docs/admin#resource_names"> resource name rules</a>.
 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 void getSubscription(GetSubscriptionRequest request,
                            io.grpc.stub.StreamObserver<Subscription> responseObserver)

 Gets the configuration details of a subscription.
 

updateSubscription

public void updateSubscription(UpdateSubscriptionRequest request,
                               io.grpc.stub.StreamObserver<Subscription> responseObserver)

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

listSubscriptions

public void listSubscriptions(ListSubscriptionsRequest request,
                              io.grpc.stub.StreamObserver<ListSubscriptionsResponse> responseObserver)

 Lists matching subscriptions.
 

deleteSubscription

public void deleteSubscription(DeleteSubscriptionRequest request,
                               io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 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 void modifyAckDeadline(ModifyAckDeadlineRequest request,
                              io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 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 void acknowledge(AcknowledgeRequest request,
                        io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 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 void pull(PullRequest request,
                 io.grpc.stub.StreamObserver<PullResponse> responseObserver)

 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.
 

streamingPull

public io.grpc.stub.StreamObserver<StreamingPullRequest> streamingPull(io.grpc.stub.StreamObserver<StreamingPullResponse> responseObserver)

 Establishes a stream with the server, which sends messages down to the
 client. The client streams acknowledgements and ack deadline modifications
 back to the server. The server will close the stream and return the status
 on any error. The server may close the stream with status `UNAVAILABLE` to
 reassign server-side resources, in which case, the client should
 re-establish the stream. Flow control can be achieved by configuring the
 underlying RPC channel.
 

modifyPushConfig

public void modifyPushConfig(ModifyPushConfigRequest request,
                             io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 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`.
 

getSnapshot

public void getSnapshot(GetSnapshotRequest request,
                        io.grpc.stub.StreamObserver<Snapshot> responseObserver)

 Gets the configuration details of a snapshot.<br><br>
 <b>ALPHA:</b> This feature is part of an alpha release. This API might be
 changed in backward-incompatible ways and is not recommended for production
 use. It is not subject to any SLA or deprecation policy.
 

listSnapshots

public void listSnapshots(ListSnapshotsRequest request,
                          io.grpc.stub.StreamObserver<ListSnapshotsResponse> responseObserver)

 Lists the existing snapshots.<br><br>
 <b>ALPHA:</b> This feature is part of an alpha release. This API might be
 changed in backward-incompatible ways and is not recommended for production
 use. It is not subject to any SLA or deprecation policy.
 

createSnapshot

public void createSnapshot(CreateSnapshotRequest request,
                           io.grpc.stub.StreamObserver<Snapshot> responseObserver)

 Creates a snapshot from the requested subscription.<br><br>
 <b>ALPHA:</b> This feature is part of an alpha release. This API might be
 changed in backward-incompatible ways and is not recommended for production
 use. It is not subject to any SLA or deprecation policy.
 If the snapshot already exists, returns `ALREADY_EXISTS`.
 If the requested subscription doesn't exist, returns `NOT_FOUND`.
 If the backlog in the subscription is too old -- and the resulting snapshot
 would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned.
 See also the `Snapshot.expire_time` field. 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.
 

updateSnapshot

public void updateSnapshot(UpdateSnapshotRequest request,
                           io.grpc.stub.StreamObserver<Snapshot> responseObserver)

 Updates an existing snapshot.<br><br>
 <b>ALPHA:</b> This feature is part of an alpha release. This API might be
 changed in backward-incompatible ways and is not recommended for production
 use. It is not subject to any SLA or deprecation policy.
 Note that certain properties of a snapshot are not modifiable.
 

deleteSnapshot

public void deleteSnapshot(DeleteSnapshotRequest request,
                           io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 Removes an existing snapshot. <br><br>
 <b>ALPHA:</b> This feature is part of an alpha release. This API might be
 changed in backward-incompatible ways and is not recommended for production
 use. It is not subject to any SLA or deprecation policy.
 When the snapshot is deleted, 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 void seek(SeekRequest request,
                 io.grpc.stub.StreamObserver<SeekResponse> responseObserver)

 Seeks an existing subscription to a point in time or to a given snapshot,
 whichever is provided in the request.<br><br>
 <b>ALPHA:</b> This feature is part of an alpha release. This API might be
 changed in backward-incompatible ways and is not recommended for production
 use. It is not subject to any SLA or deprecation policy.