Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::ListServicesRequest.
The ListServices request.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#filter
deffilter()->::String
Returns
(::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
#filter=
deffilter=(value)->::String
Parameter
value (::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
Returns
(::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
defpage_size()->::Integer
Returns
(::Integer) — A non-negative number that is the maximum number of results to return.
When 0, use default page size.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — A non-negative number that is the maximum number of results to return.
When 0, use default page size.
Returns
(::Integer) — A non-negative number that is the maximum number of results to return.
When 0, use default page size.
#page_token
defpage_token()->::String
Returns
(::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.
#page_token=
defpage_token=(value)->::String
Parameter
value (::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.
Returns
(::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.
#parent
defparent()->::String
Returns
(::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,["# Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::ListServicesRequest (v1.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.6.1 (latest)](/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [1.6.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.6.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [1.5.1](/ruby/docs/reference/google-cloud-monitoring-v3/1.5.1/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [1.4.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.4.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.3.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.2.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.1.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-monitoring-v3/1.0.1/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [0.18.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.18.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [0.17.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.17.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.16.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [0.15.2](/ruby/docs/reference/google-cloud-monitoring-v3/0.15.2/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [0.14.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.14.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.13.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [0.12.1](/ruby/docs/reference/google-cloud-monitoring-v3/0.12.1/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.11.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.10.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.9.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.8.0/Google-Cloud-Monitoring-V3-ListServicesRequest)\n- [0.7.1](/ruby/docs/reference/google-cloud-monitoring-v3/0.7.1/Google-Cloud-Monitoring-V3-ListServicesRequest) \nReference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::ListServicesRequest.\n\nThe `ListServices` request. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A filter specifying what `Service`s to return. The filter supports filtering on a particular service-identifier type or one of its attributes.\n\n\n To filter on a particular service-identifier type, the `identifier_case`\n refers to which option in the `identifier` field is populated. For example,\n the filter `identifier_case = \"CUSTOM\"` would match all services with a\n value for the `custom` field. Valid options include \"CUSTOM\", \"APP_ENGINE\",\n \"MESH_ISTIO\", and the other options listed at\n https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service\n\n To filter on an attribute of a service-identifier type, apply the filter\n name by using the snake case of the service-identifier type and the\n attribute of that service-identifier type, and join the two with a period.\n For example, to filter by the `meshUid` field of the `MeshIstio`\n service-identifier type, you must filter on `mesh_istio.mesh_uid =\n \"123\"` to match all services with mesh UID \"123\". Service-identifier types\n and their attributes are described at\n https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A filter specifying what `Service`s to return. The filter supports filtering on a particular service-identifier type or one of its attributes.\n\n\n To filter on a particular service-identifier type, the `identifier_case`\n refers to which option in the `identifier` field is populated. For example,\n the filter `identifier_case = \"CUSTOM\"` would match all services with a\n value for the `custom` field. Valid options include \"CUSTOM\", \"APP_ENGINE\",\n \"MESH_ISTIO\", and the other options listed at\n https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service\n\n To filter on an attribute of a service-identifier type, apply the filter\n name by using the snake case of the service-identifier type and the\n attribute of that service-identifier type, and join the two with a period.\n For example, to filter by the `meshUid` field of the `MeshIstio`\n service-identifier type, you must filter on `mesh_istio.mesh_uid =\n \"123\"` to match all services with mesh UID \"123\". Service-identifier types\n and their attributes are described at\nhttps://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service \n**Returns**\n\n- (::String) --- A filter specifying what `Service`s to return. The filter supports filtering on a particular service-identifier type or one of its attributes.\n\n\n To filter on a particular service-identifier type, the `identifier_case`\n refers to which option in the `identifier` field is populated. For example,\n the filter `identifier_case = \"CUSTOM\"` would match all services with a\n value for the `custom` field. Valid options include \"CUSTOM\", \"APP_ENGINE\",\n \"MESH_ISTIO\", and the other options listed at\n https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service\n\n To filter on an attribute of a service-identifier type, apply the filter\n name by using the snake case of the service-identifier type and the\n attribute of that service-identifier type, and join the two with a period.\n For example, to filter by the `meshUid` field of the `MeshIstio`\n service-identifier type, you must filter on `mesh_istio.mesh_uid =\n \"123\"` to match all services with mesh UID \"123\". Service-identifier types\n and their attributes are described at\n https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- A non-negative number that is the maximum number of results to return. When 0, use default page size.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- A non-negative number that is the maximum number of results to return. When 0, use default page size. \n**Returns**\n\n- (::Integer) --- A non-negative number that is the maximum number of results to return. When 0, use default page size.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Resource name of the parent containing the listed services,\n either a [project](https://cloud.google.com/monitoring/api/v3#project_name)\n or a Monitoring Metrics Scope. The formats are:\n\n projects/[PROJECT_ID_OR_NUMBER]\n workspaces/[HOST_PROJECT_ID_OR_NUMBER]\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) ---\n\n Required. Resource name of the parent containing the listed services,\n either a [project](https://cloud.google.com/monitoring/api/v3#project_name)\n or a Monitoring Metrics Scope. The formats are: \n\n projects/[PROJECT_ID_OR_NUMBER]\n workspaces/[HOST_PROJECT_ID_OR_NUMBER]\n\n**Returns**\n\n- (::String) --- Required. Resource name of the parent containing the listed services,\n either a [project](https://cloud.google.com/monitoring/api/v3#project_name)\n or a Monitoring Metrics Scope. The formats are:\n\n projects/[PROJECT_ID_OR_NUMBER]\n workspaces/[HOST_PROJECT_ID_OR_NUMBER]"]]
