Package io.opentelemetry.proto.metrics.v1

Class SummaryDataPoint.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SummaryDataPointOrBuilder, java.lang.Cloneable
    Enclosing class:
    SummaryDataPoint
    public static final class SummaryDataPoint.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SummaryDataPoint.Builder>
implements SummaryDataPointOrBuilder
     SummaryDataPoint is a single data point in a timeseries that describes the
 time-varying values of a Summary metric.
    Protobuf type opentelemetry.proto.metrics.v1.SummaryDataPoint

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryDataPoint.Builder>

      • clear

        public SummaryDataPoint.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryDataPoint.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryDataPoint.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • mergeFrom

        public SummaryDataPoint.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SummaryDataPoint.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryDataPoint.Builder>

      • mergeFrom

        public SummaryDataPoint.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SummaryDataPoint.Builder>
        Throws:
        java.io.IOException

      • getAttributesList

        public java.util.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;
        Specified by:
        getAttributesList 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).
        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).
        repeated .opentelemetry.proto.common.v1.KeyValue attributes = 7;
        Specified by:
        getAttributes in interface SummaryDataPointOrBuilder

      • setAttributes

        public SummaryDataPoint.Builder setAttributes​(int index,
                                              KeyValue value)
         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;

      • setAttributes

        public SummaryDataPoint.Builder setAttributes​(int index,
                                              KeyValue.Builder builderForValue)
         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;

      • addAttributes

        public SummaryDataPoint.Builder addAttributes​(KeyValue value)
         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;

      • addAttributes

        public SummaryDataPoint.Builder addAttributes​(int index,
                                              KeyValue value)
         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;

      • addAttributes

        public SummaryDataPoint.Builder addAttributes​(KeyValue.Builder builderForValue)
         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;

      • addAttributes

        public SummaryDataPoint.Builder addAttributes​(int index,
                                              KeyValue.Builder builderForValue)
         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;

      • addAllAttributes

        public SummaryDataPoint.Builder addAllAttributes​(java.lang.Iterable<? extends KeyValue> values)
         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;

      • clearAttributes

        public SummaryDataPoint.Builder clearAttributes()
         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;

      • removeAttributes

        public SummaryDataPoint.Builder removeAttributes​(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;

      • getAttributesBuilder

        public KeyValue.Builder getAttributesBuilder​(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;

      • 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).
        repeated .opentelemetry.proto.common.v1.KeyValue attributes = 7;
        Specified by:
        getAttributesOrBuilder in interface SummaryDataPointOrBuilder

      • getAttributesOrBuilderList

        public java.util.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;
        Specified by:
        getAttributesOrBuilderList in interface SummaryDataPointOrBuilder

      • addAttributesBuilder

        public KeyValue.Builder addAttributesBuilder()
         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;

      • addAttributesBuilder

        public KeyValue.Builder addAttributesBuilder​(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;

      • getAttributesBuilderList

        public java.util.List<KeyValue.Builder> getAttributesBuilderList()
         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

        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.

      • setStartTimeUnixNano

        public SummaryDataPoint.Builder setStartTimeUnixNano​(long value)
         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;
        Parameters:
        value - The startTimeUnixNano to set.
        Returns:
        This builder for chaining.

      • clearStartTimeUnixNano

        public SummaryDataPoint.Builder clearStartTimeUnixNano()
         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:
        This builder for chaining.

      • 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.

      • setTimeUnixNano

        public SummaryDataPoint.Builder setTimeUnixNano​(long value)
         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;
        Parameters:
        value - The timeUnixNano to set.
        Returns:
        This builder for chaining.

      • clearTimeUnixNano

        public SummaryDataPoint.Builder clearTimeUnixNano()
         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:
        This builder for chaining.

      • 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.

      • setCount

        public SummaryDataPoint.Builder setCount​(long value)
         count is the number of values in the population. Must be non-negative.
        fixed64 count = 4;
        Parameters:
        value - The count to set.
        Returns:
        This builder for chaining.

      • clearCount

        public SummaryDataPoint.Builder clearCount()
         count is the number of values in the population. Must be non-negative.
        fixed64 count = 4;
        Returns:
        This builder for chaining.

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

      • setSum

        public SummaryDataPoint.Builder setSum​(double value)
         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;
        Parameters:
        value - The sum to set.
        Returns:
        This builder for chaining.

      • clearSum

        public SummaryDataPoint.Builder clearSum()
         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:
        This builder for chaining.

      • getQuantileValuesList

        public java.util.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

      • 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

      • setQuantileValues

        public SummaryDataPoint.Builder setQuantileValues​(int index,
                                                  SummaryDataPoint.ValueAtQuantile value)
         (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;

      • setQuantileValues

        public SummaryDataPoint.Builder setQuantileValues​(int index,
                                                  SummaryDataPoint.ValueAtQuantile.Builder builderForValue)
         (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;

      • addQuantileValues

        public SummaryDataPoint.Builder addQuantileValues​(SummaryDataPoint.ValueAtQuantile value)
         (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;

      • addQuantileValues

        public SummaryDataPoint.Builder addQuantileValues​(int index,
                                                  SummaryDataPoint.ValueAtQuantile value)
         (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;

      • addQuantileValues

        public SummaryDataPoint.Builder addQuantileValues​(SummaryDataPoint.ValueAtQuantile.Builder builderForValue)
         (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;

      • addQuantileValues

        public SummaryDataPoint.Builder addQuantileValues​(int index,
                                                  SummaryDataPoint.ValueAtQuantile.Builder builderForValue)
         (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;

      • addAllQuantileValues

        public SummaryDataPoint.Builder addAllQuantileValues​(java.lang.Iterable<? extends SummaryDataPoint.ValueAtQuantile> values)
         (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;

      • clearQuantileValues

        public SummaryDataPoint.Builder clearQuantileValues()
         (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;

      • removeQuantileValues

        public SummaryDataPoint.Builder removeQuantileValues​(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;

      • getQuantileValuesBuilder

        public SummaryDataPoint.ValueAtQuantile.Builder getQuantileValuesBuilder​(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;

      • addQuantileValuesBuilder

        public SummaryDataPoint.ValueAtQuantile.Builder addQuantileValuesBuilder()
         (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;

      • addQuantileValuesBuilder

        public SummaryDataPoint.ValueAtQuantile.Builder addQuantileValuesBuilder​(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;

      • getQuantileValuesBuilderList

        public java.util.List<SummaryDataPoint.ValueAtQuantile.Builder> getQuantileValuesBuilderList()
         (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

        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.

      • setFlags

        public SummaryDataPoint.Builder setFlags​(int value)
         Flags that apply to this specific data point.  See DataPointFlags
 for the available flags and their meaning.
        uint32 flags = 8;
        Parameters:
        value - The flags to set.
        Returns:
        This builder for chaining.

      • clearFlags

        public SummaryDataPoint.Builder clearFlags()
         Flags that apply to this specific data point.  See DataPointFlags
 for the available flags and their meaning.
        uint32 flags = 8;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final SummaryDataPoint.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryDataPoint.Builder>

      • mergeUnknownFields

        public final SummaryDataPoint.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryDataPoint.Builder>