MetricDescriptor (grpc-google-common-protos 0.1.0 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, java.io.Serializable
```
public final class MetricDescriptor
extends com.google.protobuf.GeneratedMessageV3
implements MetricDescriptorOrBuilder
```
```
 Defines a metric type and its schema.
 
```
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.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

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`	`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`

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(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.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()` Resource name.
`com.google.protobuf.ByteString`	`getNameBytes()` Resource name.
`com.google.protobuf.Parser<MetricDescriptor>`	`getParserForType()`
`int`	`getSerializedSize()`
`java.lang.String`	`getType()` The metric type including a DNS name prefix, for example `"compute.googleapis.com/instance/cpu/utilization"`.
`com.google.protobuf.ByteString`	`getTypeBytes()` The metric type including a DNS name prefix, for example `"compute.googleapis.com/instance/cpu/utilization"`.
`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()`
`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(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)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, 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, 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

Method Detail

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 java.lang.String getName()

 Resource name. The format of the name may vary between different
 implementations. For examples:
     projects/{project_id}/metricDescriptors/{type=**}
     metricDescriptors/{type=**}

optional string name = 1;

Specified by:: getName in interface MetricDescriptorOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Resource name. The format of the name may vary between different
 implementations. For examples:
     projects/{project_id}/metricDescriptors/{type=**}
     metricDescriptors/{type=**}

optional string name = 1;

Specified by:: getNameBytes in interface MetricDescriptorOrBuilder

getType

public java.lang.String getType()

 The metric type including a DNS name prefix, for example
 `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
 should use a natural hierarchical grouping such as the following:
     compute.googleapis.com/instance/cpu/utilization
     compute.googleapis.com/instance/disk/read_ops_count
     compute.googleapis.com/instance/network/received_bytes_count
 Note that if the metric type changes, the monitoring data will be
 discontinued, and anything depends on it will break, such as monitoring
 dashboards, alerting rules and quota limits. Therefore, once a metric has
 been published, its type should be immutable.

optional string type = 8;

Specified by:: getType in interface MetricDescriptorOrBuilder

getTypeBytes

public com.google.protobuf.ByteString getTypeBytes()

 The metric type including a DNS name prefix, for example
 `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
 should use a natural hierarchical grouping such as the following:
     compute.googleapis.com/instance/cpu/utilization
     compute.googleapis.com/instance/disk/read_ops_count
     compute.googleapis.com/instance/network/received_bytes_count
 Note that if the metric type changes, the monitoring data will be
 discontinued, and anything depends on it will break, such as monitoring
 dashboards, alerting rules and quota limits. Therefore, once a metric has
 been published, its type should be immutable.

optional string type = 8;

Specified by:: getTypeBytes in interface MetricDescriptorOrBuilder