class AdminProjectsLocationsSubscriptions extends Resource (View source)

The "subscriptions" collection of methods.

Typical usage is:

 $pubsubliteService = new Google\Service\PubsubLite(...);
 $subscriptions = $pubsubliteService->admin_projects_locations_subscriptions;

Methods

create(string $parent, Subscription $postBody, array $optParams = [])

Creates a new subscription. (subscriptions.create)

delete(string $name, array $optParams = [])

Deletes the specified subscription. (subscriptions.delete)

get(string $name, array $optParams = [])

Returns the subscription configuration. (subscriptions.get)

listAdminProjectsLocationsSubscriptions(string $parent, array $optParams = [])

Returns the list of subscriptions for the given project.

patch(string $name, Subscription $postBody, array $optParams = [])

Updates properties of the specified subscription. (subscriptions.patch)

seek(string $name, SeekSubscriptionRequest $postBody, array $optParams = [])

Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it. (subscriptions.seek)

Details

Subscription create(string $parent, Subscription $postBody, array $optParams = [])

Creates a new subscription. (subscriptions.create)

Parameters

string $parent

Required. The parent location in which to create the subscription. Structured like projects/{project_number}/locations/{location}.

Subscription $postBody
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

PubsubliteEmpty delete(string $name, array $optParams = [])

Deletes the specified subscription. (subscriptions.delete)

Parameters

string $name

Required. The name of the subscription to delete.

array $optParams

Optional parameters.

Return Value

PubsubliteEmpty

Exceptions

Exception

Subscription get(string $name, array $optParams = [])

Returns the subscription configuration. (subscriptions.get)

Parameters

string $name

Required. The name of the subscription whose configuration to return.

array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

ListSubscriptionsResponse listAdminProjectsLocationsSubscriptions(string $parent, array $optParams = [])

Returns the list of subscriptions for the given project.

(subscriptions.listAdminProjectsLocationsSubscriptions)

Parameters

string $parent

Required. The parent whose subscriptions are to be listed. Structured like projects/{project_number}/locations/{location}.

array $optParams

Optional parameters.

Return Value

ListSubscriptionsResponse

Exceptions

Exception

Subscription patch(string $name, Subscription $postBody, array $optParams = [])

Updates properties of the specified subscription. (subscriptions.patch)

Parameters

string $name

The name of the subscription. Structured like: projects/{ project_number}/locations/{location}/subscriptions/{subscription_id}

Subscription $postBody
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

Operation seek(string $name, SeekSubscriptionRequest $postBody, array $optParams = [])

Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it. (subscriptions.seek)

Parameters

string $name

Required. The name of the subscription to seek.

SeekSubscriptionRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception