Class Service (2.12.0)

Service(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`name`	`str` Resource name for this Service. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
`display_name`	`str` Name used for UI elements listing this Service.
`custom`	`google.cloud.monitoring_v3.types.Service.Custom` Custom service type. This field is a member of `oneof`_ `identifier`.
`app_engine`	`google.cloud.monitoring_v3.types.Service.AppEngine` Type used for App Engine services. This field is a member of `oneof`_ `identifier`.
`cloud_endpoints`	`google.cloud.monitoring_v3.types.Service.CloudEndpoints` Type used for Cloud Endpoints services. This field is a member of `oneof`_ `identifier`.
`cluster_istio`	`google.cloud.monitoring_v3.types.Service.ClusterIstio` Type used for Istio services that live in a Kubernetes cluster. This field is a member of `oneof`_ `identifier`.
`mesh_istio`	`google.cloud.monitoring_v3.types.Service.MeshIstio` Type used for Istio services scoped to an Istio mesh. This field is a member of `oneof`_ `identifier`.
`istio_canonical_service`	`google.cloud.monitoring_v3.types.Service.IstioCanonicalService` Type used for canonical services scoped to an Istio mesh. Metrics for Istio are `documented here
`telemetry`	`google.cloud.monitoring_v3.types.Service.Telemetry` Configuration for how to query telemetry on a Service.
`user_labels`	`MutableMapping[str, str]` 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.

Classes

AppEngine

AppEngine(mapping=None, *, ignore_unknown_fields=False, **kwargs)

App Engine service. Learn more at https://cloud.google.com/appengine.

CloudEndpoints

CloudEndpoints(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints.

ClusterIstio

ClusterIstio(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Custom

Custom(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Custom view of service telemetry. Currently a place-holder pending final design.

IstioCanonicalService

IstioCanonicalService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type.

MeshIstio

MeshIstio(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type.

Telemetry

Telemetry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration for how to query telemetry on a Service.

UserLabelsEntry

UserLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.