class SubscriberGrpcClient extends BaseStub

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

Methods

__construct(string $hostname, array $opts, Channel $channel = null)

No description

CreateSubscription(Subscription $argument, array $metadata = [], array $options = [])

Creates a subscription to a given topic.

GetSubscription(GetSubscriptionRequest $argument, array $metadata = [], array $options = [])

Gets the configuration details of a subscription.

UpdateSubscription(UpdateSubscriptionRequest $argument, array $metadata = [], array $options = [])

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

ListSubscriptions(ListSubscriptionsRequest $argument, array $metadata = [], array $options = [])

Lists matching subscriptions.

DeleteSubscription(DeleteSubscriptionRequest $argument, array $metadata = [], array $options = [])

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(ModifyAckDeadlineRequest $argument, array $metadata = [], array $options = [])

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(AcknowledgeRequest $argument, array $metadata = [], array $options = [])

Acknowledges the messages associated with the ack_ids in the AcknowledgeRequest. The Pub/Sub system can remove the relevant messages from the subscription.

Pull(PullRequest $argument, array $metadata = [], array $options = [])

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(array $metadata = [], array $options = [])

(EXPERIMENTAL) StreamingPull is an experimental feature. This RPC will respond with UNIMPLEMENTED errors unless you have been invited to test this feature. Contact cloud-pubsub@google.com with any questions.

ModifyPushConfig(ModifyPushConfigRequest $argument, array $metadata = [], array $options = [])

Modifies the PushConfig for a specified subscription.

ListSnapshots(ListSnapshotsRequest $argument, array $metadata = [], array $options = [])

Lists the existing snapshots.

CreateSnapshot(CreateSnapshotRequest $argument, array $metadata = [], array $options = [])

Creates a snapshot from the requested subscription.

DeleteSnapshot(DeleteSnapshotRequest $argument, array $metadata = [], array $options = [])

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(SeekRequest $argument, array $metadata = [], array $options = [])

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

Details

at line 32
__construct(string $hostname, array $opts, Channel $channel = null)

Parameters

string $hostname hostname
array $opts channel options
Channel $channel (optional) re-use channel object

at line 51
CreateSubscription(Subscription $argument, array $metadata = [], array $options = [])

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

Subscription $argument input argument
array $metadata metadata
array $options call options

at line 65
GetSubscription(GetSubscriptionRequest $argument, array $metadata = [], array $options = [])

Gets the configuration details of a subscription.

Parameters

GetSubscriptionRequest $argument input argument
array $metadata metadata
array $options call options

at line 80
UpdateSubscription(UpdateSubscriptionRequest $argument, array $metadata = [], array $options = [])

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

Parameters

UpdateSubscriptionRequest $argument input argument
array $metadata metadata
array $options call options

at line 94
ListSubscriptions(ListSubscriptionsRequest $argument, array $metadata = [], array $options = [])

Lists matching subscriptions.

Parameters

ListSubscriptionsRequest $argument input argument
array $metadata metadata
array $options call options

at line 112
DeleteSubscription(DeleteSubscriptionRequest $argument, array $metadata = [], array $options = [])

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

DeleteSubscriptionRequest $argument input argument
array $metadata metadata
array $options call options

at line 130
ModifyAckDeadline(ModifyAckDeadlineRequest $argument, array $metadata = [], array $options = [])

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

ModifyAckDeadlineRequest $argument input argument
array $metadata metadata
array $options call options

at line 150
Acknowledge(AcknowledgeRequest $argument, array $metadata = [], array $options = [])

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

AcknowledgeRequest $argument input argument
array $metadata metadata
array $options call options

at line 167
Pull(PullRequest $argument, array $metadata = [], array $options = [])

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.

Parameters

PullRequest $argument input argument
array $metadata metadata
array $options call options

at line 191
StreamingPull(array $metadata = [], array $options = [])

(EXPERIMENTAL) StreamingPull is an experimental feature. This RPC will respond with UNIMPLEMENTED errors unless you have been invited to test this feature. Contact cloud-pubsub@google.com with any questions.

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 OK to reassign server-side resources, in which case, the client should re-establish the stream. UNAVAILABLE may also be returned in the case of a transient error (e.g., a server restart). These should also be retried by the client. Flow control can be achieved by configuring the underlying RPC channel.

Parameters

array $metadata metadata
array $options call options

at line 208
ModifyPushConfig(ModifyPushConfigRequest $argument, array $metadata = [], array $options = [])

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

ModifyPushConfigRequest $argument input argument
array $metadata metadata
array $options call options

at line 222
ListSnapshots(ListSnapshotsRequest $argument, array $metadata = [], array $options = [])

Lists the existing snapshots.

Parameters

ListSnapshotsRequest $argument input argument
array $metadata metadata
array $options call options

at line 245
CreateSnapshot(CreateSnapshotRequest $argument, array $metadata = [], array $options = [])

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

CreateSnapshotRequest $argument input argument
array $metadata metadata
array $options call options

at line 262
DeleteSnapshot(DeleteSnapshotRequest $argument, array $metadata = [], array $options = [])

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.

Parameters

DeleteSnapshotRequest $argument input argument
array $metadata metadata
array $options call options

at line 277
Seek(SeekRequest $argument, array $metadata = [], array $options = [])

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

Parameters

SeekRequest $argument input argument
array $metadata metadata
array $options call options