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

io.opentelemetry.proto.metrics.v1.ExponentialHistogramDataPointOrBuilder 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 ExponentialHistogramDataPointOrBuilder extends
    // @@protoc_insertion_point(interface_extends:opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint)
    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 = 1; */ 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 = 1; */ 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 = 1; */ 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 = 1; */ 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 = 1; */ 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 "bucket_counts"
   * values in the positive and negative Buckets plus the "zero_count" field.
   * 
* * 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(); /** *
   * scale describes the resolution of the histogram.  Boundaries are
   * located at powers of the base, where:
   *   base = (2^(2^-scale))
   * The histogram bucket identified by `index`, a signed integer,
   * contains values that are greater than (base^index) and
   * less than or equal to (base^(index+1)).
   * The positive and negative ranges of the histogram are expressed
   * separately.  Negative values are mapped by their absolute value
   * into the negative range using the same scale as the positive range.
   * scale is not restricted by the protocol, as the permissible
   * values depend on the range of the data.
   * 
* * sint32 scale = 6; * @return The scale. */ int getScale(); /** *
   * zero_count is the count of values that are either exactly zero or
   * within the region considered zero by the instrumentation at the
   * tolerated degree of precision.  This bucket stores values that
   * cannot be expressed using the standard exponential formula as
   * well as values that have been rounded to zero.
   * Implementations MAY consider the zero bucket to have probability
   * mass equal to (zero_count / count).
   * 
* * fixed64 zero_count = 7; * @return The zeroCount. */ long getZeroCount(); /** *
   * positive carries the positive range of exponential bucket counts.
   * 
* * .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets positive = 8; * @return Whether the positive field is set. */ boolean hasPositive(); /** *
   * positive carries the positive range of exponential bucket counts.
   * 
* * .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets positive = 8; * @return The positive. */ io.opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets getPositive(); /** *
   * positive carries the positive range of exponential bucket counts.
   * 
* * .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets positive = 8; */ io.opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.BucketsOrBuilder getPositiveOrBuilder(); /** *
   * negative carries the negative range of exponential bucket counts.
   * 
* * .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets negative = 9; * @return Whether the negative field is set. */ boolean hasNegative(); /** *
   * negative carries the negative range of exponential bucket counts.
   * 
* * .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets negative = 9; * @return The negative. */ io.opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets getNegative(); /** *
   * negative carries the negative range of exponential bucket counts.
   * 
* * .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets negative = 9; */ io.opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.BucketsOrBuilder getNegativeOrBuilder(); /** *
   * 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(); /** *
   * (Optional) List of exemplars collected from
   * measurements that were used to form the data point
   * 
* * repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 11; */ 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 = 11; */ 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 = 11; */ int getExemplarsCount(); /** *
   * (Optional) List of exemplars collected from
   * measurements that were used to form the data point
   * 
* * repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 11; */ 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 = 11; */ io.opentelemetry.proto.metrics.v1.ExemplarOrBuilder getExemplarsOrBuilder( int index); /** *
   * min is the minimum value over (start_time, end_time].
   * 
* * optional double min = 12; * @return Whether the min field is set. */ boolean hasMin(); /** *
   * min is the minimum value over (start_time, end_time].
   * 
* * optional double min = 12; * @return The min. */ double getMin(); /** *
   * max is the maximum value over (start_time, end_time].
   * 
* * optional double max = 13; * @return Whether the max field is set. */ boolean hasMax(); /** *
   * max is the maximum value over (start_time, end_time].
   * 
* * optional double max = 13; * @return The max. */ double getMax(); /** *
   * ZeroThreshold may be optionally set to convey the width of the zero
   * region. Where the zero region is defined as the closed interval
   * [-ZeroThreshold, ZeroThreshold].
   * When ZeroThreshold is 0, zero count bucket stores values that cannot be
   * expressed using the standard exponential formula as well as values that
   * have been rounded to zero.
   * 
* * double zero_threshold = 14; * @return The zeroThreshold. */ double getZeroThreshold(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy