Package io.opentelemetry.proto.metrics.v1

Class SummaryDataPoint

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.opentelemetry.proto.metrics.v1.SummaryDataPoint
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SummaryDataPointOrBuilder, Serializable
@Generated public final class SummaryDataPoint extends com.google.protobuf.GeneratedMessage implements SummaryDataPointOrBuilder
 SummaryDataPoint is a single data point in a timeseries that describes the
 time-varying values of a Summary metric. The count and sum fields represent
 cumulative values.
Protobuf type opentelemetry.proto.metrics.v1.SummaryDataPoint
See Also:

  • Field Details

    • ATTRIBUTES_FIELD_NUMBER

      public static final int ATTRIBUTES_FIELD_NUMBER
      See Also:

    • START_TIME_UNIX_NANO_FIELD_NUMBER

      public static final int START_TIME_UNIX_NANO_FIELD_NUMBER
      See Also:

    • TIME_UNIX_NANO_FIELD_NUMBER

      public static final int TIME_UNIX_NANO_FIELD_NUMBER
      See Also:

    • COUNT_FIELD_NUMBER

      public static final int COUNT_FIELD_NUMBER
      See Also:

    • SUM_FIELD_NUMBER

      public static final int SUM_FIELD_NUMBER
      See Also:

    • QUANTILE_VALUES_FIELD_NUMBER

      public static final int QUANTILE_VALUES_FIELD_NUMBER
      See Also:

    • FLAGS_FIELD_NUMBER

      public static final int FLAGS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getAttributesList

      public 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).

 The attribute values SHOULD NOT contain empty values.
 The attribute values SHOULD NOT contain bytes values.
 The attribute values SHOULD NOT contain array values different than array of string values, bool values, int values,
 double values.
 The attribute values SHOULD NOT contain kvlist values.
 The behavior of software that receives attributes containing such values can be unpredictable.
 These restrictions can change in a minor release.
 The restrictions take origin from the OpenTelemetry specification:
 https://github.com/open-telemetry/opentelemetry-specification/blob/v1.47.0/specification/common/README.md#attribute.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 7;
      Specified by:
      getAttributesList in interface SummaryDataPointOrBuilder

    • getAttributesOrBuilderList

      public 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).

 The attribute values SHOULD NOT contain empty values.
 The attribute values SHOULD NOT contain bytes values.
 The attribute values SHOULD NOT contain array values different than array of string values, bool values, int values,
 double values.
 The attribute values SHOULD NOT contain kvlist values.
 The behavior of software that receives attributes containing such values can be unpredictable.
 These restrictions can change in a minor release.
 The restrictions take origin from the OpenTelemetry specification:
 https://github.com/open-telemetry/opentelemetry-specification/blob/v1.47.0/specification/common/README.md#attribute.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 7;
      Specified by:
      getAttributesOrBuilderList in interface SummaryDataPointOrBuilder

    • getAttributesCount

      public 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).

 The attribute values SHOULD NOT contain empty values.
 The attribute values SHOULD NOT contain bytes values.
 The attribute values SHOULD NOT contain array values different than array of string values, bool values, int values,
 double values.
 The attribute values SHOULD NOT contain kvlist values.
 The behavior of software that receives attributes containing such values can be unpredictable.
 These restrictions can change in a minor release.
 The restrictions take origin from the OpenTelemetry specification:
 https://github.com/open-telemetry/opentelemetry-specification/blob/v1.47.0/specification/common/README.md#attribute.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 7;
      Specified by:
      getAttributesCount in interface SummaryDataPointOrBuilder

    • getAttributes

      public 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).

 The attribute values SHOULD NOT contain empty values.
 The attribute values SHOULD NOT contain bytes values.
 The attribute values SHOULD NOT contain array values different than array of string values, bool values, int values,
 double values.
 The attribute values SHOULD NOT contain kvlist values.
 The behavior of software that receives attributes containing such values can be unpredictable.
 These restrictions can change in a minor release.
 The restrictions take origin from the OpenTelemetry specification:
 https://github.com/open-telemetry/opentelemetry-specification/blob/v1.47.0/specification/common/README.md#attribute.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 7;
      Specified by:
      getAttributes in interface SummaryDataPointOrBuilder

    • getAttributesOrBuilder

      public 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).

 The attribute values SHOULD NOT contain empty values.
 The attribute values SHOULD NOT contain bytes values.
 The attribute values SHOULD NOT contain array values different than array of string values, bool values, int values,
 double values.
 The attribute values SHOULD NOT contain kvlist values.
 The behavior of software that receives attributes containing such values can be unpredictable.
 These restrictions can change in a minor release.
 The restrictions take origin from the OpenTelemetry specification:
 https://github.com/open-telemetry/opentelemetry-specification/blob/v1.47.0/specification/common/README.md#attribute.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 7;
      Specified by:
      getAttributesOrBuilder in interface SummaryDataPointOrBuilder

    • getStartTimeUnixNano

      public 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;
      Specified by:
      getStartTimeUnixNano in interface SummaryDataPointOrBuilder
      Returns:
      The startTimeUnixNano.

    • getTimeUnixNano

      public 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;
      Specified by:
      getTimeUnixNano in interface SummaryDataPointOrBuilder
      Returns:
      The timeUnixNano.

    • getCount

      public long getCount()
       count is the number of values in the population. Must be non-negative.
      fixed64 count = 4;
      Specified by:
      getCount in interface SummaryDataPointOrBuilder
      Returns:
      The count.

    • getSum

      public 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/prometheus/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#summary
      double sum = 5;
      Specified by:
      getSum in interface SummaryDataPointOrBuilder
      Returns:
      The sum.

    • getQuantileValuesList

      public 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;
      Specified by:
      getQuantileValuesList in interface SummaryDataPointOrBuilder

    • getQuantileValuesOrBuilderList

      public 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;
      Specified by:
      getQuantileValuesOrBuilderList in interface SummaryDataPointOrBuilder

    • getQuantileValuesCount

      public 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;
      Specified by:
      getQuantileValuesCount in interface SummaryDataPointOrBuilder

    • getQuantileValues

      public 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;
      Specified by:
      getQuantileValues in interface SummaryDataPointOrBuilder

    • getQuantileValuesOrBuilder

      public 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;
      Specified by:
      getQuantileValuesOrBuilder in interface SummaryDataPointOrBuilder

    • getFlags

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SummaryDataPoint parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SummaryDataPoint parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SummaryDataPoint parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SummaryDataPoint parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SummaryDataPoint parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SummaryDataPoint parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SummaryDataPoint parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SummaryDataPoint parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SummaryDataPoint parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SummaryDataPoint parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SummaryDataPoint parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SummaryDataPoint parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SummaryDataPoint.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SummaryDataPoint.Builder newBuilder()

    • newBuilder

      public static SummaryDataPoint.Builder newBuilder(SummaryDataPoint prototype)

    • toBuilder

      public SummaryDataPoint.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SummaryDataPoint.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SummaryDataPoint getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SummaryDataPoint> parser()

    • getParserForType

      public com.google.protobuf.Parser<SummaryDataPoint> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SummaryDataPoint getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder