com.google.monitoring.v3

Interface ServiceOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Service, Service.Builder

public interface ServiceOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsUserLabels(String key) Labels which have been used to annotate the service.
Service.AppEngine	getAppEngine() Type used for App Engine services.
Service.AppEngineOrBuilder	getAppEngineOrBuilder() Type used for App Engine services.
Service.BasicService	getBasicService() Message that contains the service type and service labels of this service if it is a basic service.
Service.BasicServiceOrBuilder	getBasicServiceOrBuilder() Message that contains the service type and service labels of this service if it is a basic service.
Service.CloudEndpoints	getCloudEndpoints() Type used for Cloud Endpoints services.
Service.CloudEndpointsOrBuilder	getCloudEndpointsOrBuilder() Type used for Cloud Endpoints services.
Service.CloudRun	getCloudRun() Type used for Cloud Run services.
Service.CloudRunOrBuilder	getCloudRunOrBuilder() Type used for Cloud Run services.
Service.ClusterIstio	getClusterIstio() Type used for Istio services that live in a Kubernetes cluster.
Service.ClusterIstioOrBuilder	getClusterIstioOrBuilder() Type used for Istio services that live in a Kubernetes cluster.
Service.Custom	getCustom() Custom service type.
Service.CustomOrBuilder	getCustomOrBuilder() Custom service type.
String	getDisplayName() Name used for UI elements listing this Service.
com.google.protobuf.ByteString	getDisplayNameBytes() Name used for UI elements listing this Service.
Service.GkeNamespace	getGkeNamespace() Type used for GKE Namespaces.
Service.GkeNamespaceOrBuilder	getGkeNamespaceOrBuilder() Type used for GKE Namespaces.
Service.GkeService	getGkeService() Type used for GKE Services (the Kubernetes concept of a service).
Service.GkeServiceOrBuilder	getGkeServiceOrBuilder() Type used for GKE Services (the Kubernetes concept of a service).
Service.GkeWorkload	getGkeWorkload() Type used for GKE Workloads.
Service.GkeWorkloadOrBuilder	getGkeWorkloadOrBuilder() Type used for GKE Workloads.
Service.IdentifierCase	getIdentifierCase()
Service.IstioCanonicalService	getIstioCanonicalService() Type used for canonical services scoped to an Istio mesh.
Service.IstioCanonicalServiceOrBuilder	getIstioCanonicalServiceOrBuilder() Type used for canonical services scoped to an Istio mesh.
Service.MeshIstio	getMeshIstio() Type used for Istio services scoped to an Istio mesh.
Service.MeshIstioOrBuilder	getMeshIstioOrBuilder() Type used for Istio services scoped to an Istio mesh.
String	getName() Identifier.
com.google.protobuf.ByteString	getNameBytes() Identifier.
Service.Telemetry	getTelemetry() Configuration for how to query telemetry on a Service.
Service.TelemetryOrBuilder	getTelemetryOrBuilder() Configuration for how to query telemetry on a Service.
Map<String,String>	getUserLabels() Deprecated.
int	getUserLabelsCount() Labels which have been used to annotate the service.
Map<String,String>	getUserLabelsMap() Labels which have been used to annotate the service.
String	getUserLabelsOrDefault(String key, String defaultValue) Labels which have been used to annotate the service.
String	getUserLabelsOrThrow(String key) Labels which have been used to annotate the service.
boolean	hasAppEngine() Type used for App Engine services.
boolean	hasBasicService() Message that contains the service type and service labels of this service if it is a basic service.
boolean	hasCloudEndpoints() Type used for Cloud Endpoints services.
boolean	hasCloudRun() Type used for Cloud Run services.
boolean	hasClusterIstio() Type used for Istio services that live in a Kubernetes cluster.
boolean	hasCustom() Custom service type.
boolean	hasGkeNamespace() Type used for GKE Namespaces.
boolean	hasGkeService() Type used for GKE Services (the Kubernetes concept of a service).
boolean	hasGkeWorkload() Type used for GKE Workloads.
boolean	hasIstioCanonicalService() Type used for canonical services scoped to an Istio mesh.
boolean	hasMeshIstio() Type used for Istio services scoped to an Istio mesh.
boolean	hasTelemetry() Configuration for how to query telemetry on a Service.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Identifier. Resource name for this Service. The format is:

     projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
 

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Identifier. Resource name for this Service. The format is:

     projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
 

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns:

The bytes for name.

getDisplayName

String getDisplayName()

 Name used for UI elements listing this Service.
 

string display_name = 2;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 Name used for UI elements listing this Service.
 

string display_name = 2;

Returns:

The bytes for displayName.

hasCustom

boolean hasCustom()

 Custom service type.
 

.google.monitoring.v3.Service.Custom custom = 6;

Returns:

Whether the custom field is set.

getCustom

Service.Custom getCustom()

 Custom service type.
 

.google.monitoring.v3.Service.Custom custom = 6;

Returns:

The custom.

getCustomOrBuilder

Service.CustomOrBuilder getCustomOrBuilder()

 Custom service type.
 

.google.monitoring.v3.Service.Custom custom = 6;

hasAppEngine

boolean hasAppEngine()

 Type used for App Engine services.
 

.google.monitoring.v3.Service.AppEngine app_engine = 7;

Returns:

Whether the appEngine field is set.

getAppEngine

Service.AppEngine getAppEngine()

 Type used for App Engine services.
 

.google.monitoring.v3.Service.AppEngine app_engine = 7;

Returns:

The appEngine.

getAppEngineOrBuilder

Service.AppEngineOrBuilder getAppEngineOrBuilder()

 Type used for App Engine services.
 

.google.monitoring.v3.Service.AppEngine app_engine = 7;

hasCloudEndpoints

boolean hasCloudEndpoints()

 Type used for Cloud Endpoints services.
 

.google.monitoring.v3.Service.CloudEndpoints cloud_endpoints = 8;

Returns:

Whether the cloudEndpoints field is set.

getCloudEndpoints

Service.CloudEndpoints getCloudEndpoints()

 Type used for Cloud Endpoints services.
 

.google.monitoring.v3.Service.CloudEndpoints cloud_endpoints = 8;

Returns:

The cloudEndpoints.

getCloudEndpointsOrBuilder

Service.CloudEndpointsOrBuilder getCloudEndpointsOrBuilder()

 Type used for Cloud Endpoints services.
 

.google.monitoring.v3.Service.CloudEndpoints cloud_endpoints = 8;

hasClusterIstio

boolean hasClusterIstio()

 Type used for Istio services that live in a Kubernetes cluster.
 

.google.monitoring.v3.Service.ClusterIstio cluster_istio = 9;

Returns:

Whether the clusterIstio field is set.

getClusterIstio

Service.ClusterIstio getClusterIstio()

 Type used for Istio services that live in a Kubernetes cluster.
 

.google.monitoring.v3.Service.ClusterIstio cluster_istio = 9;

Returns:

The clusterIstio.

getClusterIstioOrBuilder

Service.ClusterIstioOrBuilder getClusterIstioOrBuilder()

 Type used for Istio services that live in a Kubernetes cluster.
 

.google.monitoring.v3.Service.ClusterIstio cluster_istio = 9;

hasMeshIstio

boolean hasMeshIstio()

 Type used for Istio services scoped to an Istio mesh.
 

.google.monitoring.v3.Service.MeshIstio mesh_istio = 10;

Returns:

Whether the meshIstio field is set.

getMeshIstio

Service.MeshIstio getMeshIstio()

 Type used for Istio services scoped to an Istio mesh.
 

.google.monitoring.v3.Service.MeshIstio mesh_istio = 10;

Returns:

The meshIstio.

getMeshIstioOrBuilder

Service.MeshIstioOrBuilder getMeshIstioOrBuilder()

 Type used for Istio services scoped to an Istio mesh.
 

.google.monitoring.v3.Service.MeshIstio mesh_istio = 10;

hasIstioCanonicalService

boolean hasIstioCanonicalService()

 Type used for canonical services scoped to an Istio mesh.
 Metrics for Istio are
 [documented here](https://istio.io/latest/docs/reference/config/metrics/)
 

.google.monitoring.v3.Service.IstioCanonicalService istio_canonical_service = 11;

Returns:

Whether the istioCanonicalService field is set.

getIstioCanonicalService

Service.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/)
 

.google.monitoring.v3.Service.IstioCanonicalService istio_canonical_service = 11;

Returns:

The istioCanonicalService.

getIstioCanonicalServiceOrBuilder

