public static interface SubscriberGrpc.AsyncService 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.
Methods
acknowledge(AcknowledgeRequest request, StreamObserver<Empty> responseObserver)
public default void acknowledge(AcknowledgeRequest request, StreamObserver<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.
| Parameters | |
|---|---|
| Name | Description |
request |
AcknowledgeRequest |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
createSnapshot(CreateSnapshotRequest request, StreamObserver<Snapshot> responseObserver)
public default void createSnapshot(CreateSnapshotRequest request, StreamObserver<Snapshot> responseObserver) Creates a snapshot from the requested subscription. Snapshots are used in
Seek operations,
which allow you to manage message acknowledgments in bulk. That is, you can
set the acknowledgment state of messages in an existing subscription to the
state captured by a snapshot.
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. The
generated name is populated in the returned Snapshot object. Note that for
REST API requests, you must specify a name in the request.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateSnapshotRequest |
responseObserver |
io.grpc.stub.StreamObserver<Snapshot> |
createSubscription(Subscription request, StreamObserver<Subscription> responseObserver)
public default void createSubscription(Subscription request, StreamObserver<Subscription> responseObserver) Creates a subscription to a given topic. See the resource name rules.
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. The
generated name is populated in the returned Subscription object. Note that
for REST API requests, you must specify a name in the request.
| Parameters | |
|---|---|
| Name | Description |
request |
Subscription |
responseObserver |
io.grpc.stub.StreamObserver<Subscription> |
deleteSnapshot(DeleteSnapshotRequest request, StreamObserver<Empty> responseObserver)
public default void deleteSnapshot(DeleteSnapshotRequest request, StreamObserver<Empty> responseObserver)Removes an existing snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. 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.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSnapshotRequest |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
deleteSubscription(DeleteSubscriptionRequest request, StreamObserver<Empty> responseObserver)
public default void deleteSubscription(DeleteSubscriptionRequest request, StreamObserver<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.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSubscriptionRequest |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
getSnapshot(GetSnapshotRequest request, StreamObserver<Snapshot> responseObserver)
public default void getSnapshot(GetSnapshotRequest request, StreamObserver<Snapshot> responseObserver)Gets the configuration details of a snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSnapshotRequest |
responseObserver |
io.grpc.stub.StreamObserver<Snapshot> |
getSubscription(GetSubscriptionRequest request, StreamObserver<Subscription> responseObserver)
public default void getSubscription(GetSubscriptionRequest request, StreamObserver<Subscription> responseObserver)Gets the configuration details of a subscription.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSubscriptionRequest |
responseObserver |
io.grpc.stub.StreamObserver<Subscription> |
listSnapshots(ListSnapshotsRequest request, StreamObserver<ListSnapshotsResponse> responseObserver)
public default void listSnapshots(ListSnapshotsRequest request, StreamObserver<ListSnapshotsResponse> responseObserver)Lists the existing snapshots. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
| Parameters | |
|---|---|
| Name | Description |
request |
ListSnapshotsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListSnapshotsResponse> |
listSubscriptions(ListSubscriptionsRequest request, StreamObserver<ListSubscriptionsResponse> responseObserver)
public default void listSubscriptions(ListSubscriptionsRequest request, StreamObserver<ListSubscriptionsResponse> responseObserver)Lists matching subscriptions.
| Parameters | |
|---|---|
| Name | Description |
request |
ListSubscriptionsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListSubscriptionsResponse> |
modifyAckDeadline(ModifyAckDeadlineRequest request, StreamObserver<Empty> responseObserver)
public default void modifyAckDeadline(ModifyAckDeadlineRequest request, StreamObserver<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.
| Parameters | |
|---|---|
| Name | Description |
request |
ModifyAckDeadlineRequest |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
modifyPushConfig(ModifyPushConfigRequest request, StreamObserver<Empty> responseObserver)
public default void modifyPushConfig(ModifyPushConfigRequest request, StreamObserver<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.
| Parameters | |
|---|---|
| Name | Description |
request |
ModifyPushConfigRequest |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
pull(PullRequest request, StreamObserver<PullResponse> responseObserver)
public default void pull(PullRequest request, StreamObserver<PullResponse> responseObserver)Pulls messages from the server.
| Parameters | |
|---|---|
| Name | Description |
request |
PullRequest |
responseObserver |
io.grpc.stub.StreamObserver<PullResponse> |
seek(SeekRequest request, StreamObserver<SeekResponse> responseObserver)
public default void seek(SeekRequest request, StreamObserver<SeekResponse> responseObserver)Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic.
| Parameters | |
|---|---|
| Name | Description |
request |
SeekRequest |
responseObserver |
io.grpc.stub.StreamObserver<SeekResponse> |
streamingPull(StreamObserver<StreamingPullResponse> responseObserver)
public default StreamObserver<StreamingPullRequest> streamingPull(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.
| Parameter | |
|---|---|
| Name | Description |
responseObserver |
io.grpc.stub.StreamObserver<StreamingPullResponse> |
| Returns | |
|---|---|
| Type | Description |
io.grpc.stub.StreamObserver<StreamingPullRequest> |
|
updateSnapshot(UpdateSnapshotRequest request, StreamObserver<Snapshot> responseObserver)
public default void updateSnapshot(UpdateSnapshotRequest request, StreamObserver<Snapshot> responseObserver)Updates an existing snapshot by updating the fields specified in the update mask. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateSnapshotRequest |
responseObserver |
io.grpc.stub.StreamObserver<Snapshot> |
updateSubscription(UpdateSubscriptionRequest request, StreamObserver<Subscription> responseObserver)
public default void updateSubscription(UpdateSubscriptionRequest request, StreamObserver<Subscription> responseObserver)Updates an existing subscription by updating the fields specified in the update mask. Note that certain properties of a subscription, such as its topic, are not modifiable.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateSubscriptionRequest |
responseObserver |
io.grpc.stub.StreamObserver<Subscription> |