Class AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource

The "subscriptions" collection of methods.

Inheritance

object

AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.PubsubLite.v1

Assembly: Google.Apis.PubsubLite.v1.dll

Syntax

public class AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource

Constructors

SubscriptionsResource(IClientService)

Constructs a new resource.

Declaration

public SubscriptionsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(Subscription, string)

Creates a new subscription.

Declaration

public virtual AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.CreateRequest Create(Subscription body, string parent)

Parameters

Type	Name	Description
Subscription	body	The body of the request.
string	parent	Required. The parent location in which to create the subscription. Structured like projects/{project_number}/locations/{location}.

Returns

Type	Description
AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.CreateRequest

Delete(string)

Deletes the specified subscription.

Declaration

public virtual AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the subscription to delete.

Returns

Type	Description
AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.DeleteRequest

Get(string)

Returns the subscription configuration.

Declaration

public virtual AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the subscription whose configuration to return.

Returns

Type	Description
AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.GetRequest

List(string)

Returns the list of subscriptions for the given project.

Declaration

public virtual AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.ListRequest List(string parent)

Parameters

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

Returns

Type	Description
AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.ListRequest

Patch(Subscription, string)

Updates properties of the specified subscription.

Declaration

public virtual AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.PatchRequest Patch(Subscription body, string name)

Parameters

Type	Name	Description
Subscription	body	The body of the request.
string	name	The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

Returns

Type	Description
AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.PatchRequest

Seek(SeekSubscriptionRequest, string)

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.

Declaration

public virtual AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.SeekRequest Seek(SeekSubscriptionRequest body, string name)

Parameters

Type	Name	Description
SeekSubscriptionRequest	body	The body of the request.
string	name	Required. The name of the subscription to seek.

Returns

Type	Description
AdminResource.ProjectsResource.LocationsResource.SubscriptionsResource.SeekRequest