Class ProjectsResource.SubscribersResource.SubscriptionsResource.ListRequest
Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.
Inheritance
Inherited Members
Namespace: Google.Apis.GoogleHealthAPI.v4
Assembly: Google.Apis.GoogleHealthAPI.v4.dll
Syntax
public class ProjectsResource.SubscribersResource.SubscriptionsResource.ListRequest : GoogleHealthAPIBaseServiceRequest<ListSubscriptionsResponse>, IClientServiceRequest<ListSubscriptionsResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| string | parent |
Properties
Filter
Optional. A filter to apply to the list of subscriptions. The filter syntax is described in
https://google.aip.dev/160. The filter can be applied to the following fields: - user -
data_type The user identifier (e.g., user1 in users/user1) refers to the public
health_user_id Example: user = "users/user1" Example: user = "users/user1" OR user =
"users/user2" Example: user = "users/user1" AND (data_type = "sleep" OR data_type = "weight")
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
PageSize
Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
PageToken
Optional. A page token, received from a previous ListSubscriptions call. Provide this to
retrieve the subsequent page. When paginating, all other parameters provided to
ListSubscriptions must match the call that provided the page token.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
| Type | 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.
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
| Type | Description |
|---|---|
| string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
| Type | Description |
|---|---|
| string |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()