public static final class MetricDescriptor.Builder extends GeneratedMessageV3.Builder<MetricDescriptor.Builder> 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 | Method and Description |
|---|---|
MetricDescriptor.Builder |
addAllLabels(java.lang.Iterable<? extends LabelDescriptor> values)
The set of labels that can be used to describe a specific
instance of this metric type.
|
MetricDescriptor.Builder |
addLabels(int index,
LabelDescriptor.Builder builderForValue)
The set of labels that can be used to describe a specific
instance of this metric type.
|
MetricDescriptor.Builder |
addLabels(int index,
LabelDescriptor value)
The set of labels that can be used to describe a specific
instance of this metric type.
|
MetricDescriptor.Builder |
addLabels(LabelDescriptor.Builder builderForValue)
The set of labels that can be used to describe a specific
instance of this metric type.
|
MetricDescriptor.Builder |
addLabels(LabelDescriptor value)
The set of labels that can be used to describe a specific
instance of this metric type.
|
LabelDescriptor.Builder |
addLabelsBuilder()
The set of labels that can be used to describe a specific
instance of this metric type.
|
LabelDescriptor.Builder |
addLabelsBuilder(int index)
The set of labels that can be used to describe a specific
instance of this metric type.
|
MetricDescriptor.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
MetricDescriptor |
build() |
MetricDescriptor |
buildPartial() |
MetricDescriptor.Builder |
clear() |
MetricDescriptor.Builder |
clearDescription()
A detailed description of the metric, which can be used in documentation.
|
MetricDescriptor.Builder |
clearDisplayName()
A concise name for the metric, which can be displayed in user interfaces.
|
MetricDescriptor.Builder |
clearField(Descriptors.FieldDescriptor field) |
MetricDescriptor.Builder |
clearLabels()
The set of labels that can be used to describe a specific
instance of this metric type.
|
MetricDescriptor.Builder |
clearLaunchStage()
Optional.
|
MetricDescriptor.Builder |
clearMetadata()
Optional.
|
MetricDescriptor.Builder |
clearMetricKind()
Whether the metric records instantaneous values, changes to a value, etc.
|
MetricDescriptor.Builder |
clearName()
The resource name of the metric descriptor.
|
MetricDescriptor.Builder |
clearOneof(Descriptors.OneofDescriptor oneof) |
MetricDescriptor.Builder |
clearType()
The metric type, including its DNS name prefix.
|
MetricDescriptor.Builder |
clearUnit()
The unit in which the metric value is reported.
|
MetricDescriptor.Builder |
clearValueType()
Whether the measurement is an integer, a floating-point number, etc.
|
MetricDescriptor.Builder |
clone() |
MetricDescriptor |
getDefaultInstanceForType() |
java.lang.String |
getDescription()
A detailed description of the metric, which can be used in documentation.
|
ByteString |
getDescriptionBytes()
A detailed description of the metric, which can be used in documentation.
|
static Descriptors.Descriptor |
getDescriptor() |
Descriptors.Descriptor |
getDescriptorForType() |
java.lang.String |
getDisplayName()
A concise name for the metric, which can be displayed in user interfaces.
|
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.
|
LabelDescriptor.Builder |
getLabelsBuilder(int index)
The set of labels that can be used to describe a specific
instance of this metric type.
|
java.util.List<LabelDescriptor.Builder> |
getLabelsBuilderList()
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.
|
LaunchStage |
getLaunchStage()
Optional.
|
int |
getLaunchStageValue()
Optional.
|
MetricDescriptor.MetricDescriptorMetadata |
getMetadata()
Optional.
|
MetricDescriptor.MetricDescriptorMetadata.Builder |
getMetadataBuilder()
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.
|
ByteString |
getNameBytes()
The resource name of the metric descriptor.
|
java.lang.String |
getType()
The metric type, including its DNS name prefix.
|
ByteString |
getTypeBytes()
The metric type, including its DNS name prefix.
|
java.lang.String |
getUnit()
The unit in which the metric value is reported.
|
ByteString |
getUnitBytes()
The unit in which the metric value is reported.
|
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.
|
boolean |
hasMetadata()
Optional.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
MetricDescriptor.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
MetricDescriptor.Builder |
mergeFrom(Message other) |
MetricDescriptor.Builder |
mergeFrom(MetricDescriptor other) |
MetricDescriptor.Builder |
mergeMetadata(MetricDescriptor.MetricDescriptorMetadata value)
Optional.
|
MetricDescriptor.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields) |
MetricDescriptor.Builder |
removeLabels(int index)
The set of labels that can be used to describe a specific
instance of this metric type.
|
MetricDescriptor.Builder |
setDescription(java.lang.String value)
A detailed description of the metric, which can be used in documentation.
|
MetricDescriptor.Builder |
setDescriptionBytes(ByteString value)
A detailed description of the metric, which can be used in documentation.
|
MetricDescriptor.Builder |
setDisplayName(java.lang.String value)
A concise name for the metric, which can be displayed in user interfaces.
|
MetricDescriptor.Builder |
setDisplayNameBytes(ByteString value)
A concise name for the metric, which can be displayed in user interfaces.
|
MetricDescriptor.Builder |
setField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
MetricDescriptor.Builder |
setLabels(int index,
LabelDescriptor.Builder builderForValue)
The set of labels that can be used to describe a specific
instance of this metric type.
|
MetricDescriptor.Builder |
setLabels(int index,
LabelDescriptor value)
The set of labels that can be used to describe a specific
instance of this metric type.
|
MetricDescriptor.Builder |
setLaunchStage(LaunchStage value)
Optional.
|
MetricDescriptor.Builder |
setLaunchStageValue(int value)
Optional.
|
MetricDescriptor.Builder |
setMetadata(MetricDescriptor.MetricDescriptorMetadata.Builder builderForValue)
Optional.
|
MetricDescriptor.Builder |
setMetadata(MetricDescriptor.MetricDescriptorMetadata value)
Optional.
|
MetricDescriptor.Builder |
setMetricKind(MetricDescriptor.MetricKind value)
Whether the metric records instantaneous values, changes to a value, etc.
|
MetricDescriptor.Builder |
setMetricKindValue(int value)
Whether the metric records instantaneous values, changes to a value, etc.
|
MetricDescriptor.Builder |
setName(java.lang.String value)
The resource name of the metric descriptor.
|
MetricDescriptor.Builder |
setNameBytes(ByteString value)
The resource name of the metric descriptor.
|
MetricDescriptor.Builder |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
MetricDescriptor.Builder |
setType(java.lang.String value)
The metric type, including its DNS name prefix.
|
MetricDescriptor.Builder |
setTypeBytes(ByteString value)
The metric type, including its DNS name prefix.
|
MetricDescriptor.Builder |
setUnit(java.lang.String value)
The unit in which the metric value is reported.
|
MetricDescriptor.Builder |
setUnitBytes(ByteString value)
The unit in which the metric value is reported.
|
MetricDescriptor.Builder |
setUnknownFields(UnknownFieldSet unknownFields) |
MetricDescriptor.Builder |
setValueType(MetricDescriptor.ValueType value)
Whether the measurement is an integer, a floating-point number, etc.
|
MetricDescriptor.Builder |
setValueTypeValue(int value)
Whether the measurement is an integer, a floating-point number, etc.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<MetricDescriptor.Builder>public MetricDescriptor.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<MetricDescriptor.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<MetricDescriptor.Builder>public MetricDescriptor getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic MetricDescriptor build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic MetricDescriptor buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic MetricDescriptor.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<MetricDescriptor.Builder>public MetricDescriptor.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<MetricDescriptor.Builder>public MetricDescriptor.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<MetricDescriptor.Builder>public MetricDescriptor.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<MetricDescriptor.Builder>public MetricDescriptor.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<MetricDescriptor.Builder>public MetricDescriptor.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<MetricDescriptor.Builder>public MetricDescriptor.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<MetricDescriptor.Builder>public MetricDescriptor.Builder mergeFrom(MetricDescriptor other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<MetricDescriptor.Builder>public MetricDescriptor.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<MetricDescriptor.Builder>java.io.IOExceptionpublic java.lang.String getName()
The resource name of the metric descriptor.
string name = 1;getName in interface MetricDescriptorOrBuilderpublic ByteString getNameBytes()
The resource name of the metric descriptor.
string name = 1;getNameBytes in interface MetricDescriptorOrBuilderpublic MetricDescriptor.Builder setName(java.lang.String value)
The resource name of the metric descriptor.
string name = 1;public MetricDescriptor.Builder clearName()
The resource name of the metric descriptor.
string name = 1;public MetricDescriptor.Builder setNameBytes(ByteString value)
The resource name of the metric descriptor.
string name = 1;public 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 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 MetricDescriptor.Builder setType(java.lang.String value)
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;public MetricDescriptor.Builder clearType()
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;public MetricDescriptor.Builder setTypeBytes(ByteString value)
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;public 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 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 MetricDescriptor.Builder setLabels(int index, LabelDescriptor value)
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;public MetricDescriptor.Builder setLabels(int index, LabelDescriptor.Builder builderForValue)
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;public MetricDescriptor.Builder addLabels(LabelDescriptor value)
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;public MetricDescriptor.Builder addLabels(int index, LabelDescriptor value)
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;public MetricDescriptor.Builder addLabels(LabelDescriptor.Builder builderForValue)
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;public MetricDescriptor.Builder addLabels(int index, LabelDescriptor.Builder builderForValue)
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;public MetricDescriptor.Builder addAllLabels(java.lang.Iterable<? extends LabelDescriptor> values)
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;public MetricDescriptor.Builder clearLabels()
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;public MetricDescriptor.Builder removeLabels(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;public LabelDescriptor.Builder getLabelsBuilder(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;public 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 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 LabelDescriptor.Builder addLabelsBuilder()
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;public LabelDescriptor.Builder addLabelsBuilder(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;public java.util.List<LabelDescriptor.Builder> getLabelsBuilderList()
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;public 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.Builder setMetricKindValue(int value)
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;public 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 MetricDescriptor.Builder setMetricKind(MetricDescriptor.MetricKind value)
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;public MetricDescriptor.Builder clearMetricKind()
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;public 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.Builder setValueTypeValue(int value)
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;public 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 MetricDescriptor.Builder setValueType(MetricDescriptor.ValueType value)
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;public MetricDescriptor.Builder clearValueType()
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;public 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 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 MetricDescriptor.Builder setUnit(java.lang.String value)
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;public MetricDescriptor.Builder clearUnit()
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;public MetricDescriptor.Builder setUnitBytes(ByteString value)
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;public java.lang.String getDescription()
A detailed description of the metric, which can be used in documentation.
string description = 6;getDescription in interface MetricDescriptorOrBuilderpublic ByteString getDescriptionBytes()
A detailed description of the metric, which can be used in documentation.
string description = 6;getDescriptionBytes in interface MetricDescriptorOrBuilderpublic MetricDescriptor.Builder setDescription(java.lang.String value)
A detailed description of the metric, which can be used in documentation.
string description = 6;public MetricDescriptor.Builder clearDescription()
A detailed description of the metric, which can be used in documentation.
string description = 6;public MetricDescriptor.Builder setDescriptionBytes(ByteString value)
A detailed description of the metric, which can be used in documentation.
string description = 6;public 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 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 MetricDescriptor.Builder setDisplayName(java.lang.String value)
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;public MetricDescriptor.Builder clearDisplayName()
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;public MetricDescriptor.Builder setDisplayNameBytes(ByteString value)
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;public 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.Builder setMetadata(MetricDescriptor.MetricDescriptorMetadata value)
Optional. Metadata which can be used to guide usage of the metric.
.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;public MetricDescriptor.Builder setMetadata(MetricDescriptor.MetricDescriptorMetadata.Builder builderForValue)
Optional. Metadata which can be used to guide usage of the metric.
.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;public MetricDescriptor.Builder mergeMetadata(MetricDescriptor.MetricDescriptorMetadata value)
Optional. Metadata which can be used to guide usage of the metric.
.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;public MetricDescriptor.Builder clearMetadata()
Optional. Metadata which can be used to guide usage of the metric.
.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;public MetricDescriptor.MetricDescriptorMetadata.Builder getMetadataBuilder()
Optional. Metadata which can be used to guide usage of the metric.
.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;public 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 int getLaunchStageValue()
Optional. The launch stage of the metric definition.
.google.api.LaunchStage launch_stage = 12;getLaunchStageValue in interface MetricDescriptorOrBuilderpublic MetricDescriptor.Builder setLaunchStageValue(int value)
Optional. The launch stage of the metric definition.
.google.api.LaunchStage launch_stage = 12;public LaunchStage getLaunchStage()
Optional. The launch stage of the metric definition.
.google.api.LaunchStage launch_stage = 12;getLaunchStage in interface MetricDescriptorOrBuilderpublic MetricDescriptor.Builder setLaunchStage(LaunchStage value)
Optional. The launch stage of the metric definition.
.google.api.LaunchStage launch_stage = 12;public MetricDescriptor.Builder clearLaunchStage()
Optional. The launch stage of the metric definition.
.google.api.LaunchStage launch_stage = 12;public final MetricDescriptor.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<MetricDescriptor.Builder>public final MetricDescriptor.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<MetricDescriptor.Builder>