Package io.opentelemetry.proto.metrics.v1

Interface MetricOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Metric, Metric.Builder
public interface MetricOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       name of the metric.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       name of the metric.
      string name = 1;
      Returns:
      The bytes for name.

    • getDescription

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

    • getDescriptionBytes

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

    • getUnit

      String getUnit()
       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()
       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.

    • hasGauge

      boolean hasGauge()
      .opentelemetry.proto.metrics.v1.Gauge gauge = 5;
      Returns:
      Whether the gauge field is set.

    • getGauge

      Gauge getGauge()
      .opentelemetry.proto.metrics.v1.Gauge gauge = 5;
      Returns:
      The gauge.

    • getGaugeOrBuilder

      GaugeOrBuilder getGaugeOrBuilder()
      .opentelemetry.proto.metrics.v1.Gauge gauge = 5;

    • hasSum

      boolean hasSum()
      .opentelemetry.proto.metrics.v1.Sum sum = 7;
      Returns:
      Whether the sum field is set.

    • getSum

      Sum getSum()
      .opentelemetry.proto.metrics.v1.Sum sum = 7;
      Returns:
      The sum.

    • getSumOrBuilder

      SumOrBuilder getSumOrBuilder()
      .opentelemetry.proto.metrics.v1.Sum sum = 7;

    • hasHistogram

      boolean hasHistogram()
      .opentelemetry.proto.metrics.v1.Histogram histogram = 9;
      Returns:
      Whether the histogram field is set.

    • getHistogram

      Histogram getHistogram()
      .opentelemetry.proto.metrics.v1.Histogram histogram = 9;
      Returns:
      The histogram.

    • getHistogramOrBuilder

      HistogramOrBuilder getHistogramOrBuilder()
      .opentelemetry.proto.metrics.v1.Histogram histogram = 9;

    • hasExponentialHistogram

      boolean hasExponentialHistogram()
      .opentelemetry.proto.metrics.v1.ExponentialHistogram exponential_histogram = 10;
      Returns:
      Whether the exponentialHistogram field is set.

    • getExponentialHistogram

      ExponentialHistogram getExponentialHistogram()
      .opentelemetry.proto.metrics.v1.ExponentialHistogram exponential_histogram = 10;
      Returns:
      The exponentialHistogram.

    • getExponentialHistogramOrBuilder

      ExponentialHistogramOrBuilder getExponentialHistogramOrBuilder()
      .opentelemetry.proto.metrics.v1.ExponentialHistogram exponential_histogram = 10;

    • hasSummary

      boolean hasSummary()
      .opentelemetry.proto.metrics.v1.Summary summary = 11;
      Returns:
      Whether the summary field is set.

    • getSummary

      Summary getSummary()
      .opentelemetry.proto.metrics.v1.Summary summary = 11;
      Returns:
      The summary.

    • getSummaryOrBuilder

      SummaryOrBuilder getSummaryOrBuilder()
      .opentelemetry.proto.metrics.v1.Summary summary = 11;

    • getMetadataList

      List<KeyValue> getMetadataList()
       Additional metadata attributes that describe the metric. [Optional].
 Attributes are non-identifying.
 Consumers SHOULD NOT need to be aware of these attributes.
 These attributes MAY be used to encode information allowing
 for lossless roundtrip translation to / from another data model.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
      repeated .opentelemetry.proto.common.v1.KeyValue metadata = 12;

    • getMetadata

      KeyValue getMetadata(int index)
       Additional metadata attributes that describe the metric. [Optional].
 Attributes are non-identifying.
 Consumers SHOULD NOT need to be aware of these attributes.
 These attributes MAY be used to encode information allowing
 for lossless roundtrip translation to / from another data model.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
      repeated .opentelemetry.proto.common.v1.KeyValue metadata = 12;

    • getMetadataCount

      int getMetadataCount()
       Additional metadata attributes that describe the metric. [Optional].
 Attributes are non-identifying.
 Consumers SHOULD NOT need to be aware of these attributes.
 These attributes MAY be used to encode information allowing
 for lossless roundtrip translation to / from another data model.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
      repeated .opentelemetry.proto.common.v1.KeyValue metadata = 12;

    • getMetadataOrBuilderList

      List<? extends KeyValueOrBuilder> getMetadataOrBuilderList()
       Additional metadata attributes that describe the metric. [Optional].
 Attributes are non-identifying.
 Consumers SHOULD NOT need to be aware of these attributes.
 These attributes MAY be used to encode information allowing
 for lossless roundtrip translation to / from another data model.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
      repeated .opentelemetry.proto.common.v1.KeyValue metadata = 12;

    • getMetadataOrBuilder

      KeyValueOrBuilder getMetadataOrBuilder(int index)
       Additional metadata attributes that describe the metric. [Optional].
 Attributes are non-identifying.
 Consumers SHOULD NOT need to be aware of these attributes.
 These attributes MAY be used to encode information allowing
 for lossless roundtrip translation to / from another data model.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
      repeated .opentelemetry.proto.common.v1.KeyValue metadata = 12;

    • getDataCase

      Metric.DataCase getDataCase()