Show / Hide Table of Contents

Class ProjectsResource.SubscribersResource.SubscriptionsResource

The "subscriptions" collection of methods.

Inheritance
object
ProjectsResource.SubscribersResource.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.GoogleHealthAPI.v4
Assembly: Google.Apis.GoogleHealthAPI.v4.dll
Syntax
public class ProjectsResource.SubscribersResource.SubscriptionsResource

Constructors

SubscriptionsResource(IClientService)

Constructs a new resource.

Declaration
public SubscriptionsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(CreateSubscriptionPayload, string)

Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a SubscriptionCreatePolicy set to MANUAL for the given data types.

Declaration
public virtual ProjectsResource.SubscribersResource.SubscriptionsResource.CreateRequest Create(CreateSubscriptionPayload body, string parent)
Parameters
Type Name Description
CreateSubscriptionPayload body

The body of the request.

string parent

Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /a-z/) if provided during creation, or system-generated otherwise.

Returns
Type Description
ProjectsResource.SubscribersResource.SubscriptionsResource.CreateRequest

Delete(string)

Deletes a specific user subscription, stopping notifications for this user to this subscriber.

Declaration
public virtual ProjectsResource.SubscribersResource.SubscriptionsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The resource name of the subscription to delete. Format: projects/{project}/subscribers/{subscriber}/subscriptions/{subscription} Example: projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456 The {subscriber} ID is user-settable (4-36 characters, matching /a-z/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 characters, matching /a-z/) or system-generated if not provided during creation.

Returns
Type Description
ProjectsResource.SubscribersResource.SubscriptionsResource.DeleteRequest

List(string)

Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.

Declaration
public virtual ProjectsResource.SubscribersResource.SubscriptionsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /a-z/) if provided during creation, or system-generated otherwise.

Returns
Type Description
ProjectsResource.SubscribersResource.SubscriptionsResource.ListRequest

Patch(Subscription, string)

Updates the data types for an existing user subscription.

Declaration
public virtual ProjectsResource.SubscribersResource.SubscriptionsResource.PatchRequest Patch(Subscription body, string name)
Parameters
Type Name Description
Subscription body

The body of the request.

string name

Identifier. The resource name of the Subscription. Format: projects/{project}/subscribers/{subscriber}/subscriptions/{subscription} Example: projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456 The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /a-z/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /a-z/) or system-generated otherwise.

Returns
Type Description
ProjectsResource.SubscribersResource.SubscriptionsResource.PatchRequest
In this article
Back to top Generated by DocFX