Package io.opencensus.proto.metrics.v1

Class MetricDescriptor

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MetricDescriptorOrBuilder, java.io.Serializable
    public final class MetricDescriptor
extends com.google.protobuf.GeneratedMessageV3
implements MetricDescriptorOrBuilder
     Defines a metric type and its schema.
    Protobuf type opencensus.proto.metrics.v1.MetricDescriptor
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MetricDescriptor.Builder
      Defines a metric type and its schema.
      static class  MetricDescriptor.Type
      The kind of 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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()  
      LabelKey getLabelKeys​(int index)
      The label keys associated with the metric descriptor.
      int getLabelKeysCount()
      The label keys associated with the metric descriptor.
      java.util.List<LabelKey> getLabelKeysList()
      The label keys associated with the metric descriptor.
      LabelKeyOrBuilder getLabelKeysOrBuilder​(int index)
      The label keys associated with the metric descriptor.
      java.util.List<? extends LabelKeyOrBuilder> getLabelKeysOrBuilderList()
      The label keys associated with the metric descriptor.
      java.lang.String getName()
      The metric type, including its DNS name prefix.
      com.google.protobuf.ByteString getNameBytes()
      The metric type, including its DNS name prefix.
      com.google.protobuf.Parser<MetricDescriptor> getParserForType()  
      int getSerializedSize()  
      MetricDescriptor.Type getType()
      .opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;
      int getTypeValue()
      .opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;
      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()  
      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)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      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 MetricDescriptor parseFrom​(java.nio.ByteBuffer data)  
      static MetricDescriptor parseFrom​(java.nio.ByteBuffer data, 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, isStringEmpty, 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.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

    • Method Detail

      • newInstance

        protected java.lang.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 java.lang.String getName()
         The metric type, including its DNS name prefix. It must be unique.
        string name = 1;
        Specified by:
        getName in interface MetricDescriptorOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The metric type, including its DNS name prefix. It must be unique.
        string name = 1;
        Specified by:
        getNameBytes in interface MetricDescriptorOrBuilder
        Returns:
        The bytes for name.

      • getDescription

        public java.lang.String getDescription()
         A detailed description of the metric, which can be used in documentation.
        string description = 2;
        Specified by:
        getDescription in interface MetricDescriptorOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         A detailed description of the metric, which can be used in documentation.
        string description = 2;
        Specified by:
        getDescriptionBytes in interface MetricDescriptorOrBuilder
        Returns:
        The bytes for description.

      • getUnit

        public java.lang.String getUnit()
         The unit in which the metric value is reported. Follows the format
 described by http://unitsofmeasure.org/ucum.html.
        string unit = 3;
        Specified by:
        getUnit in interface MetricDescriptorOrBuilder
        Returns:
        The unit.

      • getUnitBytes

        public com.google.protobuf.ByteString getUnitBytes()
         The unit in which the metric value is reported. Follows the format
 described by http://unitsofmeasure.org/ucum.html.
        string unit = 3;
        Specified by:
        getUnitBytes in interface MetricDescriptorOrBuilder
        Returns:
        The bytes for unit.

      • getTypeValue

        public int getTypeValue()
        .opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;
        Specified by:
        getTypeValue in interface MetricDescriptorOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • getLabelKeysList

        public java.util.List<LabelKey> getLabelKeysList()
         The label keys associated with the metric descriptor.
        repeated .opencensus.proto.metrics.v1.LabelKey label_keys = 5;
        Specified by:
        getLabelKeysList in interface MetricDescriptorOrBuilder

      • getLabelKeysCount

        public int getLabelKeysCount()
         The label keys associated with the metric descriptor.
        repeated .opencensus.proto.metrics.v1.LabelKey label_keys = 5;
        Specified by:
        getLabelKeysCount in interface MetricDescriptorOrBuilder

      • getLabelKeys

        public LabelKey getLabelKeys​(int index)
         The label keys associated with the metric descriptor.
        repeated .opencensus.proto.metrics.v1.LabelKey label_keys = 5;
        Specified by:
        getLabelKeys in interface MetricDescriptorOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static MetricDescriptor parseFrom​(java.nio.ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetricDescriptor parseFrom​(java.nio.ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetricDescriptor parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetricDescriptor parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetricDescriptor parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetricDescriptor parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetricDescriptor parseFrom​(java.io.InputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static MetricDescriptor parseFrom​(java.io.InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static MetricDescriptor parseDelimitedFrom​(java.io.InputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static MetricDescriptor parseDelimitedFrom​(java.io.InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static MetricDescriptor parseFrom​(com.google.protobuf.CodedInputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static MetricDescriptor parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public MetricDescriptor.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public MetricDescriptor.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected MetricDescriptor.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<MetricDescriptor> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public MetricDescriptor getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder