Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ListNotificationChannelsRequest.
The ListNotificationChannels request.
Generated from protobuf message google.monitoring.v3.ListNotificationChannelsRequest
Namespace
Google \ Cloud \ Monitoring \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation.
↳ filter
string
Optional. If provided, this field specifies the criteria that must be met by notification channels to be included in the response. For more details, see sorting and filtering.
↳ order_by
string
Optional. A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order. For more details, see sorting and filtering.
↳ page_size
int
Optional. The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.
↳ page_token
string
Optional. If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.
getName
Required. The
project on which
to execute the request. The format is:
projects/[PROJECT_ID_OR_NUMBER]
This names the container
in which to look for the notification channels; it does not name a
specific channel. To query a specific channel by REST resource name, use
the
GetNotificationChannel
operation.
Returns
Type
Description
string
setName
Required. The
project on which
to execute the request. The format is:
projects/[PROJECT_ID_OR_NUMBER]
This names the container
in which to look for the notification channels; it does not name a
specific channel. To query a specific channel by REST resource name, use
the
GetNotificationChannel
operation.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. If provided, this field specifies the criteria that must be met
by notification channels to be included in the response.
Optional. A comma-separated list of fields by which to sort the result.
Supports the same set of fields as in filter. Entries can be prefixed
with a minus sign to sort in descending rather than ascending order.
For more details, see sorting and
filtering.
Returns
Type
Description
string
setOrderBy
Optional. A comma-separated list of fields by which to sort the result.
Supports the same set of fields as in filter. Entries can be prefixed
with a minus sign to sort in descending rather than ascending order.
For more details, see sorting and
filtering.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of results to return in a single response. If
not set to a positive number, a reasonable value will be chosen by the
service.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of results to return in a single response. If
not set to a positive number, a reasonable value will be chosen by the
service.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. If non-empty, page_token must contain a value returned as the
next_page_token in a previous response to request the next set
of results.
Returns
Type
Description
string
setPageToken
Optional. If non-empty, page_token must contain a value returned as the
next_page_token in a previous response to request the next set
of results.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. The
project on which
to execute the request. The format is:
projects/[PROJECT_ID_OR_NUMBER]
This names the container
in which to look for the notification channels; it does not name a
specific channel. To query a specific channel by REST resource name, use
the
GetNotificationChannel
operation.
[[["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-04 UTC."],[],[],null,["# Stackdriver Monitoring V3 Client - Class ListNotificationChannelsRequest (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-monitoring/latest/V3.ListNotificationChannelsRequest)\n- [2.1.1](/php/docs/reference/cloud-monitoring/2.1.1/V3.ListNotificationChannelsRequest)\n- [2.0.1](/php/docs/reference/cloud-monitoring/2.0.1/V3.ListNotificationChannelsRequest)\n- [1.12.1](/php/docs/reference/cloud-monitoring/1.12.1/V3.ListNotificationChannelsRequest)\n- [1.11.1](/php/docs/reference/cloud-monitoring/1.11.1/V3.ListNotificationChannelsRequest)\n- [1.10.3](/php/docs/reference/cloud-monitoring/1.10.3/V3.ListNotificationChannelsRequest)\n- [1.9.0](/php/docs/reference/cloud-monitoring/1.9.0/V3.ListNotificationChannelsRequest)\n- [1.8.0](/php/docs/reference/cloud-monitoring/1.8.0/V3.ListNotificationChannelsRequest)\n- [1.7.1](/php/docs/reference/cloud-monitoring/1.7.1/V3.ListNotificationChannelsRequest)\n- [1.6.0](/php/docs/reference/cloud-monitoring/1.6.0/V3.ListNotificationChannelsRequest)\n- [1.5.1](/php/docs/reference/cloud-monitoring/1.5.1/V3.ListNotificationChannelsRequest)\n- [1.4.0](/php/docs/reference/cloud-monitoring/1.4.0/V3.ListNotificationChannelsRequest)\n- [1.3.2](/php/docs/reference/cloud-monitoring/1.3.2/V3.ListNotificationChannelsRequest)\n- [1.2.2](/php/docs/reference/cloud-monitoring/1.2.2/V3.ListNotificationChannelsRequest) \nReference documentation and code samples for the Stackdriver Monitoring V3 Client class ListNotificationChannelsRequest.\n\nThe `ListNotificationChannels` request.\n\nGenerated from protobuf message `google.monitoring.v3.ListNotificationChannelsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Monitoring \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The\n[project](https://cloud.google.com/monitoring/api/v3#project_name) on which\nto execute the request. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]\nThis names the container\nin which to look for the notification channels; it does not name a\nspecific channel. To query a specific channel by REST resource name, use\nthe\n[`GetNotificationChannel`](/php/docs/reference/cloud-monitoring/latest/V3.Client.NotificationChannelServiceClient#_Google_Cloud_Monitoring_V3_Client_NotificationChannelServiceClient__getNotificationChannel__)\noperation.\n\n### setName\n\nRequired. The\n[project](https://cloud.google.com/monitoring/api/v3#project_name) on which\nto execute the request. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]\nThis names the container\nin which to look for the notification channels; it does not name a\nspecific channel. To query a specific channel by REST resource name, use\nthe\n[`GetNotificationChannel`](/php/docs/reference/cloud-monitoring/latest/V3.Client.NotificationChannelServiceClient#_Google_Cloud_Monitoring_V3_Client_NotificationChannelServiceClient__getNotificationChannel__)\noperation.\n\n### getFilter\n\nOptional. If provided, this field specifies the criteria that must be met\nby notification channels to be included in the response.\n\nFor more details, see [sorting and\nfiltering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).\n\n### setFilter\n\nOptional. If provided, this field specifies the criteria that must be met\nby notification channels to be included in the response.\n\nFor more details, see [sorting and\nfiltering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).\n\n### getOrderBy\n\nOptional. A comma-separated list of fields by which to sort the result.\n\nSupports the same set of fields as in `filter`. Entries can be prefixed\nwith a minus sign to sort in descending rather than ascending order.\nFor more details, see [sorting and\nfiltering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).\n\n### setOrderBy\n\nOptional. A comma-separated list of fields by which to sort the result.\n\nSupports the same set of fields as in `filter`. Entries can be prefixed\nwith a minus sign to sort in descending rather than ascending order.\nFor more details, see [sorting and\nfiltering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).\n\n### getPageSize\n\nOptional. The maximum number of results to return in a single response. If\nnot set to a positive number, a reasonable value will be chosen by the\nservice.\n\n### setPageSize\n\nOptional. The maximum number of results to return in a single response. If\nnot set to a positive number, a reasonable value will be chosen by the\nservice.\n\n### getPageToken\n\nOptional. If non-empty, `page_token` must contain a value returned as the\n`next_page_token` in a previous response to request the next set\nof results.\n\n### setPageToken\n\nOptional. If non-empty, `page_token` must contain a value returned as the\n`next_page_token` in a previous response to request the next set\nof results.\n\n### static::build"]]
