Generated from protobuf message google.apps.events.subscriptions.v1beta.ListSubscriptionsRequest
Namespace
Google \ Apps \ Events \ Subscriptions \ V1beta
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Apps Events Subscriptions V1beta Client - Class ListSubscriptionsRequest (0.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.3.1 (latest)](/php/docs/reference/apps-events-subscriptions/latest/V1beta.ListSubscriptionsRequest)\n- [0.3.0](/php/docs/reference/apps-events-subscriptions/0.3.0/V1beta.ListSubscriptionsRequest)\n- [0.2.1](/php/docs/reference/apps-events-subscriptions/0.2.1/V1beta.ListSubscriptionsRequest)\n- [0.1.6](/php/docs/reference/apps-events-subscriptions/0.1.6/V1beta.ListSubscriptionsRequest) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Apps Events Subscriptions V1beta Client class ListSubscriptionsRequest.\n\nThe request message for\n[SubscriptionsService.ListSubscriptions](/php/docs/reference/apps-events-subscriptions/latest/V1beta.Client.SubscriptionsServiceClient#_Google_Apps_Events_Subscriptions_V1beta_Client_SubscriptionsServiceClient__listSubscriptions__).\n\nGenerated from protobuf message `google.apps.events.subscriptions.v1beta.ListSubscriptionsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Apps \\\\ Events \\\\ Subscriptions \\\\ V1beta\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPageSize\n\nOptional. The maximum number of subscriptions to return. The service might\nreturn fewer than this value.\n\nIf unspecified or set to `0`, up to 50 subscriptions are returned.\nThe maximum value is 100. If you specify a value more than 100, the system\nonly returns 100 subscriptions.\n\n### setPageSize\n\nOptional. The maximum number of subscriptions to return. The service might\nreturn fewer than this value.\n\nIf unspecified or set to `0`, up to 50 subscriptions are returned.\nThe maximum value is 100. If you specify a value more than 100, the system\nonly returns 100 subscriptions.\n\n### getPageToken\n\nOptional. A page token, received from a previous list subscriptions call.\n\nProvide this parameter to retrieve the subsequent page.\nWhen paginating, the filter value should match the call that provided the\npage token. Passing a different value might lead to unexpected results.\n\n### setPageToken\n\nOptional. A page token, received from a previous list subscriptions call.\n\nProvide this parameter to retrieve the subsequent page.\nWhen paginating, the filter value should match the call that provided the\npage token. Passing a different value might lead to unexpected results.\n\n### getFilter\n\nRequired. A query filter.\n\nYou can filter subscriptions by event type (`event_types`)\nand target resource (`target_resource`).\nYou must specify at least one event type in your query. To filter for\nmultiple event types, use the `OR` operator.\nTo filter by both event type and target resource, use the `AND` operator\nand specify the full resource name, such as\n`//chat.googleapis.com/spaces/{space}`.\nFor example, the following queries are valid: \n\n event_types:\"google.workspace.chat.membership.v1.updated\" OR\n event_types:\"google.workspace.chat.message.v1.created\"\n event_types:\"google.workspace.chat.message.v1.created\" AND\n target_resource=\"//chat.googleapis.com/spaces/{space}\"\n ( event_types:\"google.workspace.chat.membership.v1.updated\" OR\n event_types:\"google.workspace.chat.message.v1.created\" ) AND\n target_resource=\"//chat.googleapis.com/spaces/{space}\"\n\nThe server rejects invalid queries with an `INVALID_ARGUMENT`\nerror.\n\n### setFilter\n\nRequired. A query filter.\n\nYou can filter subscriptions by event type (`event_types`)\nand target resource (`target_resource`).\nYou must specify at least one event type in your query. To filter for\nmultiple event types, use the `OR` operator.\nTo filter by both event type and target resource, use the `AND` operator\nand specify the full resource name, such as\n`//chat.googleapis.com/spaces/{space}`.\nFor example, the following queries are valid: \n\n event_types:\"google.workspace.chat.membership.v1.updated\" OR\n event_types:\"google.workspace.chat.message.v1.created\"\n event_types:\"google.workspace.chat.message.v1.created\" AND\n target_resource=\"//chat.googleapis.com/spaces/{space}\"\n ( event_types:\"google.workspace.chat.membership.v1.updated\" OR\n event_types:\"google.workspace.chat.message.v1.created\" ) AND\n target_resource=\"//chat.googleapis.com/spaces/{space}\"\n\nThe server rejects invalid queries with an `INVALID_ARGUMENT`\nerror.\n\n### static::build"]]
