All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.opentelemetry.proto.metrics.v1.HistogramDataPointOrBuilder Maven / Gradle / Ivy

There is a newer version: 1.0.46
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: opentelemetry/proto/metrics/v1/metrics.proto

package io.opentelemetry.proto.metrics.v1;

public interface HistogramDataPointOrBuilder extends
    // @@protoc_insertion_point(interface_extends:opentelemetry.proto.metrics.v1.HistogramDataPoint)
    com.google.protobuf.MessageOrBuilder {

  /**
   * 
   * 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; */ java.util.List 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; */ io.opentelemetry.proto.common.v1.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; */ 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; */ java.util.List 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; */ io.opentelemetry.proto.common.v1.KeyValueOrBuilder getAttributesOrBuilder( int index); /** *
   * 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; * @return The startTimeUnixNano. */ long getStartTimeUnixNano(); /** *
   * 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; * @return The timeUnixNano. */ long getTimeUnixNano(); /** *
   * 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; * @return The count. */ long getCount(); /** *
   * 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; * @return Whether the sum field is set. */ 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; * @return The sum. */ double getSum(); /** *
   * 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; * @return A list containing the bucketCounts. */ java.util.List 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; * @return The count of bucketCounts. */ 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; * @param index The index of the element to return. * @return The bucketCounts at the given index. */ long getBucketCounts(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; * @return A list containing the explicitBounds. */ java.util.List 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; * @return The count of explicitBounds. */ 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; * @param index The index of the element to return. * @return The explicitBounds at the given index. */ double getExplicitBounds(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; */ java.util.List getExemplarsList(); /** *
   * (Optional) List of exemplars collected from
   * measurements that were used to form the data point
   * 
* * repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 8; */ io.opentelemetry.proto.metrics.v1.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; */ 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; */ java.util.List getExemplarsOrBuilderList(); /** *
   * (Optional) List of exemplars collected from
   * measurements that were used to form the data point
   * 
* * repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 8; */ io.opentelemetry.proto.metrics.v1.ExemplarOrBuilder getExemplarsOrBuilder( int index); /** *
   * Flags that apply to this specific data point.  See DataPointFlags
   * for the available flags and their meaning.
   * 
* * uint32 flags = 10; * @return The flags. */ int getFlags(); /** *
   * min is the minimum value over (start_time, end_time].
   * 
* * optional double min = 11; * @return Whether the min field is set. */ boolean hasMin(); /** *
   * min is the minimum value over (start_time, end_time].
   * 
* * optional double min = 11; * @return The min. */ double getMin(); /** *
   * max is the maximum value over (start_time, end_time].
   * 
* * optional double max = 12; * @return Whether the max field is set. */ boolean hasMax(); /** *
   * max is the maximum value over (start_time, end_time].
   * 
* * optional double max = 12; * @return The max. */ double getMax(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy