Google Apps Events Subscriptions V1 Client - Class ListSubscriptionsRequest (0.1.2)

Reference documentation and code samples for the Google Apps Events Subscriptions V1 Client class ListSubscriptionsRequest.

The request message for SubscriptionsService.ListSubscriptions.

Generated from protobuf message google.apps.events.subscriptions.v1.ListSubscriptionsRequest

Namespace

Google \ Apps \ Events \ Subscriptions \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ page_size int

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.

↳ page_token string

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.

↳ filter string

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.

getPageSize

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.

Returns
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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.

Returns
Type Description
string

setPageToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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.

Returns
Type Description
string

setFilter

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.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
filter string

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.

Returns
Type Description
Google\Apps\Events\Subscriptions\V1\ListSubscriptionsRequest