Package io.opencensus.proto.metrics.v1

Interface MetricDescriptorOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    MetricDescriptor, MetricDescriptor.Builder
    public interface MetricDescriptorOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      LabelKey getLabelKeys​(int index)
      The label keys associated with the metric descriptor.
      int getLabelKeysCount()
      The label keys associated with the metric descriptor.
      List<LabelKey> getLabelKeysList()
      The label keys associated with the metric descriptor.
      LabelKeyOrBuilder getLabelKeysOrBuilder​(int index)
      The label keys associated with the metric descriptor.
      List<? extends LabelKeyOrBuilder> getLabelKeysOrBuilderList()
      The label keys associated with the metric descriptor.
      String getName()
      The metric type, including its DNS name prefix.
      com.google.protobuf.ByteString getNameBytes()
      The metric type, including its DNS name prefix.
      MetricDescriptor.Type getType()
      .opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;
      int getTypeValue()
      .opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;
      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.

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

        isInitialized

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

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

    • Method Detail

      • getName

        String getName()
         The metric type, including its DNS name prefix. It must be unique.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

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

      • getDescription

        String getDescription()
         A detailed description of the metric, which can be used in documentation.
        string description = 2;
        Returns:
        The description.

      • getDescriptionBytes

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

      • getUnit

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

      • getUnitBytes

        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;
        Returns:
        The bytes for unit.

      • getTypeValue

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

      • getType

        MetricDescriptor.Type getType()
        .opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;
        Returns:
        The type.

      • getLabelKeysList

        List<LabelKey> getLabelKeysList()
         The label keys associated with the metric descriptor.
        repeated .opencensus.proto.metrics.v1.LabelKey label_keys = 5;

      • getLabelKeys

        LabelKey getLabelKeys​(int index)
         The label keys associated with the metric descriptor.
        repeated .opencensus.proto.metrics.v1.LabelKey label_keys = 5;

      • getLabelKeysCount

        int getLabelKeysCount()
         The label keys associated with the metric descriptor.
        repeated .opencensus.proto.metrics.v1.LabelKey label_keys = 5;

      • getLabelKeysOrBuilderList

        List<? extends LabelKeyOrBuilder> getLabelKeysOrBuilderList()
         The label keys associated with the metric descriptor.
        repeated .opencensus.proto.metrics.v1.LabelKey label_keys = 5;

      • getLabelKeysOrBuilder

        LabelKeyOrBuilder getLabelKeysOrBuilder​(int index)
         The label keys associated with the metric descriptor.
        repeated .opencensus.proto.metrics.v1.LabelKey label_keys = 5;