Package io.opentelemetry.proto.metrics.v1

Interface SummaryDataPointOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SummaryDataPoint, SummaryDataPoint.Builder
public interface SummaryDataPointOrBuilder 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
    getCount()
    count is the number of values in the population.
    int
    getFlags()
    Flags that apply to this specific data point.
    SummaryDataPoint.ValueAtQuantile
    getQuantileValues(int index)
    (Optional) list of values at different quantiles of the distribution calculated from the current snapshot.
    int
    getQuantileValuesCount()
    (Optional) list of values at different quantiles of the distribution calculated from the current snapshot.
    List<SummaryDataPoint.ValueAtQuantile>
    getQuantileValuesList()
    (Optional) list of values at different quantiles of the distribution calculated from the current snapshot.
    SummaryDataPoint.ValueAtQuantileOrBuilder
    getQuantileValuesOrBuilder(int index)
    (Optional) list of values at different quantiles of the distribution calculated from the current snapshot.
    List<? extends SummaryDataPoint.ValueAtQuantileOrBuilder>
    getQuantileValuesOrBuilderList()
    (Optional) list of values at different quantiles of the distribution calculated from the current snapshot.
    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.

    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 = 7;

    • 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 = 7;

    • 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 = 7;

    • 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 = 7;

    • 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 = 7;

    • 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.
      fixed64 count = 4;
      Returns:
      The count.

    • 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#summary
      double sum = 5;
      Returns:
      The sum.

    • getQuantileValuesList

      List<SummaryDataPoint.ValueAtQuantile> getQuantileValuesList()
       (Optional) list of values at different quantiles of the distribution calculated
 from the current snapshot. The quantiles must be strictly increasing.
      repeated .opentelemetry.proto.metrics.v1.SummaryDataPoint.ValueAtQuantile quantile_values = 6;

    • getQuantileValues

      SummaryDataPoint.ValueAtQuantile getQuantileValues(int index)
       (Optional) list of values at different quantiles of the distribution calculated
 from the current snapshot. The quantiles must be strictly increasing.
      repeated .opentelemetry.proto.metrics.v1.SummaryDataPoint.ValueAtQuantile quantile_values = 6;

    • getQuantileValuesCount

      int getQuantileValuesCount()
       (Optional) list of values at different quantiles of the distribution calculated
 from the current snapshot. The quantiles must be strictly increasing.
      repeated .opentelemetry.proto.metrics.v1.SummaryDataPoint.ValueAtQuantile quantile_values = 6;

    • getQuantileValuesOrBuilderList

      List<? extends SummaryDataPoint.ValueAtQuantileOrBuilder> getQuantileValuesOrBuilderList()
       (Optional) list of values at different quantiles of the distribution calculated
 from the current snapshot. The quantiles must be strictly increasing.
      repeated .opentelemetry.proto.metrics.v1.SummaryDataPoint.ValueAtQuantile quantile_values = 6;

    • getQuantileValuesOrBuilder

      SummaryDataPoint.ValueAtQuantileOrBuilder getQuantileValuesOrBuilder(int index)
       (Optional) list of values at different quantiles of the distribution calculated
 from the current snapshot. The quantiles must be strictly increasing.
      repeated .opentelemetry.proto.metrics.v1.SummaryDataPoint.ValueAtQuantile quantile_values = 6;

    • getFlags

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