public final class MetricDescriptor extends com.google.protobuf.GeneratedMessageV3 implements MetricDescriptorOrBuilder
Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.Protobuf type
google.api.MetricDescriptor| Modifier and Type | Class and Description |
|---|---|
static class |
MetricDescriptor.Builder
Defines a metric type and its schema.
|
static class |
MetricDescriptor.MetricDescriptorMetadata
Additional annotations that can be used to guide the usage of a metric.
|
static interface |
MetricDescriptor.MetricDescriptorMetadataOrBuilder |
static class |
MetricDescriptor.MetricKind
The kind of measurement.
|
static class |
MetricDescriptor.ValueType
The value type of a metric.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable| Modifier and Type | Field and Description |
|---|---|
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
METADATA_FIELD_NUMBER |
static int |
METRIC_KIND_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
TYPE_FIELD_NUMBER |
static int |
UNIT_FIELD_NUMBER |
static int |
VALUE_TYPE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
static MetricDescriptor |
getDefaultInstance() |
MetricDescriptor |
getDefaultInstanceForType() |
java.lang.String |
getDescription()
A detailed description of the metric, which can be used in documentation.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
A detailed description of the metric, which can be used in documentation.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
java.lang.String |
getDisplayName()
A concise name for the metric, which can be displayed in user interfaces.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
A concise name for the metric, which can be displayed in user interfaces.
|
LabelDescriptor |
getLabels(int index)
The set of labels that can be used to describe a specific
instance of this metric type.
|
int |
getLabelsCount()
The set of labels that can be used to describe a specific
instance of this metric type.
|
java.util.List<LabelDescriptor> |
getLabelsList()
The set of labels that can be used to describe a specific
instance of this metric type.
|
LabelDescriptorOrBuilder |
getLabelsOrBuilder(int index)
The set of labels that can be used to describe a specific
instance of this metric type.
|
java.util.List<? extends LabelDescriptorOrBuilder> |
getLabelsOrBuilderList()
The set of labels that can be used to describe a specific
instance of this metric type.
|
MetricDescriptor.MetricDescriptorMetadata |
getMetadata()
Optional.
|
MetricDescriptor.MetricDescriptorMetadataOrBuilder |
getMetadataOrBuilder()
Optional.
|
MetricDescriptor.MetricKind |
getMetricKind()
Whether the metric records instantaneous values, changes to a value, etc.
|
int |
getMetricKindValue()
Whether the metric records instantaneous values, changes to a value, etc.
|
java.lang.String |
getName()
The resource name of the metric descriptor.
|
com.google.protobuf.ByteString |
getNameBytes()
The resource name of the metric descriptor.
|
com.google.protobuf.Parser<MetricDescriptor> |
getParserForType() |
int |
getSerializedSize() |
java.lang.String |
getType()
The metric type, including its DNS name prefix.
|
com.google.protobuf.ByteString |
getTypeBytes()
The metric type, including its DNS name prefix.
|
java.lang.String |
getUnit()
The unit in which the metric value is reported.
|
com.google.protobuf.ByteString |
getUnitBytes()
The unit in which the metric value is reported.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
MetricDescriptor.ValueType |
getValueType()
Whether the measurement is an integer, a floating-point number, etc.
|
int |
getValueTypeValue()
Whether the measurement is an integer, a floating-point number, etc.
|
int |
hashCode() |
boolean |
hasMetadata()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static MetricDescriptor.Builder |
newBuilder() |
static MetricDescriptor.Builder |
newBuilder(MetricDescriptor prototype) |
MetricDescriptor.Builder |
newBuilderForType() |
protected MetricDescriptor.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static MetricDescriptor |
parseDelimitedFrom(java.io.InputStream input) |
static MetricDescriptor |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static MetricDescriptor |
parseFrom(byte[] data) |
static MetricDescriptor |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static MetricDescriptor |
parseFrom(java.nio.ByteBuffer data) |
static MetricDescriptor |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static MetricDescriptor |
parseFrom(com.google.protobuf.ByteString data) |
static MetricDescriptor |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static MetricDescriptor |
parseFrom(com.google.protobuf.CodedInputStream input) |
static MetricDescriptor |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static MetricDescriptor |
parseFrom(java.io.InputStream input) |
static MetricDescriptor |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<MetricDescriptor> |
parser() |
MetricDescriptor.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int METRIC_KIND_FIELD_NUMBER
public static final int VALUE_TYPE_FIELD_NUMBER
public static final int UNIT_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public java.lang.String getName()
The resource name of the metric descriptor.
string name = 1;getName in interface MetricDescriptorOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The resource name of the metric descriptor.
string name = 1;getNameBytes in interface MetricDescriptorOrBuilderpublic java.lang.String getType()
The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined metric types have the DNS name
`custom.googleapis.com` or `external.googleapis.com`. Metric types should
use a natural hierarchical grouping. For example:
"custom.googleapis.com/invoice/paid/amount"
"external.googleapis.com/prometheus/up"
"appengine.googleapis.com/http/server/response_latencies"
string type = 8;getType in interface MetricDescriptorOrBuilderpublic com.google.protobuf.ByteString getTypeBytes()
The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined metric types have the DNS name
`custom.googleapis.com` or `external.googleapis.com`. Metric types should
use a natural hierarchical grouping. For example:
"custom.googleapis.com/invoice/paid/amount"
"external.googleapis.com/prometheus/up"
"appengine.googleapis.com/http/server/response_latencies"
string type = 8;getTypeBytes in interface MetricDescriptorOrBuilderpublic java.util.List<LabelDescriptor> getLabelsList()
The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.
repeated .google.api.LabelDescriptor labels = 2;getLabelsList in interface MetricDescriptorOrBuilderpublic java.util.List<? extends LabelDescriptorOrBuilder> getLabelsOrBuilderList()
The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.
repeated .google.api.LabelDescriptor labels = 2;getLabelsOrBuilderList in interface MetricDescriptorOrBuilderpublic int getLabelsCount()
The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.
repeated .google.api.LabelDescriptor labels = 2;getLabelsCount in interface MetricDescriptorOrBuilderpublic LabelDescriptor getLabels(int index)
The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.
repeated .google.api.LabelDescriptor labels = 2;getLabels in interface MetricDescriptorOrBuilderpublic LabelDescriptorOrBuilder getLabelsOrBuilder(int index)
The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.
repeated .google.api.LabelDescriptor labels = 2;getLabelsOrBuilder in interface MetricDescriptorOrBuilderpublic int getMetricKindValue()
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
.google.api.MetricDescriptor.MetricKind metric_kind = 3;getMetricKindValue in interface MetricDescriptorOrBuilderpublic MetricDescriptor.MetricKind getMetricKind()
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
.google.api.MetricDescriptor.MetricKind metric_kind = 3;getMetricKind in interface MetricDescriptorOrBuilderpublic int getValueTypeValue()
Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
.google.api.MetricDescriptor.ValueType value_type = 4;getValueTypeValue in interface MetricDescriptorOrBuilderpublic MetricDescriptor.ValueType getValueType()
Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported.
.google.api.MetricDescriptor.ValueType value_type = 4;getValueType in interface MetricDescriptorOrBuilderpublic java.lang.String getUnit()
The unit in which the metric value is reported. It is only applicable
if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
supported units are a subset of [The Unified Code for Units of
Measure](http://unitsofmeasure.org/ucum.html) standard:
**Basic units (UNIT)**
* `bit` bit
* `By` byte
* `s` second
* `min` minute
* `h` hour
* `d` day
**Prefixes (PREFIX)**
* `k` kilo (10**3)
* `M` mega (10**6)
* `G` giga (10**9)
* `T` tera (10**12)
* `P` peta (10**15)
* `E` exa (10**18)
* `Z` zetta (10**21)
* `Y` yotta (10**24)
* `m` milli (10**-3)
* `u` micro (10**-6)
* `n` nano (10**-9)
* `p` pico (10**-12)
* `f` femto (10**-15)
* `a` atto (10**-18)
* `z` zepto (10**-21)
* `y` yocto (10**-24)
* `Ki` kibi (2**10)
* `Mi` mebi (2**20)
* `Gi` gibi (2**30)
* `Ti` tebi (2**40)
**Grammar**
The grammar also includes these connectors:
* `/` division (as an infix operator, e.g. `1/s`).
* `.` multiplication (as an infix operator, e.g. `GBy.d`)
The grammar for a unit is as follows:
Expression = Component { "." Component } { "/" Component } ;
Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
| Annotation
| "1"
;
Annotation = "{" NAME "}" ;
Notes:
* `Annotation` is just a comment if it follows a `UNIT` and is
equivalent to `1` if it is used alone. For examples,
`{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
* `NAME` is a sequence of non-blank printable ASCII characters not
containing '{' or '}'.
* `1` represents dimensionless value 1, such as in `1/s`.
* `%` represents dimensionless value 1/100, and annotates values giving
a percentage.
string unit = 5;getUnit in interface MetricDescriptorOrBuilderpublic com.google.protobuf.ByteString getUnitBytes()
The unit in which the metric value is reported. It is only applicable
if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
supported units are a subset of [The Unified Code for Units of
Measure](http://unitsofmeasure.org/ucum.html) standard:
**Basic units (UNIT)**
* `bit` bit
* `By` byte
* `s` second
* `min` minute
* `h` hour
* `d` day
**Prefixes (PREFIX)**
* `k` kilo (10**3)
* `M` mega (10**6)
* `G` giga (10**9)
* `T` tera (10**12)
* `P` peta (10**15)
* `E` exa (10**18)
* `Z` zetta (10**21)
* `Y` yotta (10**24)
* `m` milli (10**-3)
* `u` micro (10**-6)
* `n` nano (10**-9)
* `p` pico (10**-12)
* `f` femto (10**-15)
* `a` atto (10**-18)
* `z` zepto (10**-21)
* `y` yocto (10**-24)
* `Ki` kibi (2**10)
* `Mi` mebi (2**20)
* `Gi` gibi (2**30)
* `Ti` tebi (2**40)
**Grammar**
The grammar also includes these connectors:
* `/` division (as an infix operator, e.g. `1/s`).
* `.` multiplication (as an infix operator, e.g. `GBy.d`)
The grammar for a unit is as follows:
Expression = Component { "." Component } { "/" Component } ;
Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
| Annotation
| "1"
;
Annotation = "{" NAME "}" ;
Notes:
* `Annotation` is just a comment if it follows a `UNIT` and is
equivalent to `1` if it is used alone. For examples,
`{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
* `NAME` is a sequence of non-blank printable ASCII characters not
containing '{' or '}'.
* `1` represents dimensionless value 1, such as in `1/s`.
* `%` represents dimensionless value 1/100, and annotates values giving
a percentage.
string unit = 5;getUnitBytes in interface MetricDescriptorOrBuilderpublic java.lang.String getDescription()
A detailed description of the metric, which can be used in documentation.
string description = 6;getDescription in interface MetricDescriptorOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
A detailed description of the metric, which can be used in documentation.
string description = 6;getDescriptionBytes in interface MetricDescriptorOrBuilderpublic java.lang.String getDisplayName()
A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
string display_name = 7;getDisplayName in interface MetricDescriptorOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
string display_name = 7;getDisplayNameBytes in interface MetricDescriptorOrBuilderpublic boolean hasMetadata()
Optional. Metadata which can be used to guide usage of the metric.
.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;hasMetadata in interface MetricDescriptorOrBuilderpublic MetricDescriptor.MetricDescriptorMetadata getMetadata()
Optional. Metadata which can be used to guide usage of the metric.
.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;getMetadata in interface MetricDescriptorOrBuilderpublic MetricDescriptor.MetricDescriptorMetadataOrBuilder getMetadataOrBuilder()
Optional. Metadata which can be used to guide usage of the metric.
.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;getMetadataOrBuilder in interface MetricDescriptorOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3java.io.IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(java.lang.Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static MetricDescriptor parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static MetricDescriptor parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static MetricDescriptor parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static MetricDescriptor parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static MetricDescriptor parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static MetricDescriptor parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static MetricDescriptor parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static MetricDescriptor parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static MetricDescriptor parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static MetricDescriptor parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static MetricDescriptor parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOExceptionpublic static MetricDescriptor parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic MetricDescriptor.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static MetricDescriptor.Builder newBuilder()
public static MetricDescriptor.Builder newBuilder(MetricDescriptor prototype)
public MetricDescriptor.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected MetricDescriptor.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static MetricDescriptor getDefaultInstance()
public static com.google.protobuf.Parser<MetricDescriptor> parser()
public com.google.protobuf.Parser<MetricDescriptor> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public MetricDescriptor getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder