Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ListAlertPoliciesRequest.
The protocol for theListAlertPoliciesrequest.
Generated from protobuf messagegoogle.monitoring.v3.ListAlertPoliciesRequest
Namespace
Google \ Cloud \ Monitoring \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. Theprojectwhose 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 theGetAlertPolicyoperation, 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, seesorting 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 thefilterfield. Entries can be prefixed with a minus sign to sort by the field in descending order. For more details, seesorting 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 thenextPageTokenvalue 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. Theprojectwhose
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 theGetAlertPolicyoperation, instead.
Returns
Type
Description
string
setName
Required. Theprojectwhose
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 theGetAlertPolicyoperation, instead.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. If provided, this field specifies the criteria that must be met
by alert policies to be included in the response.
Optional. A comma-separated list of fields by which to sort the result.
Supports the same set of field references as thefilterfield. Entries
can be prefixed with a minus sign to sort by the field in descending order.
For more details, seesorting 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 field references as thefilterfield. Entries
can be prefixed with a minus sign to sort by the field in descending order.
For more details, seesorting and
filtering.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of results to return in a single response.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of results to return in a single response.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. If this field is not empty then it must contain thenextPageTokenvalue 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
Optional. If this field is not empty then it must contain thenextPageTokenvalue 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. Theprojectwhose
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 theGetAlertPolicyoperation, instead.
[[["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 ListAlertPoliciesRequest (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-monitoring/latest/V3.ListAlertPoliciesRequest)\n- [2.1.1](/php/docs/reference/cloud-monitoring/2.1.1/V3.ListAlertPoliciesRequest)\n- [2.0.1](/php/docs/reference/cloud-monitoring/2.0.1/V3.ListAlertPoliciesRequest)\n- [1.12.1](/php/docs/reference/cloud-monitoring/1.12.1/V3.ListAlertPoliciesRequest)\n- [1.11.1](/php/docs/reference/cloud-monitoring/1.11.1/V3.ListAlertPoliciesRequest)\n- [1.10.3](/php/docs/reference/cloud-monitoring/1.10.3/V3.ListAlertPoliciesRequest)\n- [1.9.0](/php/docs/reference/cloud-monitoring/1.9.0/V3.ListAlertPoliciesRequest)\n- [1.8.0](/php/docs/reference/cloud-monitoring/1.8.0/V3.ListAlertPoliciesRequest)\n- [1.7.1](/php/docs/reference/cloud-monitoring/1.7.1/V3.ListAlertPoliciesRequest)\n- [1.6.0](/php/docs/reference/cloud-monitoring/1.6.0/V3.ListAlertPoliciesRequest)\n- [1.5.1](/php/docs/reference/cloud-monitoring/1.5.1/V3.ListAlertPoliciesRequest)\n- [1.4.0](/php/docs/reference/cloud-monitoring/1.4.0/V3.ListAlertPoliciesRequest)\n- [1.3.2](/php/docs/reference/cloud-monitoring/1.3.2/V3.ListAlertPoliciesRequest)\n- [1.2.2](/php/docs/reference/cloud-monitoring/1.2.2/V3.ListAlertPoliciesRequest) \nReference documentation and code samples for the Stackdriver Monitoring V3 Client class ListAlertPoliciesRequest.\n\nThe protocol for the `ListAlertPolicies` request.\n\nGenerated from protobuf message `google.monitoring.v3.ListAlertPoliciesRequest`\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) whose\nalert policies are to be listed. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]\nNote that this field names the parent container in which the alerting\npolicies to be listed are stored. To retrieve a single alerting policy\nby name, use the\n[GetAlertPolicy](/php/docs/reference/cloud-monitoring/latest/V3.Client.AlertPolicyServiceClient#_Google_Cloud_Monitoring_V3_Client_AlertPolicyServiceClient__getAlertPolicy__)\noperation, instead.\n\n### setName\n\nRequired. The\n[project](https://cloud.google.com/monitoring/api/v3#project_name) whose\nalert policies are to be listed. The format is:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]\nNote that this field names the parent container in which the alerting\npolicies to be listed are stored. To retrieve a single alerting policy\nby name, use the\n[GetAlertPolicy](/php/docs/reference/cloud-monitoring/latest/V3.Client.AlertPolicyServiceClient#_Google_Cloud_Monitoring_V3_Client_AlertPolicyServiceClient__getAlertPolicy__)\noperation, instead.\n\n### getFilter\n\nOptional. If provided, this field specifies the criteria that must be met\nby alert policies 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 alert policies 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 field references as the `filter` field. Entries\ncan be prefixed with a minus sign to sort by the field in descending 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 field references as the `filter` field. Entries\ncan be prefixed with a minus sign to sort by the field in descending 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.\n\n### setPageSize\n\nOptional. The maximum number of results to return in a single response.\n\n### getPageToken\n\nOptional. If this field is not empty then it must contain the\n`nextPageToken` value returned by a previous call to this method. Using\nthis field causes the method to return more results from the previous\nmethod call.\n\n### setPageToken\n\nOptional. If this field is not empty then it must contain the\n`nextPageToken` value returned by a previous call to this method. Using\nthis field causes the method to return more results from the previous\nmethod call.\n\n### static::build"]]
