Class SubscriberGrpc.SubscriberBlockingStub (1.118.0)

public static final class SubscriberGrpc.SubscriberBlockingStub extends AbstractBlockingStub<SubscriberGrpc.SubscriberBlockingStub>

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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > SubscriberGrpc.SubscriberBlockingStub

Methods

acknowledge(AcknowledgeRequest request)

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

Parameter
NameDescription
requestAcknowledgeRequest
Returns
TypeDescription
Empty

build(Channel channel, CallOptions callOptions)

protected SubscriberGrpc.SubscriberBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
SubscriberGrpc.SubscriberBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createSnapshot(CreateSnapshotRequest request)

public Snapshot createSnapshot(CreateSnapshotRequest request)

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.

Parameter
NameDescription
requestCreateSnapshotRequest
Returns
TypeDescription
Snapshot

createSubscription(Subscription request)

public Subscription createSubscription(Subscription request)

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.

Parameter
NameDescription
requestSubscription
Returns
TypeDescription
Subscription

deleteSnapshot(DeleteSnapshotRequest request)

public Empty deleteSnapshot(DeleteSnapshotRequest request)

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.

Parameter
NameDescription
requestDeleteSnapshotRequest
Returns
TypeDescription
Empty

deleteSubscription(DeleteSubscriptionRequest request)

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

Parameter
NameDescription
requestDeleteSubscriptionRequest
Returns
TypeDescription
Empty

getSnapshot(GetSnapshotRequest request)

public Snapshot getSnapshot(GetSnapshotRequest request)

Gets the configuration details of a snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>; 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.

Parameter
NameDescription
requestGetSnapshotRequest
Returns
TypeDescription
Snapshot

getSubscription(GetSubscriptionRequest request)

public Subscription getSubscription(GetSubscriptionRequest request)

Gets the configuration details of a subscription.

Parameter
NameDescription
requestGetSubscriptionRequest
Returns
TypeDescription
Subscription

listSnapshots(ListSnapshotsRequest request)

public ListSnapshotsResponse listSnapshots(ListSnapshotsRequest request)

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.

Parameter
NameDescription
requestListSnapshotsRequest
Returns
TypeDescription
ListSnapshotsResponse

listSubscriptions(ListSubscriptionsRequest request)

public ListSubscriptionsResponse listSubscriptions(ListSubscriptionsRequest request)

Lists matching subscriptions.

Parameter
NameDescription
requestListSubscriptionsRequest
Returns
TypeDescription
ListSubscriptionsResponse

modifyAckDeadline(ModifyAckDeadlineRequest request)

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

Parameter
NameDescription
requestModifyAckDeadlineRequest
Returns
TypeDescription
Empty

modifyPushConfig(ModifyPushConfigRequest request)

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

Parameter
NameDescription
requestModifyPushConfigRequest
Returns
TypeDescription
Empty

pull(PullRequest request)

public PullResponse pull(PullRequest request)

Pulls messages from the server. The server may return UNAVAILABLE if there are too many concurrent pull requests pending for the given subscription.

Parameter
NameDescription
requestPullRequest
Returns
TypeDescription
PullResponse

seek(SeekRequest request)

public SeekResponse seek(SeekRequest request)

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.

Parameter
NameDescription
requestSeekRequest
Returns
TypeDescription
SeekResponse

updateSnapshot(UpdateSnapshotRequest request)

public Snapshot updateSnapshot(UpdateSnapshotRequest request)

Updates an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>; 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.

Parameter
NameDescription
requestUpdateSnapshotRequest
Returns
TypeDescription
Snapshot

updateSubscription(UpdateSubscriptionRequest request)

public Subscription updateSubscription(UpdateSubscriptionRequest request)

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

Parameter
NameDescription
requestUpdateSubscriptionRequest
Returns
TypeDescription
Subscription