Package io.opentelemetry.proto.metrics.v1

Interface HistogramDataPointOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    KeyValue
    getAttributes(int index)
    The set of key/value pairs that uniquely identify the timeseries from where this point belongs.
    int
    getAttributesCount()
    The set of key/value pairs that uniquely identify the timeseries from where this point belongs.
    List<KeyValue>
    getAttributesList()
    The set of key/value pairs that uniquely identify the timeseries from where this point belongs.
    KeyValueOrBuilder
    getAttributesOrBuilder(int index)
    The set of key/value pairs that uniquely identify the timeseries from where this point belongs.
    List<? extends KeyValueOrBuilder>
    getAttributesOrBuilderList()
    The set of key/value pairs that uniquely identify the timeseries from where this point belongs.
    long
    getBucketCounts(int index)
    bucket_counts is an optional field contains the count values of histogram for each bucket.
    int
    getBucketCountsCount()
    bucket_counts is an optional field contains the count values of histogram for each bucket.
    List<Long>
    getBucketCountsList()
    bucket_counts is an optional field contains the count values of histogram for each bucket.
    long
    getCount()
    count is the number of values in the population.
    Exemplar
    getExemplars(int index)
    (Optional) List of exemplars collected from measurements that were used to form the data point
    int
    getExemplarsCount()
    (Optional) List of exemplars collected from measurements that were used to form the data point
    List<Exemplar>
    getExemplarsList()
    (Optional) List of exemplars collected from measurements that were used to form the data point
    ExemplarOrBuilder
    getExemplarsOrBuilder(int index)
    (Optional) List of exemplars collected from measurements that were used to form the data point
    List<? extends ExemplarOrBuilder>
    getExemplarsOrBuilderList()
    (Optional) List of exemplars collected from measurements that were used to form the data point
    double
    getExplicitBounds(int index)
    explicit_bounds specifies buckets with explicitly defined bounds for values.
    int
    getExplicitBoundsCount()
    explicit_bounds specifies buckets with explicitly defined bounds for values.
    List<Double>
    getExplicitBoundsList()
    explicit_bounds specifies buckets with explicitly defined bounds for values.
    int
    getFlags()
    Flags that apply to this specific data point.
    double
    getMax()
    max is the maximum value over (start_time, end_time].
    double
    getMin()
    min is the minimum value over (start_time, end_time].
    long
    getStartTimeUnixNano()
    StartTimeUnixNano is optional but strongly encouraged, see the the detailed comments above Metric.
    double
    getSum()
    sum of the values in the population.
    long
    getTimeUnixNano()
    TimeUnixNano is required, see the detailed comments above Metric.
    boolean
    hasMax()
    max is the maximum value over (start_time, end_time].
    boolean
    hasMin()
    min is the minimum value over (start_time, end_time].
    boolean
    hasSum()
    sum of the values in the population.

    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 Details

    • getAttributesList

      List<KeyValue> getAttributesList()
       The set of key/value pairs that uniquely identify the timeseries from
 where this point belongs. The list may be empty (may contain 0 elements).
 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 attributes = 9;

    • getAttributes

      KeyValue getAttributes(int index)
       The set of key/value pairs that uniquely identify the timeseries from
 where this point belongs. The list may be empty (may contain 0 elements).
 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 attributes = 9;

    • getAttributesCount

      int getAttributesCount()
       The set of key/value pairs that uniquely identify the timeseries from
 where this point belongs. The list may be empty (may contain 0 elements).
 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 attributes = 9;

    • getAttributesOrBuilderList

      List<? extends KeyValueOrBuilder> getAttributesOrBuilderList()
       The set of key/value pairs that uniquely identify the timeseries from
 where this point belongs. The list may be empty (may contain 0 elements).
 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 attributes = 9;

    • getAttributesOrBuilder

      KeyValueOrBuilder getAttributesOrBuilder(int index)
       The set of key/value pairs that uniquely identify the timeseries from
 where this point belongs. The list may be empty (may contain 0 elements).
 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 attributes = 9;

    • getStartTimeUnixNano

      long getStartTimeUnixNano()
       StartTimeUnixNano is optional but strongly encouraged, see the
 the detailed comments above Metric.

 Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
 1970.
      fixed64 start_time_unix_nano = 2;
      Returns:
      The startTimeUnixNano.

    • getTimeUnixNano

      long getTimeUnixNano()
       TimeUnixNano is required, see the detailed comments above Metric.

 Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
 1970.
      fixed64 time_unix_nano = 3;
      Returns:
      The timeUnixNano.

    • getCount

      long getCount()
       count is the number of values in the population. Must be non-negative. This
 value must be equal to the sum of the "count" fields in buckets if a
 histogram is provided.
      fixed64 count = 4;
      Returns:
      The count.

    • hasSum

      boolean hasSum()
       sum of the values in the population. If count is zero then this field
 must be zero.

 Note: Sum should only be filled out when measuring non-negative discrete
 events, and is assumed to be monotonic over the values of these events.
 Negative events *can* be recorded, but sum should not be filled out when
 doing so.  This is specifically to enforce compatibility w/ OpenMetrics,
 see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#histogram
      optional double sum = 5;
      Returns:
      Whether the sum field is set.

    • getSum

      double getSum()
       sum of the values in the population. If count is zero then this field
 must be zero.

 Note: Sum should only be filled out when measuring non-negative discrete
 events, and is assumed to be monotonic over the values of these events.
 Negative events *can* be recorded, but sum should not be filled out when
 doing so.  This is specifically to enforce compatibility w/ OpenMetrics,
 see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#histogram
      optional double sum = 5;
      Returns:
      The sum.

    • getBucketCountsList

      List<Long> getBucketCountsList()
       bucket_counts is an optional field contains the count values of histogram
 for each bucket.

 The sum of the bucket_counts must equal the value in the count field.

 The number of elements in bucket_counts array must be by one greater than
 the number of elements in explicit_bounds array.
      repeated fixed64 bucket_counts = 6;
      Returns:
      A list containing the bucketCounts.

    • getBucketCountsCount

      int getBucketCountsCount()
       bucket_counts is an optional field contains the count values of histogram
 for each bucket.

 The sum of the bucket_counts must equal the value in the count field.

 The number of elements in bucket_counts array must be by one greater than
 the number of elements in explicit_bounds array.
      repeated fixed64 bucket_counts = 6;
      Returns:
      The count of bucketCounts.

    • getBucketCounts

      long getBucketCounts(int index)
       bucket_counts is an optional field contains the count values of histogram
 for each bucket.

 The sum of the bucket_counts must equal the value in the count field.

 The number of elements in bucket_counts array must be by one greater than
 the number of elements in explicit_bounds array.
      repeated fixed64 bucket_counts = 6;
      Parameters:
      index - The index of the element to return.
      Returns:
      The bucketCounts at the given index.

    • getExplicitBoundsList

      List<Double> getExplicitBoundsList()
       explicit_bounds specifies buckets with explicitly defined bounds for values.

 The boundaries for bucket at index i are:

 (-infinity, explicit_bounds[i]] for i == 0
 (explicit_bounds[i-1], explicit_bounds[i]] for 0 < i < size(explicit_bounds)
 (explicit_bounds[i-1], +infinity) for i == size(explicit_bounds)

 The values in the explicit_bounds array must be strictly increasing.

 Histogram buckets are inclusive of their upper boundary, except the last
 bucket where the boundary is at infinity. This format is intentionally
 compatible with the OpenMetrics histogram definition.
      repeated double explicit_bounds = 7;
      Returns:
      A list containing the explicitBounds.

    • getExplicitBoundsCount

      int getExplicitBoundsCount()
       explicit_bounds specifies buckets with explicitly defined bounds for values.

 The boundaries for bucket at index i are:

 (-infinity, explicit_bounds[i]] for i == 0
 (explicit_bounds[i-1], explicit_bounds[i]] for 0 < i < size(explicit_bounds)
 (explicit_bounds[i-1], +infinity) for i == size(explicit_bounds)

 The values in the explicit_bounds array must be strictly increasing.

 Histogram buckets are inclusive of their upper boundary, except the last
 bucket where the boundary is at infinity. This format is intentionally
 compatible with the OpenMetrics histogram definition.
      repeated double explicit_bounds = 7;
      Returns:
      The count of explicitBounds.

    • getExplicitBounds

      double getExplicitBounds(int index)
       explicit_bounds specifies buckets with explicitly defined bounds for values.

 The boundaries for bucket at index i are:

 (-infinity, explicit_bounds[i]] for i == 0
 (explicit_bounds[i-1], explicit_bounds[i]] for 0 < i < size(explicit_bounds)
 (explicit_bounds[i-1], +infinity) for i == size(explicit_bounds)

 The values in the explicit_bounds array must be strictly increasing.

 Histogram buckets are inclusive of their upper boundary, except the last
 bucket where the boundary is at infinity. This format is intentionally
 compatible with the OpenMetrics histogram definition.
      repeated double explicit_bounds = 7;
      Parameters:
      index - The index of the element to return.
      Returns:
      The explicitBounds at the given index.

    • getExemplarsList

      List<Exemplar> getExemplarsList()
       (Optional) List of exemplars collected from
 measurements that were used to form the data point
      repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 8;

    • getExemplars

      Exemplar getExemplars(int index)
       (Optional) List of exemplars collected from
 measurements that were used to form the data point
      repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 8;

    • getExemplarsCount

      int getExemplarsCount()
       (Optional) List of exemplars collected from
 measurements that were used to form the data point
      repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 8;

    • getExemplarsOrBuilderList

      List<? extends ExemplarOrBuilder> getExemplarsOrBuilderList()
       (Optional) List of exemplars collected from
 measurements that were used to form the data point
      repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 8;

    • getExemplarsOrBuilder

      ExemplarOrBuilder getExemplarsOrBuilder(int index)
       (Optional) List of exemplars collected from
 measurements that were used to form the data point
      repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 8;

    • getFlags

      int getFlags()
       Flags that apply to this specific data point.  See DataPointFlags
 for the available flags and their meaning.
      uint32 flags = 10;
      Returns:
      The flags.

    • hasMin

      boolean hasMin()
       min is the minimum value over (start_time, end_time].
      optional double min = 11;
      Returns:
      Whether the min field is set.

    • getMin

      double getMin()
       min is the minimum value over (start_time, end_time].
      optional double min = 11;
      Returns:
      The min.

    • hasMax

      boolean hasMax()
       max is the maximum value over (start_time, end_time].
      optional double max = 12;
      Returns:
      Whether the max field is set.

    • getMax

      double getMax()
       max is the maximum value over (start_time, end_time].
      optional double max = 12;
      Returns:
      The max.