MetricDescriptor (proto-google-common-protos 2.0.1 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.api.MetricDescriptor

All Implemented Interfaces:: MetricDescriptorOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

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.
 The following are specific rules for service defined Monitoring metric
 descriptors:
 * `type`, `metric_kind`, `value_type`, `description`, `display_name`,
   `launch_stage` fields are all required. The `unit` field must be specified
   if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION.
 * Maximum of default 500 metric descriptors per service is allowed.
 * Maximum of default 10 labels per metric descriptor is allowed.
 The default maximum limit can be overridden. Please follow
 https://cloud.google.com/monitoring/quotas

Protobuf type google.api.MetricDescriptor

See Also:: Serialized Form

Nested Class Summary

Nested Classes
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.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`LAUNCH_STAGE_FIELD_NUMBER`
`static int`	`METADATA_FIELD_NUMBER`
`static int`	`METRIC_KIND_FIELD_NUMBER`
`static int`	`MONITORED_RESOURCE_TYPES_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`TYPE_FIELD_NUMBER`
`static int`	`UNIT_FIELD_NUMBER`
`static int`	`VALUE_TYPE_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static MetricDescriptor`	`getDefaultInstance()`
`MetricDescriptor`	`getDefaultInstanceForType()`
`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()`
`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.
`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.
`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.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.
`String`	`getMonitoredResourceTypes(int index)` Read-only.
`com.google.protobuf.ByteString`	`getMonitoredResourceTypesBytes(int index)` Read-only.
`int`	`getMonitoredResourceTypesCount()` Read-only.
`com.google.protobuf.ProtocolStringList`	`getMonitoredResourceTypesList()` Read-only.
`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()`
`String`	`getType()` The metric type, including its DNS name prefix.
`com.google.protobuf.ByteString`	`getTypeBytes()` The metric type, including its DNS name prefix.
`String`	`getUnit()` The units in which the metric value is reported.
`com.google.protobuf.ByteString`	`getUnitBytes()` The units 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)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static MetricDescriptor`	`parseDelimitedFrom(InputStream input)`
`static MetricDescriptor`	`parseDelimitedFrom(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(ByteBuffer data)`
`static MetricDescriptor`	`parseFrom(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(InputStream input)`
`static MetricDescriptor`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<MetricDescriptor>`	`parser()`
`MetricDescriptor.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TYPE_FIELD_NUMBER
```
public static final int TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- METRIC_KIND_FIELD_NUMBER
```
public static final int METRIC_KIND_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- VALUE_TYPE_FIELD_NUMBER
```
public static final int VALUE_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UNIT_FIELD_NUMBER
```
public static final int UNIT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- METADATA_FIELD_NUMBER
```
public static final int METADATA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LAUNCH_STAGE_FIELD_NUMBER
```
public static final int LAUNCH_STAGE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MONITORED_RESOURCE_TYPES_FIELD_NUMBER
```
public static final int MONITORED_RESOURCE_TYPES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName
```
public String getName()
```
```
 The resource name of the metric descriptor.
 
```
string name = 1;
Specified by:

getName in interface MetricDescriptorOrBuilder

Returns:

The name.

getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 The resource name of the metric descriptor.
 
```
string name = 1;
Specified by:

getNameBytes in interface MetricDescriptorOrBuilder

Returns:

The bytes for name.

getType

public String getType()

 The metric type, including its DNS name prefix. The type is not
 URL-encoded.
 All service defined metrics must be prefixed with the service name, in the
 format of `{service name}/{relative metric name}`, such as
 `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric
 name must follow:
 * Only upper and lower-case letters, digits, '/' and underscores '_' are
   allowed.
 * The maximum number of characters allowed for the relative_metric_name is
   100.
 All user-defined metric types have the DNS name
 `custom.googleapis.com`, `external.googleapis.com`, or
 `logging.googleapis.com/user/`.
 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;

Specified by:: getType in interface MetricDescriptorOrBuilder
Returns:: The type.

getTypeBytes

public com.google.protobuf.ByteString getTypeBytes()

 The metric type, including its DNS name prefix. The type is not
 URL-encoded.
 All service defined metrics must be prefixed with the service name, in the
 format of `{service name}/{relative metric name}`, such as
 `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric
 name must follow:
 * Only upper and lower-case letters, digits, '/' and underscores '_' are
   allowed.
 * The maximum number of characters allowed for the relative_metric_name is
   100.
 All user-defined metric types have the DNS name
 `custom.googleapis.com`, `external.googleapis.com`, or
 `logging.googleapis.com/user/`.
 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;

Specified by:: getTypeBytes in interface MetricDescriptorOrBuilder
Returns:: The bytes for type.