Interface ServiceOrBuilder (3.30.0)

Version 3.30.0

• 3.56.0 (latest)
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.6
• 3.3.6
• 3.2.10

public interface ServiceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsUserLabels(String key)

public abstract 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;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAppEngine()

public abstract Service.AppEngine getAppEngine()

Type used for App Engine services.

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

Returns
Type	Description
Service.AppEngine	The appEngine.

getAppEngineOrBuilder()

public abstract Service.AppEngineOrBuilder getAppEngineOrBuilder()

Type used for App Engine services.

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

Returns
Type	Description
Service.AppEngineOrBuilder

getCloudEndpoints()

public abstract Service.CloudEndpoints getCloudEndpoints()

Type used for Cloud Endpoints services.

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

Returns
Type	Description
Service.CloudEndpoints	The cloudEndpoints.

getCloudEndpointsOrBuilder()

public abstract Service.CloudEndpointsOrBuilder getCloudEndpointsOrBuilder()

Type used for Cloud Endpoints services.

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

Returns
Type	Description
Service.CloudEndpointsOrBuilder

getClusterIstio()

public abstract Service.ClusterIstio getClusterIstio()

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

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

Returns
Type	Description
Service.ClusterIstio	The clusterIstio.

getClusterIstioOrBuilder()

public abstract Service.ClusterIstioOrBuilder getClusterIstioOrBuilder()

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

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

Returns
Type	Description
Service.ClusterIstioOrBuilder

getCustom()

public abstract Service.Custom getCustom()

Custom service type.

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

Returns
Type	Description
Service.Custom	The custom.

getCustomOrBuilder()

public abstract Service.CustomOrBuilder getCustomOrBuilder()

Custom service type.

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

Returns
Type	Description
Service.CustomOrBuilder

getDisplayName()

public abstract String getDisplayName()

Name used for UI elements listing this Service.

string display_name = 2;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Name used for UI elements listing this Service.

string display_name = 2;

Returns
Type	Description
ByteString	The bytes for displayName.

getIdentifierCase()

public abstract Service.IdentifierCase getIdentifierCase()

Returns
Type	Description
Service.IdentifierCase

getIstioCanonicalService()

public abstract Service.IstioCanonicalService getIstioCanonicalService()

Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here

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

Returns
Type	Description
Service.IstioCanonicalService	The istioCanonicalService.

getIstioCanonicalServiceOrBuilder()

public abstract Service.IstioCanonicalServiceOrBuilder getIstioCanonicalServiceOrBuilder()

Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here

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

Returns
Type	Description
Service.IstioCanonicalServiceOrBuilder

getMeshIstio()

public abstract Service.MeshIstio getMeshIstio()

Type used for Istio services scoped to an Istio mesh.

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

Returns
Type	Description
Service.MeshIstio	The meshIstio.

getMeshIstioOrBuilder()

public abstract Service.MeshIstioOrBuilder getMeshIstioOrBuilder()

Type used for Istio services scoped to an Istio mesh.

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

Returns
Type	Description
Service.MeshIstioOrBuilder

getName()

public abstract String getName()

Resource name for this Service. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Resource name for this Service. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getTelemetry()

public abstract Service.Telemetry getTelemetry()

Configuration for how to query telemetry on a Service.

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

Returns
Type	Description
Service.Telemetry	The telemetry.

getTelemetryOrBuilder()

public abstract Service.TelemetryOrBuilder getTelemetryOrBuilder()

Configuration for how to query telemetry on a Service.

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

Returns
Type	Description
Service.TelemetryOrBuilder

getUserLabels()

public abstract Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getUserLabelsCount()

public abstract 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;

Returns
Type	Description
int

getUserLabelsMap()

public abstract 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;

Returns
Type	Description
Map<String,String>

getUserLabelsOrDefault(String key, String defaultValue)

public abstract 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;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getUserLabelsOrThrow(String key)

public abstract 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;

Parameter
Name	Description
key	String

Returns
Type	Description
String

hasAppEngine()

public abstract boolean hasAppEngine()

Type used for App Engine services.

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

Returns
Type	Description
boolean	Whether the appEngine field is set.

hasCloudEndpoints()

public abstract boolean hasCloudEndpoints()

Type used for Cloud Endpoints services.

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

Returns
Type	Description
boolean	Whether the cloudEndpoints field is set.

hasClusterIstio()

public abstract boolean hasClusterIstio()

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

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

Returns
Type	Description
boolean	Whether the clusterIstio field is set.

hasCustom()

public abstract boolean hasCustom()

Custom service type.

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

Returns
Type	Description
boolean	Whether the custom field is set.

hasIstioCanonicalService()

public abstract boolean hasIstioCanonicalService()

Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here

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

Returns
Type	Description
boolean	Whether the istioCanonicalService field is set.

hasMeshIstio()

public abstract boolean hasMeshIstio()

Type used for Istio services scoped to an Istio mesh.

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

Returns
Type	Description
boolean	Whether the meshIstio field is set.

hasTelemetry()

public abstract boolean hasTelemetry()

Configuration for how to query telemetry on a Service.

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

Returns
Type	Description
boolean	Whether the telemetry field is set.