public final class Service extends GeneratedMessageV3 implements ServiceOrBuilder
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.
Protobuf type google.monitoring.v3.Service
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
APP_ENGINE_FIELD_NUMBER
public static final int APP_ENGINE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BASIC_SERVICE_FIELD_NUMBER
public static final int BASIC_SERVICE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLOUD_ENDPOINTS_FIELD_NUMBER
public static final int CLOUD_ENDPOINTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLOUD_RUN_FIELD_NUMBER
public static final int CLOUD_RUN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLUSTER_ISTIO_FIELD_NUMBER
public static final int CLUSTER_ISTIO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CUSTOM_FIELD_NUMBER
public static final int CUSTOM_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GKE_NAMESPACE_FIELD_NUMBER
public static final int GKE_NAMESPACE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GKE_SERVICE_FIELD_NUMBER
public static final int GKE_SERVICE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GKE_WORKLOAD_FIELD_NUMBER
public static final int GKE_WORKLOAD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ISTIO_CANONICAL_SERVICE_FIELD_NUMBER
public static final int ISTIO_CANONICAL_SERVICE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MESH_ISTIO_FIELD_NUMBER
public static final int MESH_ISTIO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TELEMETRY_FIELD_NUMBER
public static final int TELEMETRY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USER_LABELS_FIELD_NUMBER
public static final int USER_LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Service getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Service.Builder newBuilder()
newBuilder(Service prototype)
public static Service.Builder newBuilder(Service prototype)
| Parameter |
| Name |
Description |
prototype |
Service
|
public static Service parseDelimitedFrom(InputStream input)
public static Service parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Service parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Service parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(CodedInputStream input)
public static Service parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(InputStream input)
public static Service parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Service parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Service> parser()
Methods
containsUserLabels(String key)
public 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAppEngine()
public Service.AppEngine getAppEngine()
Type used for App Engine services.
.google.monitoring.v3.Service.AppEngine app_engine = 7;
getAppEngineOrBuilder()
public Service.AppEngineOrBuilder getAppEngineOrBuilder()
Type used for App Engine services.
.google.monitoring.v3.Service.AppEngine app_engine = 7;
getBasicService()
public 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.
.google.monitoring.v3.Service.BasicService basic_service = 19;
getBasicServiceOrBuilder()
public 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.
.google.monitoring.v3.Service.BasicService basic_service = 19;
getCloudEndpoints()
public Service.CloudEndpoints getCloudEndpoints()
Type used for Cloud Endpoints services.
.google.monitoring.v3.Service.CloudEndpoints cloud_endpoints = 8;
getCloudEndpointsOrBuilder()
public Service.CloudEndpointsOrBuilder getCloudEndpointsOrBuilder()
Type used for Cloud Endpoints services.
.google.monitoring.v3.Service.CloudEndpoints cloud_endpoints = 8;
getCloudRun()
public Service.CloudRun getCloudRun()
Type used for Cloud Run services.
.google.monitoring.v3.Service.CloudRun cloud_run = 12;
getCloudRunOrBuilder()
public Service.CloudRunOrBuilder getCloudRunOrBuilder()
Type used for Cloud Run services.
.google.monitoring.v3.Service.CloudRun cloud_run = 12;
getClusterIstio()
public Service.ClusterIstio getClusterIstio()
Type used for Istio services that live in a Kubernetes cluster.
.google.monitoring.v3.Service.ClusterIstio cluster_istio = 9;
getClusterIstioOrBuilder()
public Service.ClusterIstioOrBuilder getClusterIstioOrBuilder()
Type used for Istio services that live in a Kubernetes cluster.
.google.monitoring.v3.Service.ClusterIstio cluster_istio = 9;
getCustom()
public Service.Custom getCustom()
Custom service type.
.google.monitoring.v3.Service.Custom custom = 6;
getCustomOrBuilder()
public Service.CustomOrBuilder getCustomOrBuilder()
Custom service type.
.google.monitoring.v3.Service.Custom custom = 6;
getDefaultInstanceForType()
public Service getDefaultInstanceForType()
getDisplayName()
public String getDisplayName()
Name used for UI elements listing this Service.
string display_name = 2;
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Name used for UI elements listing this Service.
string display_name = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getGkeNamespace()
public Service.GkeNamespace getGkeNamespace()
Type used for GKE Namespaces.
.google.monitoring.v3.Service.GkeNamespace gke_namespace = 15;
getGkeNamespaceOrBuilder()
public Service.GkeNamespaceOrBuilder getGkeNamespaceOrBuilder()
Type used for GKE Namespaces.
.google.monitoring.v3.Service.GkeNamespace gke_namespace = 15;
getGkeService()
public Service.GkeService getGkeService()
Type used for GKE Services (the Kubernetes concept of a service).
.google.monitoring.v3.Service.GkeService gke_service = 17;
getGkeServiceOrBuilder()
public Service.GkeServiceOrBuilder getGkeServiceOrBuilder()
Type used for GKE Services (the Kubernetes concept of a service).
.google.monitoring.v3.Service.GkeService gke_service = 17;
getGkeWorkload()
public Service.GkeWorkload getGkeWorkload()
Type used for GKE Workloads.
.google.monitoring.v3.Service.GkeWorkload gke_workload = 16;
getGkeWorkloadOrBuilder()
public Service.GkeWorkloadOrBuilder getGkeWorkloadOrBuilder()
Type used for GKE Workloads.
.google.monitoring.v3.Service.GkeWorkload gke_workload = 16;
getIdentifierCase()
public Service.IdentifierCase getIdentifierCase()
getIstioCanonicalService()
public 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;
getIstioCanonicalServiceOrBuilder()
public 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;
getMeshIstio()
public Service.MeshIstio getMeshIstio()
Type used for Istio services scoped to an Istio mesh.
.google.monitoring.v3.Service.MeshIstio mesh_istio = 10;
getMeshIstioOrBuilder()
public Service.MeshIstioOrBuilder getMeshIstioOrBuilder()
Type used for Istio services scoped to an Istio mesh.
.google.monitoring.v3.Service.MeshIstio mesh_istio = 10;
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 |
| Type |
Description |
String |
The name.
|
getNameBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Service> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTelemetry()
public Service.Telemetry getTelemetry()
Configuration for how to query telemetry on a Service.
.google.monitoring.v3.Service.Telemetry telemetry = 13;
getTelemetryOrBuilder()
public Service.TelemetryOrBuilder getTelemetryOrBuilder()
Configuration for how to query telemetry on a Service.
.google.monitoring.v3.Service.Telemetry telemetry = 13;
getUserLabels() (deprecated)
public Map<String,String> getUserLabels()
getUserLabelsCount()
public 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 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 key, String defaultValue)
public 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;
| Returns |
| Type |
Description |
String |
|
getUserLabelsOrThrow(String key)
public 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 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.
|
hasBasicService()
public boolean hasBasicService()
Message that contains the service type and service labels of this service
if it is a basic service.
Documentation and examples
here.
.google.monitoring.v3.Service.BasicService basic_service = 19;
| Returns |
| Type |
Description |
boolean |
Whether the basicService field is set.
|
hasCloudEndpoints()
public 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.
|
hasCloudRun()
public boolean hasCloudRun()
Type used for Cloud Run services.
.google.monitoring.v3.Service.CloudRun cloud_run = 12;
| Returns |
| Type |
Description |
boolean |
Whether the cloudRun field is set.
|
hasClusterIstio()
public 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 boolean hasCustom()
Custom service type.
.google.monitoring.v3.Service.Custom custom = 6;
| Returns |
| Type |
Description |
boolean |
Whether the custom field is set.
|
hasGkeNamespace()
public boolean hasGkeNamespace()
Type used for GKE Namespaces.
.google.monitoring.v3.Service.GkeNamespace gke_namespace = 15;
| Returns |
| Type |
Description |
boolean |
Whether the gkeNamespace field is set.
|
hasGkeService()
public boolean hasGkeService()
Type used for GKE Services (the Kubernetes concept of a service).
.google.monitoring.v3.Service.GkeService gke_service = 17;
| Returns |
| Type |
Description |
boolean |
Whether the gkeService field is set.
|
hasGkeWorkload()
public boolean hasGkeWorkload()
Type used for GKE Workloads.
.google.monitoring.v3.Service.GkeWorkload gke_workload = 16;
| Returns |
| Type |
Description |
boolean |
Whether the gkeWorkload field is set.
|
hasIstioCanonicalService()
public 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 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Service.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Service.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Service.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
