| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="monitoring_v3.html">Cloud Monitoring API</a> . <a href="monitoring_v3.services.html">services</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="monitoring_v3.services.serviceLevelObjectives.html">serviceLevelObjectives()</a></code> |
| </p> |
| <p class="firstline">Returns the serviceLevelObjectives Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, serviceId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Create a Service.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Soft delete this Service.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get the named Service.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">List Services for this Metrics Scope.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update this Service.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, serviceId=None, x__xgafv=None)</code> |
| <pre>Create a Service. |
| |
| Args: |
| parent: string, Required. Resource name (https://cloud.google.com/monitoring/api/v3#project_name) of the parent Metrics Scope. The format is: projects/[PROJECT_ID_OR_NUMBER] (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia (https://en.wikipedia.org/wiki/Service-orientation)). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible. |
| "appEngine": { # App Engine service. Learn more at https://cloud.google.com/appengine. # Type used for App Engine services. |
| "moduleId": "A String", # The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource (https://cloud.google.com/monitoring/api/resources#tag_gae_app). |
| }, |
| "basicService": { # A well-known service type, defined by its service type and service labels. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). # Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| "serviceLabels": { # Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this Service. Documentation and valid values for given service types here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| "a_key": "A String", |
| }, |
| "serviceType": "A String", # The type of service that this basic service defines, e.g. APP_ENGINE service type. Documentation and valid values here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| }, |
| "cloudEndpoints": { # Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints. # Type used for Cloud Endpoints services. |
| "service": "A String", # The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource (https://cloud.google.com/monitoring/api/resources#tag_api). |
| }, |
| "cloudRun": { # Cloud Run service. Learn more at https://cloud.google.com/run. # Type used for Cloud Run services. |
| "location": "A String", # The location the service is run. Corresponds to the location resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision). |
| "serviceName": "A String", # The name of the Cloud Run service. Corresponds to the service_name resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision). |
| }, |
| "clusterIstio": { # Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type. # Type used for Istio services that live in a Kubernetes cluster. |
| "clusterName": "A String", # The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the cluster_name resource label in k8s_cluster resources. |
| "location": "A String", # The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources. |
| "serviceName": "A String", # The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. |
| "serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. |
| }, |
| "custom": { # Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service. # Custom service type. |
| }, |
| "displayName": "A String", # Name used for UI elements listing this Service. |
| "gkeNamespace": { # GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod). # Type used for GKE Namespaces. |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of this namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| }, |
| "gkeService": { # GKE Service. The "service" here represents a Kubernetes service object (https://kubernetes.io/docs/concepts/services-networking/service). The field names correspond to the resource labels on k8s_service monitored resources (https://cloud.google.com/monitoring/api/resources#tag_k8s_service). # Type used for GKE Services (the Kubernetes concept of a service). |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of the parent namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| "serviceName": "A String", # The name of this service. |
| }, |
| "gkeWorkload": { # A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, k8s_container or k8s_pod). # Type used for GKE Workloads. |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of the parent namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| "topLevelControllerName": "A String", # The name of this workload. |
| "topLevelControllerType": "A String", # The type of this workload (for example, "Deployment" or "DaemonSet") |
| }, |
| "istioCanonicalService": { # Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type. # Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here (https://istio.io/latest/docs/reference/config/metrics/) |
| "canonicalService": "A String", # The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| "canonicalServiceNamespace": "A String", # The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| "meshUid": "A String", # Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the mesh_uid metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| }, |
| "meshIstio": { # Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type. # Type used for Istio services scoped to an Istio mesh. |
| "meshUid": "A String", # Identifier for the mesh in which this Istio service is defined. Corresponds to the mesh_uid metric label in Istio metrics. |
| "serviceName": "A String", # The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. |
| "serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. |
| }, |
| "name": "A String", # Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] |
| "telemetry": { # Configuration for how to query telemetry on a Service. # Configuration for how to query telemetry on a Service. |
| "resourceName": "A String", # The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names. |
| }, |
| "userLabels": { # Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value. |
| "a_key": "A String", |
| }, |
| } |
| |
| serviceId: string, Optional. The Service id to use for this Service. If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+ |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia (https://en.wikipedia.org/wiki/Service-orientation)). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible. |
| "appEngine": { # App Engine service. Learn more at https://cloud.google.com/appengine. # Type used for App Engine services. |
| "moduleId": "A String", # The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource (https://cloud.google.com/monitoring/api/resources#tag_gae_app). |
| }, |
| "basicService": { # A well-known service type, defined by its service type and service labels. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). # Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| "serviceLabels": { # Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this Service. Documentation and valid values for given service types here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| "a_key": "A String", |
| }, |
| "serviceType": "A String", # The type of service that this basic service defines, e.g. APP_ENGINE service type. Documentation and valid values here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| }, |
| "cloudEndpoints": { # Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints. # Type used for Cloud Endpoints services. |
| "service": "A String", # The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource (https://cloud.google.com/monitoring/api/resources#tag_api). |
| }, |
| "cloudRun": { # Cloud Run service. Learn more at https://cloud.google.com/run. # Type used for Cloud Run services. |
| "location": "A String", # The location the service is run. Corresponds to the location resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision). |
| "serviceName": "A String", # The name of the Cloud Run service. Corresponds to the service_name resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision). |
| }, |
| "clusterIstio": { # Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type. # Type used for Istio services that live in a Kubernetes cluster. |
| "clusterName": "A String", # The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the cluster_name resource label in k8s_cluster resources. |
| "location": "A String", # The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources. |
| "serviceName": "A String", # The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. |
| "serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. |
| }, |
| "custom": { # Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service. # Custom service type. |
| }, |
| "displayName": "A String", # Name used for UI elements listing this Service. |
| "gkeNamespace": { # GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod). # Type used for GKE Namespaces. |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of this namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| }, |
| "gkeService": { # GKE Service. The "service" here represents a Kubernetes service object (https://kubernetes.io/docs/concepts/services-networking/service). The field names correspond to the resource labels on k8s_service monitored resources (https://cloud.google.com/monitoring/api/resources#tag_k8s_service). # Type used for GKE Services (the Kubernetes concept of a service). |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of the parent namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| "serviceName": "A String", # The name of this service. |
| }, |
| "gkeWorkload": { # A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, k8s_container or k8s_pod). # Type used for GKE Workloads. |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of the parent namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| "topLevelControllerName": "A String", # The name of this workload. |
| "topLevelControllerType": "A String", # The type of this workload (for example, "Deployment" or "DaemonSet") |
| }, |
| "istioCanonicalService": { # Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type. # Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here (https://istio.io/latest/docs/reference/config/metrics/) |
| "canonicalService": "A String", # The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| "canonicalServiceNamespace": "A String", # The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| "meshUid": "A String", # Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the mesh_uid metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| }, |
| "meshIstio": { # Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type. # Type used for Istio services scoped to an Istio mesh. |
| "meshUid": "A String", # Identifier for the mesh in which this Istio service is defined. Corresponds to the mesh_uid metric label in Istio metrics. |
| "serviceName": "A String", # The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. |
| "serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. |
| }, |
| "name": "A String", # Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] |
| "telemetry": { # Configuration for how to query telemetry on a Service. # Configuration for how to query telemetry on a Service. |
| "resourceName": "A String", # The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names. |
| }, |
| "userLabels": { # Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value. |
| "a_key": "A String", |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Soft delete this Service. |
| |
| Args: |
| name: string, Required. Resource name of the Service to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Get the named Service. |
| |
| Args: |
| name: string, Required. Resource name of the Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia (https://en.wikipedia.org/wiki/Service-orientation)). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible. |
| "appEngine": { # App Engine service. Learn more at https://cloud.google.com/appengine. # Type used for App Engine services. |
| "moduleId": "A String", # The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource (https://cloud.google.com/monitoring/api/resources#tag_gae_app). |
| }, |
| "basicService": { # A well-known service type, defined by its service type and service labels. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). # Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| "serviceLabels": { # Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this Service. Documentation and valid values for given service types here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| "a_key": "A String", |
| }, |
| "serviceType": "A String", # The type of service that this basic service defines, e.g. APP_ENGINE service type. Documentation and valid values here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| }, |
| "cloudEndpoints": { # Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints. # Type used for Cloud Endpoints services. |
| "service": "A String", # The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource (https://cloud.google.com/monitoring/api/resources#tag_api). |
| }, |
| "cloudRun": { # Cloud Run service. Learn more at https://cloud.google.com/run. # Type used for Cloud Run services. |
| "location": "A String", # The location the service is run. Corresponds to the location resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision). |
| "serviceName": "A String", # The name of the Cloud Run service. Corresponds to the service_name resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision). |
| }, |
| "clusterIstio": { # Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type. # Type used for Istio services that live in a Kubernetes cluster. |
| "clusterName": "A String", # The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the cluster_name resource label in k8s_cluster resources. |
| "location": "A String", # The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources. |
| "serviceName": "A String", # The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. |
| "serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. |
| }, |
| "custom": { # Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service. # Custom service type. |
| }, |
| "displayName": "A String", # Name used for UI elements listing this Service. |
| "gkeNamespace": { # GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod). # Type used for GKE Namespaces. |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of this namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| }, |
| "gkeService": { # GKE Service. The "service" here represents a Kubernetes service object (https://kubernetes.io/docs/concepts/services-networking/service). The field names correspond to the resource labels on k8s_service monitored resources (https://cloud.google.com/monitoring/api/resources#tag_k8s_service). # Type used for GKE Services (the Kubernetes concept of a service). |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of the parent namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| "serviceName": "A String", # The name of this service. |
| }, |
| "gkeWorkload": { # A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, k8s_container or k8s_pod). # Type used for GKE Workloads. |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of the parent namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| "topLevelControllerName": "A String", # The name of this workload. |
| "topLevelControllerType": "A String", # The type of this workload (for example, "Deployment" or "DaemonSet") |
| }, |
| "istioCanonicalService": { # Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type. # Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here (https://istio.io/latest/docs/reference/config/metrics/) |
| "canonicalService": "A String", # The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| "canonicalServiceNamespace": "A String", # The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| "meshUid": "A String", # Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the mesh_uid metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| }, |
| "meshIstio": { # Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type. # Type used for Istio services scoped to an Istio mesh. |
| "meshUid": "A String", # Identifier for the mesh in which this Istio service is defined. Corresponds to the mesh_uid metric label in Istio metrics. |
| "serviceName": "A String", # The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. |
| "serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. |
| }, |
| "name": "A String", # Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] |
| "telemetry": { # Configuration for how to query telemetry on a Service. # Configuration for how to query telemetry on a Service. |
| "resourceName": "A String", # The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names. |
| }, |
| "userLabels": { # Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value. |
| "a_key": "A String", |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>List Services for this Metrics Scope. |
| |
| Args: |
| parent: string, Required. Resource name of the parent containing the listed services, either a project (https://cloud.google.com/monitoring/api/v3#project_name) or a Monitoring Metrics Scope. The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER] (required) |
| 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#ServiceTo 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 |
| pageSize: integer, A non-negative number that is the maximum number of results to return. When 0, use default page size. |
| pageToken: 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The ListServices response. |
| "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. |
| "services": [ # The Services matching the specified filter. |
| { # A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia (https://en.wikipedia.org/wiki/Service-orientation)). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible. |
| "appEngine": { # App Engine service. Learn more at https://cloud.google.com/appengine. # Type used for App Engine services. |
| "moduleId": "A String", # The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource (https://cloud.google.com/monitoring/api/resources#tag_gae_app). |
| }, |
| "basicService": { # A well-known service type, defined by its service type and service labels. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). # Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| "serviceLabels": { # Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this Service. Documentation and valid values for given service types here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| "a_key": "A String", |
| }, |
| "serviceType": "A String", # The type of service that this basic service defines, e.g. APP_ENGINE service type. Documentation and valid values here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| }, |
| "cloudEndpoints": { # Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints. # Type used for Cloud Endpoints services. |
| "service": "A String", # The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource (https://cloud.google.com/monitoring/api/resources#tag_api). |
| }, |
| "cloudRun": { # Cloud Run service. Learn more at https://cloud.google.com/run. # Type used for Cloud Run services. |
| "location": "A String", # The location the service is run. Corresponds to the location resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision). |
| "serviceName": "A String", # The name of the Cloud Run service. Corresponds to the service_name resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision). |
| }, |
| "clusterIstio": { # Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type. # Type used for Istio services that live in a Kubernetes cluster. |
| "clusterName": "A String", # The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the cluster_name resource label in k8s_cluster resources. |
| "location": "A String", # The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources. |
| "serviceName": "A String", # The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. |
| "serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. |
| }, |
| "custom": { # Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service. # Custom service type. |
| }, |
| "displayName": "A String", # Name used for UI elements listing this Service. |
| "gkeNamespace": { # GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod). # Type used for GKE Namespaces. |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of this namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| }, |
| "gkeService": { # GKE Service. The "service" here represents a Kubernetes service object (https://kubernetes.io/docs/concepts/services-networking/service). The field names correspond to the resource labels on k8s_service monitored resources (https://cloud.google.com/monitoring/api/resources#tag_k8s_service). # Type used for GKE Services (the Kubernetes concept of a service). |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of the parent namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| "serviceName": "A String", # The name of this service. |
| }, |
| "gkeWorkload": { # A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, k8s_container or k8s_pod). # Type used for GKE Workloads. |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of the parent namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| "topLevelControllerName": "A String", # The name of this workload. |
| "topLevelControllerType": "A String", # The type of this workload (for example, "Deployment" or "DaemonSet") |
| }, |
| "istioCanonicalService": { # Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type. # Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here (https://istio.io/latest/docs/reference/config/metrics/) |
| "canonicalService": "A String", # The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| "canonicalServiceNamespace": "A String", # The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| "meshUid": "A String", # Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the mesh_uid metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| }, |
| "meshIstio": { # Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type. # Type used for Istio services scoped to an Istio mesh. |
| "meshUid": "A String", # Identifier for the mesh in which this Istio service is defined. Corresponds to the mesh_uid metric label in Istio metrics. |
| "serviceName": "A String", # The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. |
| "serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. |
| }, |
| "name": "A String", # Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] |
| "telemetry": { # Configuration for how to query telemetry on a Service. # Configuration for how to query telemetry on a Service. |
| "resourceName": "A String", # The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names. |
| }, |
| "userLabels": { # Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value. |
| "a_key": "A String", |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Update this Service. |
| |
| Args: |
| name: string, Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia (https://en.wikipedia.org/wiki/Service-orientation)). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible. |
| "appEngine": { # App Engine service. Learn more at https://cloud.google.com/appengine. # Type used for App Engine services. |
| "moduleId": "A String", # The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource (https://cloud.google.com/monitoring/api/resources#tag_gae_app). |
| }, |
| "basicService": { # A well-known service type, defined by its service type and service labels. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). # Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| "serviceLabels": { # Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this Service. Documentation and valid values for given service types here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| "a_key": "A String", |
| }, |
| "serviceType": "A String", # The type of service that this basic service defines, e.g. APP_ENGINE service type. Documentation and valid values here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| }, |
| "cloudEndpoints": { # Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints. # Type used for Cloud Endpoints services. |
| "service": "A String", # The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource (https://cloud.google.com/monitoring/api/resources#tag_api). |
| }, |
| "cloudRun": { # Cloud Run service. Learn more at https://cloud.google.com/run. # Type used for Cloud Run services. |
| "location": "A String", # The location the service is run. Corresponds to the location resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision). |
| "serviceName": "A String", # The name of the Cloud Run service. Corresponds to the service_name resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision). |
| }, |
| "clusterIstio": { # Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type. # Type used for Istio services that live in a Kubernetes cluster. |
| "clusterName": "A String", # The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the cluster_name resource label in k8s_cluster resources. |
| "location": "A String", # The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources. |
| "serviceName": "A String", # The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. |
| "serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. |
| }, |
| "custom": { # Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service. # Custom service type. |
| }, |
| "displayName": "A String", # Name used for UI elements listing this Service. |
| "gkeNamespace": { # GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod). # Type used for GKE Namespaces. |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of this namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| }, |
| "gkeService": { # GKE Service. The "service" here represents a Kubernetes service object (https://kubernetes.io/docs/concepts/services-networking/service). The field names correspond to the resource labels on k8s_service monitored resources (https://cloud.google.com/monitoring/api/resources#tag_k8s_service). # Type used for GKE Services (the Kubernetes concept of a service). |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of the parent namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| "serviceName": "A String", # The name of this service. |
| }, |
| "gkeWorkload": { # A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, k8s_container or k8s_pod). # Type used for GKE Workloads. |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of the parent namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| "topLevelControllerName": "A String", # The name of this workload. |
| "topLevelControllerType": "A String", # The type of this workload (for example, "Deployment" or "DaemonSet") |
| }, |
| "istioCanonicalService": { # Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type. # Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here (https://istio.io/latest/docs/reference/config/metrics/) |
| "canonicalService": "A String", # The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| "canonicalServiceNamespace": "A String", # The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| "meshUid": "A String", # Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the mesh_uid metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| }, |
| "meshIstio": { # Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type. # Type used for Istio services scoped to an Istio mesh. |
| "meshUid": "A String", # Identifier for the mesh in which this Istio service is defined. Corresponds to the mesh_uid metric label in Istio metrics. |
| "serviceName": "A String", # The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. |
| "serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. |
| }, |
| "name": "A String", # Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] |
| "telemetry": { # Configuration for how to query telemetry on a Service. # Configuration for how to query telemetry on a Service. |
| "resourceName": "A String", # The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names. |
| }, |
| "userLabels": { # Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value. |
| "a_key": "A String", |
| }, |
| } |
| |
| updateMask: string, A set of field paths defining which fields to use for the update. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia (https://en.wikipedia.org/wiki/Service-orientation)). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible. |
| "appEngine": { # App Engine service. Learn more at https://cloud.google.com/appengine. # Type used for App Engine services. |
| "moduleId": "A String", # The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource (https://cloud.google.com/monitoring/api/resources#tag_gae_app). |
| }, |
| "basicService": { # A well-known service type, defined by its service type and service labels. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). # Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| "serviceLabels": { # Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this Service. Documentation and valid values for given service types here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| "a_key": "A String", |
| }, |
| "serviceType": "A String", # The type of service that this basic service defines, e.g. APP_ENGINE service type. Documentation and valid values here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| }, |
| "cloudEndpoints": { # Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints. # Type used for Cloud Endpoints services. |
| "service": "A String", # The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource (https://cloud.google.com/monitoring/api/resources#tag_api). |
| }, |
| "cloudRun": { # Cloud Run service. Learn more at https://cloud.google.com/run. # Type used for Cloud Run services. |
| "location": "A String", # The location the service is run. Corresponds to the location resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision). |
| "serviceName": "A String", # The name of the Cloud Run service. Corresponds to the service_name resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision). |
| }, |
| "clusterIstio": { # Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type. # Type used for Istio services that live in a Kubernetes cluster. |
| "clusterName": "A String", # The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the cluster_name resource label in k8s_cluster resources. |
| "location": "A String", # The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources. |
| "serviceName": "A String", # The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. |
| "serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. |
| }, |
| "custom": { # Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service. # Custom service type. |
| }, |
| "displayName": "A String", # Name used for UI elements listing this Service. |
| "gkeNamespace": { # GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod). # Type used for GKE Namespaces. |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of this namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| }, |
| "gkeService": { # GKE Service. The "service" here represents a Kubernetes service object (https://kubernetes.io/docs/concepts/services-networking/service). The field names correspond to the resource labels on k8s_service monitored resources (https://cloud.google.com/monitoring/api/resources#tag_k8s_service). # Type used for GKE Services (the Kubernetes concept of a service). |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of the parent namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| "serviceName": "A String", # The name of this service. |
| }, |
| "gkeWorkload": { # A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, k8s_container or k8s_pod). # Type used for GKE Workloads. |
| "clusterName": "A String", # The name of the parent cluster. |
| "location": "A String", # The location of the parent cluster. This may be a zone or region. |
| "namespaceName": "A String", # The name of the parent namespace. |
| "projectId": "A String", # Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. |
| "topLevelControllerName": "A String", # The name of this workload. |
| "topLevelControllerType": "A String", # The type of this workload (for example, "Deployment" or "DaemonSet") |
| }, |
| "istioCanonicalService": { # Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type. # Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here (https://istio.io/latest/docs/reference/config/metrics/) |
| "canonicalService": "A String", # The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| "canonicalServiceNamespace": "A String", # The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| "meshUid": "A String", # Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the mesh_uid metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio). |
| }, |
| "meshIstio": { # Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type. # Type used for Istio services scoped to an Istio mesh. |
| "meshUid": "A String", # Identifier for the mesh in which this Istio service is defined. Corresponds to the mesh_uid metric label in Istio metrics. |
| "serviceName": "A String", # The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. |
| "serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. |
| }, |
| "name": "A String", # Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] |
| "telemetry": { # Configuration for how to query telemetry on a Service. # Configuration for how to query telemetry on a Service. |
| "resourceName": "A String", # The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names. |
| }, |
| "userLabels": { # Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value. |
| "a_key": "A String", |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
