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.
| Parameters | |
|---|---|
| Name | Description |
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
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
A comma-separated list of fields by which to sort the result. Supports the same set of field references as the |
↳ page_size |
int
The maximum number of results to return in a single response. |
↳ page_token |
string
If this field is not empty then it must contain the |
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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
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.
| 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 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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
The maximum number of results to return in a single response.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
The maximum number of results to return in a single response.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
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. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Monitoring\V3\ListAlertPoliciesRequest |
|