Class SubscriptionsResource.ListRequest
Developer Preview: Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions.
Inheritance
Inherited Members
Namespace: Google.Apis.WorkspaceEvents.v1
Assembly: Google.Apis.WorkspaceEvents.v1.dll
Syntax
public class SubscriptionsResource.ListRequest : WorkspaceEventsBaseServiceRequest<ListSubscriptionsResponse>, IClientServiceRequest<ListSubscriptionsResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService)
Constructs a new List request.
Declaration
public ListRequest(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Properties
Filter
Required. A query filter. You can filter subscriptions by event type (event_types
) and target resource
(target_resource
). You must specify at least one event type in your query. To filter for multiple
event types, use the OR
operator. To filter by both event type and target resource, use the AND
operator and specify the full resource name, such as //chat.googleapis.com/spaces/{space}
. For
example, the following queries are valid:
event_types:"google.workspace.chat.membership.v1.updated"
OR event_types:"google.workspace.chat.message.v1.created"
event_types:"google.workspace.chat.message.v1.created" AND
target_resource="//chat.googleapis.com/spaces/{space}" (
event_types:"google.workspace.chat.membership.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created" ) AND
target_resource="//chat.googleapis.com/spaces/{space}"
The server rejects invalid queries with an
INVALID_ARGUMENT
error.
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 might return fewer than this value.
If unspecified or set to 0
, up to 50 subscriptions are returned. The maximum value is 100. If you
specify a value more than 100, the system only returns 100 subscriptions.
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 list subscriptions call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
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()