Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::Service (v1.4.0)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::Service.

A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#app_engine

def app_engine() -> ::Google::Cloud::Monitoring::V3::Service::AppEngine

Returns

(::Google::Cloud::Monitoring::V3::Service::AppEngine) — Type used for App Engine services.

Note: The following fields are mutually exclusive: app_engine, custom, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#app_engine=

def app_engine=(value) -> ::Google::Cloud::Monitoring::V3::Service::AppEngine

Parameter

value (::Google::Cloud::Monitoring::V3::Service::AppEngine) — Type used for App Engine services.

Note: The following fields are mutually exclusive: app_engine, custom, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Monitoring::V3::Service::AppEngine) — Type used for App Engine services.

Note: The following fields are mutually exclusive: app_engine, custom, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#basic_service

def basic_service() -> ::Google::Cloud::Monitoring::V3::Service::BasicService

Returns

(::Google::Cloud::Monitoring::V3::Service::BasicService) — Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here.

#basic_service=

def basic_service=(value) -> ::Google::Cloud::Monitoring::V3::Service::BasicService

Parameter

value (::Google::Cloud::Monitoring::V3::Service::BasicService) — Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here.

Returns

(::Google::Cloud::Monitoring::V3::Service::BasicService) — Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here.

#cloud_endpoints

def cloud_endpoints() -> ::Google::Cloud::Monitoring::V3::Service::CloudEndpoints

Returns

(::Google::Cloud::Monitoring::V3::Service::CloudEndpoints) — Type used for Cloud Endpoints services.

Note: The following fields are mutually exclusive: cloud_endpoints, custom, app_engine, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#cloud_endpoints=

def cloud_endpoints=(value) -> ::Google::Cloud::Monitoring::V3::Service::CloudEndpoints

Parameter

value (::Google::Cloud::Monitoring::V3::Service::CloudEndpoints) — Type used for Cloud Endpoints services.

Note: The following fields are mutually exclusive: cloud_endpoints, custom, app_engine, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Monitoring::V3::Service::CloudEndpoints) — Type used for Cloud Endpoints services.

Note: The following fields are mutually exclusive: cloud_endpoints, custom, app_engine, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#cloud_run

def cloud_run() -> ::Google::Cloud::Monitoring::V3::Service::CloudRun

Returns

(::Google::Cloud::Monitoring::V3::Service::CloudRun) — Type used for Cloud Run services.

Note: The following fields are mutually exclusive: cloud_run, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#cloud_run=

def cloud_run=(value) -> ::Google::Cloud::Monitoring::V3::Service::CloudRun

Parameter

value (::Google::Cloud::Monitoring::V3::Service::CloudRun) — Type used for Cloud Run services.

Note: The following fields are mutually exclusive: cloud_run, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Monitoring::V3::Service::CloudRun) — Type used for Cloud Run services.

Note: The following fields are mutually exclusive: cloud_run, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#cluster_istio

def cluster_istio() -> ::Google::Cloud::Monitoring::V3::Service::ClusterIstio

Returns

(::Google::Cloud::Monitoring::V3::Service::ClusterIstio) — Type used for Istio services that live in a Kubernetes cluster.

Note: The following fields are mutually exclusive: cluster_istio, custom, app_engine, cloud_endpoints, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#cluster_istio=

def cluster_istio=(value) -> ::Google::Cloud::Monitoring::V3::Service::ClusterIstio

Parameter

value (::Google::Cloud::Monitoring::V3::Service::ClusterIstio) — Type used for Istio services that live in a Kubernetes cluster.

Note: The following fields are mutually exclusive: cluster_istio, custom, app_engine, cloud_endpoints, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Monitoring::V3::Service::ClusterIstio) — Type used for Istio services that live in a Kubernetes cluster.

Note: The following fields are mutually exclusive: cluster_istio, custom, app_engine, cloud_endpoints, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#custom

def custom() -> ::Google::Cloud::Monitoring::V3::Service::Custom

Returns

(::Google::Cloud::Monitoring::V3::Service::Custom) — Custom service type.

Note: The following fields are mutually exclusive: custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#custom=

def custom=(value) -> ::Google::Cloud::Monitoring::V3::Service::Custom

Parameter

value (::Google::Cloud::Monitoring::V3::Service::Custom) — Custom service type.

Note: The following fields are mutually exclusive: custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Monitoring::V3::Service::Custom) — Custom service type.

Note: The following fields are mutually exclusive: custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#display_name

def display_name() -> ::String

Returns

(::String) — Name used for UI elements listing this Service.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — Name used for UI elements listing this Service.

Returns

(::String) — Name used for UI elements listing this Service.

#gke_namespace

def gke_namespace() -> ::Google::Cloud::Monitoring::V3::Service::GkeNamespace

Returns

(::Google::Cloud::Monitoring::V3::Service::GkeNamespace) — Type used for GKE Namespaces.

Note: The following fields are mutually exclusive: gke_namespace, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gke_namespace=

def gke_namespace=(value) -> ::Google::Cloud::Monitoring::V3::Service::GkeNamespace

Parameter

value (::Google::Cloud::Monitoring::V3::Service::GkeNamespace) — Type used for GKE Namespaces.

Note: The following fields are mutually exclusive: gke_namespace, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Monitoring::V3::Service::GkeNamespace) — Type used for GKE Namespaces.

Note: The following fields are mutually exclusive: gke_namespace, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gke_service

def gke_service() -> ::Google::Cloud::Monitoring::V3::Service::GkeService

Returns

(::Google::Cloud::Monitoring::V3::Service::GkeService) — Type used for GKE Services (the Kubernetes concept of a service).

Note: The following fields are mutually exclusive: gke_service, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gke_service=

def gke_service=(value) -> ::Google::Cloud::Monitoring::V3::Service::GkeService

Parameter

value (::Google::Cloud::Monitoring::V3::Service::GkeService) — Type used for GKE Services (the Kubernetes concept of a service).

Note: The following fields are mutually exclusive: gke_service, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Monitoring::V3::Service::GkeService) — Type used for GKE Services (the Kubernetes concept of a service).

Note: The following fields are mutually exclusive: gke_service, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gke_workload

def gke_workload() -> ::Google::Cloud::Monitoring::V3::Service::GkeWorkload

Returns

(::Google::Cloud::Monitoring::V3::Service::GkeWorkload) — Type used for GKE Workloads.

Note: The following fields are mutually exclusive: gke_workload, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gke_workload=

def gke_workload=(value) -> ::Google::Cloud::Monitoring::V3::Service::GkeWorkload

Parameter

value (::Google::Cloud::Monitoring::V3::Service::GkeWorkload) — Type used for GKE Workloads.

Note: The following fields are mutually exclusive: gke_workload, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Monitoring::V3::Service::GkeWorkload) — Type used for GKE Workloads.

Note: The following fields are mutually exclusive: gke_workload, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, istio_canonical_service, cloud_run, gke_namespace, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#istio_canonical_service

def istio_canonical_service() -> ::Google::Cloud::Monitoring::V3::Service::IstioCanonicalService

Returns

(::Google::Cloud::Monitoring::V3::Service::IstioCanonicalService) — Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here

Note: The following fields are mutually exclusive: istio_canonical_service, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#istio_canonical_service=

def istio_canonical_service=(value) -> ::Google::Cloud::Monitoring::V3::Service::IstioCanonicalService

Parameter

value (::Google::Cloud::Monitoring::V3::Service::IstioCanonicalService) — Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here

Note: The following fields are mutually exclusive: istio_canonical_service, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Monitoring::V3::Service::IstioCanonicalService) — Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here

Note: The following fields are mutually exclusive: istio_canonical_service, custom, app_engine, cloud_endpoints, cluster_istio, mesh_istio, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#mesh_istio

def mesh_istio() -> ::Google::Cloud::Monitoring::V3::Service::MeshIstio

Returns

(::Google::Cloud::Monitoring::V3::Service::MeshIstio) — Type used for Istio services scoped to an Istio mesh.

Note: The following fields are mutually exclusive: mesh_istio, custom, app_engine, cloud_endpoints, cluster_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#mesh_istio=

def mesh_istio=(value) -> ::Google::Cloud::Monitoring::V3::Service::MeshIstio

Parameter

value (::Google::Cloud::Monitoring::V3::Service::MeshIstio) — Type used for Istio services scoped to an Istio mesh.

Note: The following fields are mutually exclusive: mesh_istio, custom, app_engine, cloud_endpoints, cluster_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Monitoring::V3::Service::MeshIstio) — Type used for Istio services scoped to an Istio mesh.

Note: The following fields are mutually exclusive: mesh_istio, custom, app_engine, cloud_endpoints, cluster_istio, istio_canonical_service, cloud_run, gke_namespace, gke_workload, gke_service. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name

def name() -> ::String

Returns

(::String) —
Identifier. Resource name for this Service. The format is:
```
projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
```

#name=

def name=(value) -> ::String

Parameter

value (::String) —
Identifier. Resource name for this Service. The format is:
```
projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
```

Returns

(::String) —
Identifier. Resource name for this Service. The format is:
```
projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
```

#telemetry

def telemetry() -> ::Google::Cloud::Monitoring::V3::Service::Telemetry

Returns

(::Google::Cloud::Monitoring::V3::Service::Telemetry) — Configuration for how to query telemetry on a Service.

#telemetry=

def telemetry=(value) -> ::Google::Cloud::Monitoring::V3::Service::Telemetry

Parameter

value (::Google::Cloud::Monitoring::V3::Service::Telemetry) — Configuration for how to query telemetry on a Service.

Returns

(::Google::Cloud::Monitoring::V3::Service::Telemetry) — Configuration for how to query telemetry on a Service.

#user_labels

def user_labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#user_labels=

def user_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.