Service (Cloud Monitoring API v3-rev20251006-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.monitoring.v3.model.Service

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Service
extends com.google.api.client.json.GenericJson
```
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 is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Monitoring API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Service()

Constructors
Constructor and Description
`Service()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Service`	`clone()`
`AppEngine`	`getAppEngine()` Type used for App Engine services.
`BasicService`	`getBasicService()` Message that contains the service type and service labels of this service if it is a basic service.
`CloudEndpoints`	`getCloudEndpoints()` Type used for Cloud Endpoints services.
`CloudRun`	`getCloudRun()` Type used for Cloud Run services.
`ClusterIstio`	`getClusterIstio()` Type used for Istio services that live in a Kubernetes cluster.
`Custom`	`getCustom()` Custom service type.
`String`	`getDisplayName()` Name used for UI elements listing this Service.
`GkeNamespace`	`getGkeNamespace()` Type used for GKE Namespaces.
`GkeService`	`getGkeService()` Type used for GKE Services (the Kubernetes concept of a service).
`GkeWorkload`	`getGkeWorkload()` Type used for GKE Workloads.
`IstioCanonicalService`	`getIstioCanonicalService()` Type used for canonical services scoped to an Istio mesh.
`MeshIstio`	`getMeshIstio()` Type used for Istio services scoped to an Istio mesh.
`String`	`getName()` Identifier.
`Telemetry`	`getTelemetry()` Configuration for how to query telemetry on a Service.
`Map<String,String>`	`getUserLabels()` Labels which have been used to annotate the service.
`Service`	`set(String fieldName, Object value)`
`Service`	`setAppEngine(AppEngine appEngine)` Type used for App Engine services.
`Service`	`setBasicService(BasicService basicService)` Message that contains the service type and service labels of this service if it is a basic service.
`Service`	`setCloudEndpoints(CloudEndpoints cloudEndpoints)` Type used for Cloud Endpoints services.
`Service`	`setCloudRun(CloudRun cloudRun)` Type used for Cloud Run services.
`Service`	`setClusterIstio(ClusterIstio clusterIstio)` Type used for Istio services that live in a Kubernetes cluster.
`Service`	`setCustom(Custom custom)` Custom service type.
`Service`	`setDisplayName(String displayName)` Name used for UI elements listing this Service.
`Service`	`setGkeNamespace(GkeNamespace gkeNamespace)` Type used for GKE Namespaces.
`Service`	`setGkeService(GkeService gkeService)` Type used for GKE Services (the Kubernetes concept of a service).
`Service`	`setGkeWorkload(GkeWorkload gkeWorkload)` Type used for GKE Workloads.
`Service`	`setIstioCanonicalService(IstioCanonicalService istioCanonicalService)` Type used for canonical services scoped to an Istio mesh.
`Service`	`setMeshIstio(MeshIstio meshIstio)` Type used for Istio services scoped to an Istio mesh.
`Service`	`setName(String name)` Identifier.
`Service`	`setTelemetry(Telemetry telemetry)` Configuration for how to query telemetry on a Service.
`Service`	`setUserLabels(Map<String,String> userLabels)` Labels which have been used to annotate the service.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Service
```
public Service()
```
- Method Detail
  - getAppEngine
```
public AppEngine getAppEngine()
```
    Type used for App Engine services.
    
    Returns:
    
    value or null for none
  - setAppEngine
```
public Service setAppEngine(AppEngine appEngine)
```
    Type used for App Engine services.
    
    Parameters:
    
    appEngine - appEngine or null for none
  - getBasicService
```
public BasicService getBasicService()
```
    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).
    
    Returns:
    
    value or null for none
  - setBasicService
```
public Service setBasicService(BasicService basicService)
```
    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).
    
    Parameters:
    
    basicService - basicService or null for none
  - getCloudEndpoints
```
public CloudEndpoints getCloudEndpoints()
```
    Type used for Cloud Endpoints services.
    
    Returns:
    
    value or null for none
  - setCloudEndpoints
```
public Service setCloudEndpoints(CloudEndpoints cloudEndpoints)
```
    Type used for Cloud Endpoints services.
    
    Parameters:
    
    cloudEndpoints - cloudEndpoints or null for none
  - getCloudRun
```
public CloudRun getCloudRun()
```
    Type used for Cloud Run services.
    
    Returns:
    
    value or null for none
  - setCloudRun
```
public Service setCloudRun(CloudRun cloudRun)
```
    Type used for Cloud Run services.
    
    Parameters:
    
    cloudRun - cloudRun or null for none
  - getClusterIstio
```
public ClusterIstio getClusterIstio()
```
    Type used for Istio services that live in a Kubernetes cluster.
    
    Returns:
    
    value or null for none
  - setClusterIstio
```
public Service setClusterIstio(ClusterIstio clusterIstio)
```
    Type used for Istio services that live in a Kubernetes cluster.
    
    Parameters:
    
    clusterIstio - clusterIstio or null for none
  - getCustom
```
public Custom getCustom()
```
    Custom service type.
    
    Returns:
    
    value or null for none
  - setCustom
```
public Service setCustom(Custom custom)
```
    Custom service type.
    
    Parameters:
    
    custom - custom or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Name used for UI elements listing this Service.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public Service setDisplayName(String displayName)
```
    Name used for UI elements listing this Service.
    
    Parameters:
    
    displayName - displayName or null for none
  - getGkeNamespace
```
public GkeNamespace getGkeNamespace()
```
    Type used for GKE Namespaces.
    
    Returns:
    
    value or null for none
  - setGkeNamespace
```
public Service setGkeNamespace(GkeNamespace gkeNamespace)
```
    Type used for GKE Namespaces.
    
    Parameters:
    
    gkeNamespace - gkeNamespace or null for none
  - getGkeService
```
public GkeService getGkeService()
```
    Type used for GKE Services (the Kubernetes concept of a service).
    
    Returns:
    
    value or null for none
  - setGkeService
```
public Service setGkeService(GkeService gkeService)
```
    Type used for GKE Services (the Kubernetes concept of a service).
    
    Parameters:
    
    gkeService - gkeService or null for none
  - getGkeWorkload
```
public GkeWorkload getGkeWorkload()
```
    Type used for GKE Workloads.
    
    Returns:
    
    value or null for none
  - setGkeWorkload
```
public Service setGkeWorkload(GkeWorkload gkeWorkload)
```
    Type used for GKE Workloads.
    
    Parameters:
    
    gkeWorkload - gkeWorkload or null for none
  - getIstioCanonicalService
```
public IstioCanonicalService getIstioCanonicalService()
```
    Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here (https://istio.io/latest/docs/reference/config/metrics/)
    
    Returns:
    
    value or null for none
  - setIstioCanonicalService
```
public Service setIstioCanonicalService(IstioCanonicalService istioCanonicalService)
```
    Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here (https://istio.io/latest/docs/reference/config/metrics/)
    
    Parameters:
    
    istioCanonicalService - istioCanonicalService or null for none
  - getMeshIstio
```
public MeshIstio getMeshIstio()
```
    Type used for Istio services scoped to an Istio mesh.
    
    Returns:
    
    value or null for none
  - setMeshIstio
```
public Service setMeshIstio(MeshIstio meshIstio)
```
    Type used for Istio services scoped to an Istio mesh.
    
    Parameters:
    
    meshIstio - meshIstio or null for none
  - getName
```
public String getName()
```
    Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
    
    Returns:
    
    value or null for none
  - setName
```
public Service setName(String name)
```
    Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
    
    Parameters:
    
    name - name or null for none
  - getTelemetry
```
public Telemetry getTelemetry()
```
    Configuration for how to query telemetry on a Service.
    
    Returns:
    
    value or null for none
  - setTelemetry
```
public Service setTelemetry(Telemetry telemetry)
```
    Configuration for how to query telemetry on a Service.
    
    Parameters:
    
    telemetry - telemetry or null for none
  - getUserLabels
```
public Map<String,String> getUserLabels()
```
    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:
    
    value or null for none
  - setUserLabels
```
public Service setUserLabels(Map<String,String> 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.
    
    Parameters:
    
    userLabels - userLabels or null for none
  - set
```
public Service set(String fieldName,
                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Service clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Service

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Service

Method Detail

getAppEngine

setAppEngine

getBasicService

setBasicService

getCloudEndpoints

setCloudEndpoints

getCloudRun

setCloudRun

getClusterIstio

setClusterIstio

getCustom

setCustom

getDisplayName

setDisplayName

getGkeNamespace

setGkeNamespace

getGkeService

setGkeService

getGkeWorkload

setGkeWorkload

getIstioCanonicalService

setIstioCanonicalService

getMeshIstio

setMeshIstio

getName

setName

getTelemetry

setTelemetry

getUserLabels

setUserLabels

set

clone