Service.IstioCanonicalServiceOrBuilder getIstioCanonicalServiceOrBuilder()

 Type used for canonical services scoped to an Istio mesh.
 Metrics for Istio are
 [documented here](https://istio.io/latest/docs/reference/config/metrics/)
 

.google.monitoring.v3.Service.IstioCanonicalService istio_canonical_service = 11;

hasCloudRun

boolean hasCloudRun()

 Type used for Cloud Run services.
 

.google.monitoring.v3.Service.CloudRun cloud_run = 12;

Returns:

Whether the cloudRun field is set.

getCloudRun

Service.CloudRun getCloudRun()

 Type used for Cloud Run services.
 

.google.monitoring.v3.Service.CloudRun cloud_run = 12;

Returns:

The cloudRun.

getCloudRunOrBuilder

Service.CloudRunOrBuilder getCloudRunOrBuilder()

 Type used for Cloud Run services.
 

.google.monitoring.v3.Service.CloudRun cloud_run = 12;

hasGkeNamespace

boolean hasGkeNamespace()

 Type used for GKE Namespaces.
 

.google.monitoring.v3.Service.GkeNamespace gke_namespace = 15;

Returns:

Whether the gkeNamespace field is set.

getGkeNamespace

Service.GkeNamespace getGkeNamespace()

 Type used for GKE Namespaces.
 

.google.monitoring.v3.Service.GkeNamespace gke_namespace = 15;

Returns:

The gkeNamespace.

getGkeNamespaceOrBuilder

Service.GkeNamespaceOrBuilder getGkeNamespaceOrBuilder()

 Type used for GKE Namespaces.
 

.google.monitoring.v3.Service.GkeNamespace gke_namespace = 15;

hasGkeWorkload

boolean hasGkeWorkload()

 Type used for GKE Workloads.
 

.google.monitoring.v3.Service.GkeWorkload gke_workload = 16;

Returns:

Whether the gkeWorkload field is set.

getGkeWorkload

Service.GkeWorkload getGkeWorkload()

 Type used for GKE Workloads.
 

.google.monitoring.v3.Service.GkeWorkload gke_workload = 16;

Returns:

The gkeWorkload.

getGkeWorkloadOrBuilder

Service.GkeWorkloadOrBuilder getGkeWorkloadOrBuilder()

 Type used for GKE Workloads.
 

.google.monitoring.v3.Service.GkeWorkload gke_workload = 16;

hasGkeService

boolean hasGkeService()

 Type used for GKE Services (the Kubernetes concept of a service).
 

.google.monitoring.v3.Service.GkeService gke_service = 17;

Returns:

Whether the gkeService field is set.

getGkeService

Service.GkeService getGkeService()

 Type used for GKE Services (the Kubernetes concept of a service).
 

.google.monitoring.v3.Service.GkeService gke_service = 17;

Returns:

The gkeService.

getGkeServiceOrBuilder

Service.GkeServiceOrBuilder getGkeServiceOrBuilder()

 Type used for GKE Services (the Kubernetes concept of a service).
 

.google.monitoring.v3.Service.GkeService gke_service = 17;

hasBasicService

boolean hasBasicService()

 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).
 

.google.monitoring.v3.Service.BasicService basic_service = 19;

Returns:

Whether the basicService field is set.

getBasicService

Service.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).
 

.google.monitoring.v3.Service.BasicService basic_service = 19;

Returns:

The basicService.

getBasicServiceOrBuilder

Service.BasicServiceOrBuilder getBasicServiceOrBuilder()

 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).
 

.google.monitoring.v3.Service.BasicService basic_service = 19;

hasTelemetry

boolean hasTelemetry()

 Configuration for how to query telemetry on a Service.
 

.google.monitoring.v3.Service.Telemetry telemetry = 13;

Returns:

Whether the telemetry field is set.

getTelemetry

Service.Telemetry getTelemetry()

 Configuration for how to query telemetry on a Service.
 

.google.monitoring.v3.Service.Telemetry telemetry = 13;

Returns:

The telemetry.

getTelemetryOrBuilder

Service.TelemetryOrBuilder getTelemetryOrBuilder()

 Configuration for how to query telemetry on a Service.
 

.google.monitoring.v3.Service.Telemetry telemetry = 13;

getUserLabelsCount

int getUserLabelsCount()

 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.
 

map<string, string> user_labels = 14;

containsUserLabels

boolean containsUserLabels(String key)

 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.
 

map<string, string> user_labels = 14;

getUserLabels

@Deprecated
Map<String,String> getUserLabels()

Deprecated.

Use getUserLabelsMap() instead.

getUserLabelsMap

Map<String,String> getUserLabelsMap()

 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.
 

map<string, string> user_labels = 14;

getUserLabelsOrDefault

String getUserLabelsOrDefault(String key,
                              String defaultValue)

 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.
 

map<string, string> user_labels = 14;

getUserLabelsOrThrow

String getUserLabelsOrThrow(String key)

 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.
 

map<string, string> user_labels = 14;

getIdentifierCase

Service.IdentifierCase getIdentifierCase()