Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ListServicesRequest.
The ListServices
request.
Generated from protobuf message google.monitoring.v3.ListServicesRequest
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 Workspace. The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER] |
↳ filter |
string
A filter specifying what |
↳ 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 |
getParent
Required. Resource name of the parent containing the listed services, either a project or a Monitoring Workspace. The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
Returns | |
---|---|
Type | Description |
string |
setParent
Required. Resource name of the parent containing the listed services, either a project or a Monitoring Workspace. The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
A filter specifying what Service
s to return. The filter currently
supports the following fields:
identifier_case
app_engine.module_id
cloud_endpoints.service
(reserved for future use)mesh_istio.mesh_uid
mesh_istio.service_namespace
mesh_istio.service_name
cluster_istio.location
(deprecated)cluster_istio.cluster_name
(deprecated)cluster_istio.service_namespace
(deprecated)cluster_istio.service_name
(deprecated)identifier_case
refers to which option in the identifier oneof is populated. For example, the filteridentifier_case = "CUSTOM"
would match all services with a value for thecustom
field. Valid options are "CUSTOM", "APP_ENGINE", "MESH_ISTIO", plus "CLUSTER_ISTIO" (deprecated) and "CLOUD_ENDPOINTS" (reserved for future use).
Generated from protobuf field string filter = 2;
Returns | |
---|---|
Type | Description |
string |
setFilter
A filter specifying what Service
s to return. The filter currently
supports the following fields:
identifier_case
app_engine.module_id
cloud_endpoints.service
(reserved for future use)mesh_istio.mesh_uid
mesh_istio.service_namespace
mesh_istio.service_name
cluster_istio.location
(deprecated)cluster_istio.cluster_name
(deprecated)cluster_istio.service_namespace
(deprecated)cluster_istio.service_name
(deprecated)identifier_case
refers to which option in the identifier oneof is populated. For example, the filteridentifier_case = "CUSTOM"
would match all services with a value for thecustom
field. Valid options are "CUSTOM", "APP_ENGINE", "MESH_ISTIO", plus "CLUSTER_ISTIO" (deprecated) and "CLOUD_ENDPOINTS" (reserved for future use).
Generated from protobuf field string filter = 2;
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.
Generated from protobuf field int32 page_size = 3;
Returns | |
---|---|
Type | Description |
int |
setPageSize
A non-negative number that is the maximum number of results to return.
When 0, use default page size.
Generated from protobuf field int32 page_size = 3;
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.
Generated from protobuf field string page_token = 4;
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.
Generated from protobuf field string page_token = 4;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |