Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ListAlertPoliciesRequest.
The protocol for the ListAlertPolicies
request.
Generated from protobuf message google.monitoring.v3.ListAlertPoliciesRequest
Namespace
Google \ Cloud \ Monitoring \ V3Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The project whose alert policies are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.
↳ filter
string
Optional. If provided, this field specifies the criteria that must be met by alert policies 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 field references as the filter
field. Entries can be prefixed with a minus sign to sort by the field in descending order. For more details, see sorting and filtering
.
↳ page_size
int
Optional. The maximum number of results to return in a single response.
↳ page_token
string
Optional. If this field is not empty then it must contain the nextPageToken
value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.
getName
Required. The project whose alert policies are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.
string
setName
Required. The project whose alert policies are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.
var
string
$this
getFilter
Optional. If provided, this field specifies the criteria that must be met by alert policies to be included in the response.
For more details, see sorting and filtering .
string
setFilter
Optional. If provided, this field specifies the criteria that must be met by alert policies to be included in the response.
For more details, see sorting and filtering .
var
string
$this
getOrderBy
Optional. A comma-separated list of fields by which to sort the result.
Supports the same set of field references as the filter
field. Entries
can be prefixed with a minus sign to sort by the field in descending order.
For more details, see sorting and
filtering
.
string
setOrderBy
Optional. A comma-separated list of fields by which to sort the result.
Supports the same set of field references as the filter
field. Entries
can be prefixed with a minus sign to sort by the field in descending order.
For more details, see sorting and
filtering
.
var
string
$this
getPageSize
Optional. The maximum number of results to return in a single response.
int
setPageSize
Optional. The maximum number of results to return in a single response.
var
int
$this
getPageToken
Optional. If this field is not empty then it must contain the nextPageToken
value returned by a previous call to this method. Using
this field causes the method to return more results from the previous
method call.
string
setPageToken
Optional. If this field is not empty then it must contain the nextPageToken
value returned by a previous call to this method. Using
this field causes the method to return more results from the previous
method call.
var
string
$this
static::build
name
string
Required. The project whose alert policies are to be listed. The format is:
projects/[PROJECT_ID_OR_NUMBER]
Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.