Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ListNotificationChannelsRequest.
The ListNotificationChannels request.
Generated from protobuf message google.monitoring.v3.ListNotificationChannelsRequest
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 |
↳ filter |
string
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
A comma-separated list of fields by which to sort the result. Supports the same set of fields as in |
↳ page_size |
int
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
If non-empty, |
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.
Generated from protobuf field string name = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| 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.
Generated from protobuf field string name = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
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.
Generated from protobuf field string filter = 6;
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
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.
Generated from protobuf field string filter = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBy
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.
Generated from protobuf field string order_by = 7;
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
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.
Generated from protobuf field string order_by = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
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.
Generated from protobuf field int32 page_size = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
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.
Generated from protobuf field int32 page_size = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
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.
Generated from protobuf field string page_token = 4;
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
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.
Generated from protobuf field string page_token = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |