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 \ V3Methods
__construct
Constructor.
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 Service
s 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]
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]
var
string
$this
getFilter
A filter specifying what Service
s 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
string
setFilter
A filter specifying what Service
s 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
var
string
$this
getPageSize
A non-negative number that is the maximum number of results to return.
When 0, use default page size.
int
setPageSize
A non-negative number that is the maximum number of results to return.
When 0, use default page size.
var
int
$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.
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.
var
string
$this
static::build
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]