Show / Hide Table of Contents

Class ListSubscriptionsRequest

The request message for [SubscriptionsService.ListSubscriptions][google.apps.events.subscriptions.v1.SubscriptionsService.ListSubscriptions].

Inheritance
object
ListSubscriptionsRequest
Implements
IMessage<ListSubscriptionsRequest>
IEquatable<ListSubscriptionsRequest>
IDeepCloneable<ListSubscriptionsRequest>
IBufferMessage
IMessage
IPageRequest
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Apps.Events.Subscriptions.V1
Assembly: Google.Apps.Events.Subscriptions.V1.dll
Syntax
public sealed class ListSubscriptionsRequest : IMessage<ListSubscriptionsRequest>, IEquatable<ListSubscriptionsRequest>, IDeepCloneable<ListSubscriptionsRequest>, IBufferMessage, IMessage, IPageRequest

Constructors

ListSubscriptionsRequest()

Declaration
public ListSubscriptionsRequest()

ListSubscriptionsRequest(ListSubscriptionsRequest)

Declaration
public ListSubscriptionsRequest(ListSubscriptionsRequest other)
Parameters
Type Name Description
ListSubscriptionsRequest other

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
public string Filter { get; set; }
Property Value
Type Description
string

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
public int PageSize { get; set; }
Property Value
Type Description
int
Implements
IPageRequest.PageSize

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
public string PageToken { get; set; }
Property Value
Type Description
string
Implements
IPageRequest.PageToken
In this article
Back to top Generated by DocFX