Stackdriver Monitoring V3 Client - Class ListNotificationChannelsRequest (2.2.1)

Version latest

• 2.2.1 (latest)
• 2.2.0
• 2.1.2
• 2.0.1
• 1.12.1
• 1.11.1
• 1.10.3
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.1
• 1.4.0
• 1.3.2
• 1.2.2

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.

For more details, see sorting and filtering.

Returns
Type	Description
string

setFilter

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getOrderBy

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.

Returns
Type	Description
ListNotificationChannelsRequest