Class ProjectsResource.SubscriptionsResource

The "subscriptions" collection of methods.

Inheritance

object

ProjectsResource.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.Pubsub.v1

Assembly: Google.Apis.Pubsub.v1.dll

Syntax

public class ProjectsResource.SubscriptionsResource

Constructors

SubscriptionsResource(IClientService)

Constructs a new resource.

Declaration

public SubscriptionsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Acknowledge(AcknowledgeRequest, string)

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.

Declaration

public virtual ProjectsResource.SubscriptionsResource.AcknowledgeRequest Acknowledge(AcknowledgeRequest body, string subscription)

Parameters

Type	Name	Description
AcknowledgeRequest	body	The body of the request.
string	subscription	Required. The subscription whose message is being acknowledged. Format is projects/{project}/subscriptions/{sub}.

Returns

Type	Description
ProjectsResource.SubscriptionsResource.AcknowledgeRequest

Create(Subscription, string)

Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). 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] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

Declaration

public virtual ProjectsResource.SubscriptionsResource.CreateRequest Create(Subscription body, string name)

Parameters

Type	Name	Description
Subscription	body	The body of the request.
string	name	Required. The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".

Returns

Type	Description
ProjectsResource.SubscriptionsResource.CreateRequest

Delete(string)

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.

Declaration

public virtual ProjectsResource.SubscriptionsResource.DeleteRequest Delete(string subscription)

Parameters

Type	Name	Description
string	subscription	Required. The subscription to delete. Format is projects/{project}/subscriptions/{sub}.

Returns

Type	Description
ProjectsResource.SubscriptionsResource.DeleteRequest

Detach(string)

Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop.

Declaration

public virtual ProjectsResource.SubscriptionsResource.DetachRequest Detach(string subscription)

Parameters

Type	Name	Description
string	subscription	Required. The subscription to detach. Format is projects/{project}/subscriptions/{subscription}.

Returns

Type	Description
ProjectsResource.SubscriptionsResource.DetachRequest

Get(string)

Gets the configuration details of a subscription.

Declaration

public virtual ProjectsResource.SubscriptionsResource.GetRequest Get(string subscription)

Parameters

Type	Name	Description
string	subscription	Required. The name of the subscription to get. Format is projects/{project}/subscriptions/{sub}.

Returns

Type	Description
ProjectsResource.SubscriptionsResource.GetRequest

GetIamPolicy(string)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Declaration

public virtual ProjectsResource.SubscriptionsResource.GetIamPolicyRequest GetIamPolicy(string resource)

Parameters

Type	Name	Description
string	resource	REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.SubscriptionsResource.GetIamPolicyRequest

List(string)

Lists matching subscriptions.

Declaration

public virtual ProjectsResource.SubscriptionsResource.ListRequest List(string project)

Parameters

Type	Name	Description
string	project	Required. The name of the project in which to list subscriptions. Format is projects/{project-id}.

Returns

Type	Description
ProjectsResource.SubscriptionsResource.ListRequest

ModifyAckDeadline(ModifyAckDeadlineRequest, string)

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.

Declaration

public virtual ProjectsResource.SubscriptionsResource.ModifyAckDeadlineRequest ModifyAckDeadline(ModifyAckDeadlineRequest body, string subscription)

Parameters

Type	Name	Description
ModifyAckDeadlineRequest	body	The body of the request.
string	subscription	Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.

Returns

Type	Description
ProjectsResource.SubscriptionsResource.ModifyAckDeadlineRequest

ModifyPushConfig(ModifyPushConfigRequest, string)

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.

Declaration

public virtual ProjectsResource.SubscriptionsResource.ModifyPushConfigRequest ModifyPushConfig(ModifyPushConfigRequest body, string subscription)

Parameters

Type	Name	Description
ModifyPushConfigRequest	body	The body of the request.
string	subscription	Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.

Returns

Type	Description
ProjectsResource.SubscriptionsResource.ModifyPushConfigRequest

Patch(UpdateSubscriptionRequest, string)

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.

Declaration

public virtual ProjectsResource.SubscriptionsResource.PatchRequest Patch(UpdateSubscriptionRequest body, string name)

Parameters

Type	Name	Description
UpdateSubscriptionRequest	body	The body of the request.
string	name	Required. The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".

Returns

Type	Description
ProjectsResource.SubscriptionsResource.PatchRequest

Pull(PullRequest, string)

Pulls messages from the server.

Declaration

public virtual ProjectsResource.SubscriptionsResource.PullRequest Pull(PullRequest body, string subscription)

Parameters

Type	Name	Description
PullRequest	body	The body of the request.
string	subscription	Required. The subscription from which messages should be pulled. Format is projects/{project}/subscriptions/{sub}.

Returns

Type	Description
ProjectsResource.SubscriptionsResource.PullRequest

Seek(SeekRequest, string)

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] (https://cloud.google.com/pubsub/docs/replay-overview) 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.

Declaration

public virtual ProjectsResource.SubscriptionsResource.SeekRequest Seek(SeekRequest body, string subscription)

Parameters

Type	Name	Description
SeekRequest	body	The body of the request.
string	subscription	Required. The subscription to affect.

Returns

Type	Description
ProjectsResource.SubscriptionsResource.SeekRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Declaration

public virtual ProjectsResource.SubscriptionsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
SetIamPolicyRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.SubscriptionsResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Declaration

public virtual ProjectsResource.SubscriptionsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)

Parameters

Type	Name	Description
TestIamPermissionsRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.SubscriptionsResource.TestIamPermissionsRequest