create(parent=None, body=None, serviceId=None, x__xgafv=None)

Create a Service.

Args:
parent: string, Required. Resource name of the parent workspace. 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.
"displayName": "A String", # Name used for UI elements listing this Service.
"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
},
"meshIstio": { # Istio service scoped to an Istio mesh # 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.
"serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace 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.
},
"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.
},
"clusterIstio": { # Istio service scoped to a single Kubernetes cluster. Learn more at http://istio.io. # 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.
"serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace 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.
"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.
},
"custom": { # Custom view of service telemetry. Currently a place-holder pending final design. # Custom service type.
},
"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
},
"name": "A String", # Resource name for this Service. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
}

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.
"displayName": "A String", # Name used for UI elements listing this Service.
"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
},
"meshIstio": { # Istio service scoped to an Istio mesh # 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.
"serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace 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.
},
"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.
},
"clusterIstio": { # Istio service scoped to a single Kubernetes cluster. Learn more at http://istio.io. # 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.
"serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace 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.
"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.
},
"custom": { # Custom view of service telemetry. Currently a place-holder pending final design. # Custom service type.
},
"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
},
"name": "A String", # Resource name for this Service. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
}

delete(name=None, x__xgafv=None)

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);
      # }
      # The JSON representation for Empty is empty JSON object {}.
  }

get(name=None, x__xgafv=None)

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.
"displayName": "A String", # Name used for UI elements listing this Service.
"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
},
"meshIstio": { # Istio service scoped to an Istio mesh # 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.
"serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace 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.
},
"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.
},
"clusterIstio": { # Istio service scoped to a single Kubernetes cluster. Learn more at http://istio.io. # 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.
"serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace 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.
"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.
},
"custom": { # Custom view of service telemetry. Currently a place-holder pending final design. # Custom service type.
},
"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
},
"name": "A String", # Resource name for this Service. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
}

list(parent=None, pageToken=None, x__xgafv=None, pageSize=None, filter=None)

List Services for this workspace.

Args:
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]
(required)
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
pageSize: integer, A non-negative number that is the maximum number of results to return. When 0, use default page size.
filter: string, A filter specifying what Services to return. The filter currently supports the following fields:
- `identifier_case`
- `app_engine.module_id`
- `cloud_endpoints.service`
- `cluster_istio.location`
- `cluster_istio.cluster_name`
- `cluster_istio.service_namespace`
- `cluster_istio.service_name`
identifier_case refers to which option in the identifier oneof is populated. For example, the filter identifier_case = "CUSTOM" would match all services with a value for the custom field. Valid options are "CUSTOM", "APP_ENGINE", "CLOUD_ENDPOINTS", and "CLUSTER_ISTIO".

Returns:
An object of the form:

{ # The ListServices response.
"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.
"displayName": "A String", # Name used for UI elements listing this Service.
"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
},
"meshIstio": { # Istio service scoped to an Istio mesh # 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.
"serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace 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.
},
"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.
},
"clusterIstio": { # Istio service scoped to a single Kubernetes cluster. Learn more at http://istio.io. # 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.
"serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace 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.
"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.
},
"custom": { # Custom view of service telemetry. Currently a place-holder pending final design. # Custom service type.
},
"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
},
"name": "A String", # Resource name for this Service. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
},
],
"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.
}

list_next(previous_request=*, previous_response=*)

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.

patch(name=None, body=None, updateMask=None, x__xgafv=None)

Update this Service.

Args:
name: string, 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.
"displayName": "A String", # Name used for UI elements listing this Service.
"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
},
"meshIstio": { # Istio service scoped to an Istio mesh # 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.
"serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace 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.
},
"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.
},
"clusterIstio": { # Istio service scoped to a single Kubernetes cluster. Learn more at http://istio.io. # 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.
"serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace 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.
"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.
},
"custom": { # Custom view of service telemetry. Currently a place-holder pending final design. # Custom service type.
},
"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
},
"name": "A String", # Resource name for this Service. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
}

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.
"displayName": "A String", # Name used for UI elements listing this Service.
"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
},
"meshIstio": { # Istio service scoped to an Istio mesh # 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.
"serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace 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.
},
"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.
},
"clusterIstio": { # Istio service scoped to a single Kubernetes cluster. Learn more at http://istio.io. # 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.
"serviceNamespace": "A String", # The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace 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.
"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.
},
"custom": { # Custom view of service telemetry. Currently a place-holder pending final design. # Custom service type.
},
"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
},
"name": "A String", # Resource name for this Service. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
}

Cloud Monitoring API . services

Instance Methods

Method Details