Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ListServicesRequest.
The ListServices request.
Generated from protobuf message google.monitoring.v3.ListServicesRequest
Namespace
Google \ Cloud \ Monitoring \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. Resource name of the parent containing the listed services, either a project or a Monitoring Metrics Scope. The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]
↳ filter
string
A filter specifying what Services to return. The filter supports filtering on a particular service-identifier type or one of its attributes. To filter on a particular service-identifier type, the identifier_case refers to which option in the identifier field is populated. For example, the filter identifier_case = "CUSTOM" would match all services with a value for the custom field. Valid options include "CUSTOM", "APP_ENGINE", "MESH_ISTIO", and the other options listed at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service To filter on an attribute of a service-identifier type, apply the filter name by using the snake case of the service-identifier type and the attribute of that service-identifier type, and join the two with a period. For example, to filter by the meshUid field of the MeshIstio service-identifier type, you must filter on mesh_istio.mesh_uid = "123" to match all services with mesh UID "123". Service-identifier types and their attributes are described at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service
↳ page_size
int
A non-negative number that is the maximum number of results to return. When 0, use default page size.
↳ page_token
string
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 additional results from the previous method call.
getParent
Required. Resource name of the parent containing the listed services,
either a project
or a Monitoring Metrics Scope. The formats are:
projects/[PROJECT_ID_OR_NUMBER]
workspaces/[HOST_PROJECT_ID_OR_NUMBER]
Returns
Type
Description
string
setParent
Required. Resource name of the parent containing the listed services,
either a project
or a Monitoring Metrics Scope. The formats are:
projects/[PROJECT_ID_OR_NUMBER]
workspaces/[HOST_PROJECT_ID_OR_NUMBER]
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
A filter specifying what Services to return. The filter supports
filtering on a particular service-identifier type or one of its attributes.
To filter on a particular service-identifier type, the identifier_case
refers to which option in the identifier field is populated. For example,
the filter identifier_case = "CUSTOM" would match all services with a
value for the custom field. Valid options include "CUSTOM", "APP_ENGINE",
"MESH_ISTIO", and the other options listed at
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service
To filter on an attribute of a service-identifier type, apply the filter
name by using the snake case of the service-identifier type and the
attribute of that service-identifier type, and join the two with a period.
For example, to filter by the meshUid field of the MeshIstio
service-identifier type, you must filter on mesh_istio.mesh_uid =
"123" to match all services with mesh UID "123". Service-identifier types
and their attributes are described at
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service
Returns
Type
Description
string
setFilter
A filter specifying what Services to return. The filter supports
filtering on a particular service-identifier type or one of its attributes.
To filter on a particular service-identifier type, the identifier_case
refers to which option in the identifier field is populated. For example,
the filter identifier_case = "CUSTOM" would match all services with a
value for the custom field. Valid options include "CUSTOM", "APP_ENGINE",
"MESH_ISTIO", and the other options listed at
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service
To filter on an attribute of a service-identifier type, apply the filter
name by using the snake case of the service-identifier type and the
attribute of that service-identifier type, and join the two with a period.
For example, to filter by the meshUid field of the MeshIstio
service-identifier type, you must filter on mesh_istio.mesh_uid =
"123" to match all services with mesh UID "123". Service-identifier types
and their attributes are described at
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
A non-negative number that is the maximum number of results to return.
When 0, use default page size.
Returns
Type
Description
int
setPageSize
A non-negative number that is the maximum number of results to return.
When 0, use default page size.
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 additional 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 additional results from the previous method call.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. Resource name of the parent containing the listed services,
either a project
or a Monitoring Metrics Scope. The formats are:
[[["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 ListServicesRequest (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-monitoring/latest/V3.ListServicesRequest)\n- [2.1.1](/php/docs/reference/cloud-monitoring/2.1.1/V3.ListServicesRequest)\n- [2.0.1](/php/docs/reference/cloud-monitoring/2.0.1/V3.ListServicesRequest)\n- [1.12.1](/php/docs/reference/cloud-monitoring/1.12.1/V3.ListServicesRequest)\n- [1.11.1](/php/docs/reference/cloud-monitoring/1.11.1/V3.ListServicesRequest)\n- [1.10.3](/php/docs/reference/cloud-monitoring/1.10.3/V3.ListServicesRequest)\n- [1.9.0](/php/docs/reference/cloud-monitoring/1.9.0/V3.ListServicesRequest)\n- [1.8.0](/php/docs/reference/cloud-monitoring/1.8.0/V3.ListServicesRequest)\n- [1.7.1](/php/docs/reference/cloud-monitoring/1.7.1/V3.ListServicesRequest)\n- [1.6.0](/php/docs/reference/cloud-monitoring/1.6.0/V3.ListServicesRequest)\n- [1.5.1](/php/docs/reference/cloud-monitoring/1.5.1/V3.ListServicesRequest)\n- [1.4.0](/php/docs/reference/cloud-monitoring/1.4.0/V3.ListServicesRequest)\n- [1.3.2](/php/docs/reference/cloud-monitoring/1.3.2/V3.ListServicesRequest)\n- [1.2.2](/php/docs/reference/cloud-monitoring/1.2.2/V3.ListServicesRequest) \nReference documentation and code samples for the Stackdriver Monitoring V3 Client class ListServicesRequest.\n\nThe `ListServices` request.\n\nGenerated from protobuf message `google.monitoring.v3.ListServicesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Monitoring \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Resource name of the parent containing the listed services,\neither a [project](https://cloud.google.com/monitoring/api/v3#project_name)\nor a Monitoring Metrics Scope. The formats are:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]\nworkspaces/\\[HOST_PROJECT_ID_OR_NUMBER\\]\n\n### setParent\n\nRequired. Resource name of the parent containing the listed services,\neither a [project](https://cloud.google.com/monitoring/api/v3#project_name)\nor a Monitoring Metrics Scope. The formats are:\nprojects/\\[PROJECT_ID_OR_NUMBER\\]\nworkspaces/\\[HOST_PROJECT_ID_OR_NUMBER\\]\n\n### getFilter\n\nA filter specifying what `Service`s to return. The filter supports\nfiltering on a particular service-identifier type or one of its attributes.\n\nTo filter on a particular service-identifier type, the `identifier_case`\nrefers to which option in the `identifier` field is populated. For example,\nthe filter `identifier_case = \"CUSTOM\"` would match all services with a\nvalue for the `custom` field. Valid options include \"CUSTOM\", \"APP_ENGINE\",\n\"MESH_ISTIO\", and the other options listed at\n\u003chttps://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service\u003e\nTo filter on an attribute of a service-identifier type, apply the filter\nname by using the snake case of the service-identifier type and the\nattribute of that service-identifier type, and join the two with a period.\nFor example, to filter by the `meshUid` field of the `MeshIstio`\nservice-identifier type, you must filter on `mesh_istio.mesh_uid =\n\"123\"` to match all services with mesh UID \"123\". Service-identifier types\nand their attributes are described at\n\u003chttps://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service\u003e\n\n### setFilter\n\nA filter specifying what `Service`s to return. The filter supports\nfiltering on a particular service-identifier type or one of its attributes.\n\nTo filter on a particular service-identifier type, the `identifier_case`\nrefers to which option in the `identifier` field is populated. For example,\nthe filter `identifier_case = \"CUSTOM\"` would match all services with a\nvalue for the `custom` field. Valid options include \"CUSTOM\", \"APP_ENGINE\",\n\"MESH_ISTIO\", and the other options listed at\n\u003chttps://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service\u003e\nTo filter on an attribute of a service-identifier type, apply the filter\nname by using the snake case of the service-identifier type and the\nattribute of that service-identifier type, and join the two with a period.\nFor example, to filter by the `meshUid` field of the `MeshIstio`\nservice-identifier type, you must filter on `mesh_istio.mesh_uid =\n\"123\"` to match all services with mesh UID \"123\". Service-identifier types\nand their attributes are described at\n\u003chttps://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service\u003e\n\n### getPageSize\n\nA non-negative number that is the maximum number of results to return.\n\nWhen 0, use default page size.\n\n### setPageSize\n\nA non-negative number that is the maximum number of results to return.\n\nWhen 0, use default page size.\n\n### getPageToken\n\nIf this field is not empty then it must contain the `nextPageToken` value\nreturned by a previous call to this method. Using this field causes the\nmethod to return additional results from the previous method call.\n\n### setPageToken\n\nIf this field is not empty then it must contain the `nextPageToken` value\nreturned by a previous call to this method. Using this field causes the\nmethod to return additional results from the previous method call.\n\n### static::build"]]
