Module io.prometheus.metrics.expositionformats
Package io.prometheus.metrics.expositionformats.generated.com_google_protobuf_4_31_1

Interface Metrics.HistogramOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Metrics.Histogram, Metrics.Histogram.Builder
Enclosing class:
Metrics
public static interface Metrics.HistogramOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasSampleCount

      boolean hasSampleCount()
      optional uint64 sample_count = 1;
      Returns:
      Whether the sampleCount field is set.

    • getSampleCount

      long getSampleCount()
      optional uint64 sample_count = 1;
      Returns:
      The sampleCount.

    • hasSampleCountFloat

      boolean hasSampleCountFloat()
       Overrides sample_count if > 0.
      optional double sample_count_float = 4;
      Returns:
      Whether the sampleCountFloat field is set.

    • getSampleCountFloat

      double getSampleCountFloat()
       Overrides sample_count if > 0.
      optional double sample_count_float = 4;
      Returns:
      The sampleCountFloat.

    • hasSampleSum

      boolean hasSampleSum()
      optional double sample_sum = 2;
      Returns:
      Whether the sampleSum field is set.

    • getSampleSum

      double getSampleSum()
      optional double sample_sum = 2;
      Returns:
      The sampleSum.

    • getBucketList

      List<Metrics.Bucket> getBucketList()
       Buckets for the conventional histogram.
      repeated .io.prometheus.client.Bucket bucket = 3;

    • getBucket

      Metrics.Bucket getBucket(int index)
       Buckets for the conventional histogram.
      repeated .io.prometheus.client.Bucket bucket = 3;

    • getBucketCount

      int getBucketCount()
       Buckets for the conventional histogram.
      repeated .io.prometheus.client.Bucket bucket = 3;

    • getBucketOrBuilderList

      List<? extends Metrics.BucketOrBuilder> getBucketOrBuilderList()
       Buckets for the conventional histogram.
      repeated .io.prometheus.client.Bucket bucket = 3;

    • getBucketOrBuilder

      Metrics.BucketOrBuilder getBucketOrBuilder(int index)
       Buckets for the conventional histogram.
      repeated .io.prometheus.client.Bucket bucket = 3;

    • hasCreatedTimestamp

      boolean hasCreatedTimestamp()
      optional .google.protobuf.Timestamp created_timestamp = 15;
      Returns:
      Whether the createdTimestamp field is set.

    • getCreatedTimestamp

      com.google.protobuf.Timestamp getCreatedTimestamp()
      optional .google.protobuf.Timestamp created_timestamp = 15;
      Returns:
      The createdTimestamp.

    • getCreatedTimestampOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreatedTimestampOrBuilder()
      optional .google.protobuf.Timestamp created_timestamp = 15;

    • hasSchema

      boolean hasSchema()
       schema defines the bucket schema. Currently, valid numbers are -4 <= n <= 8.
 They are all for base-2 bucket schemas, where 1 is a bucket boundary in each case, and
 then each power of two is divided into 2^n logarithmic buckets.
 Or in other words, each bucket boundary is the previous boundary times 2^(2^-n).
 In the future, more bucket schemas may be added using numbers < -4 or > 8.
      optional sint32 schema = 5;
      Returns:
      Whether the schema field is set.

    • getSchema

      int getSchema()
       schema defines the bucket schema. Currently, valid numbers are -4 <= n <= 8.
 They are all for base-2 bucket schemas, where 1 is a bucket boundary in each case, and
 then each power of two is divided into 2^n logarithmic buckets.
 Or in other words, each bucket boundary is the previous boundary times 2^(2^-n).
 In the future, more bucket schemas may be added using numbers < -4 or > 8.
      optional sint32 schema = 5;
      Returns:
      The schema.

    • hasZeroThreshold

      boolean hasZeroThreshold()
       Breadth of the zero bucket.
      optional double zero_threshold = 6;
      Returns:
      Whether the zeroThreshold field is set.

    • getZeroThreshold

      double getZeroThreshold()
       Breadth of the zero bucket.
      optional double zero_threshold = 6;
      Returns:
      The zeroThreshold.

    • hasZeroCount

      boolean hasZeroCount()
       Count in zero bucket.
      optional uint64 zero_count = 7;
      Returns:
      Whether the zeroCount field is set.

    • getZeroCount

      long getZeroCount()
       Count in zero bucket.
      optional uint64 zero_count = 7;
      Returns:
      The zeroCount.

    • hasZeroCountFloat

      boolean hasZeroCountFloat()
       Overrides sb_zero_count if > 0.
      optional double zero_count_float = 8;
      Returns:
      Whether the zeroCountFloat field is set.

    • getZeroCountFloat

      double getZeroCountFloat()
       Overrides sb_zero_count if > 0.
      optional double zero_count_float = 8;
      Returns:
      The zeroCountFloat.

    • getNegativeSpanList

      List<Metrics.BucketSpan> getNegativeSpanList()
       Negative buckets for the native histogram.
      repeated .io.prometheus.client.BucketSpan negative_span = 9;

    • getNegativeSpan

      Metrics.BucketSpan getNegativeSpan(int index)
       Negative buckets for the native histogram.
      repeated .io.prometheus.client.BucketSpan negative_span = 9;

    • getNegativeSpanCount

      int getNegativeSpanCount()
       Negative buckets for the native histogram.
      repeated .io.prometheus.client.BucketSpan negative_span = 9;

    • getNegativeSpanOrBuilderList

      List<? extends Metrics.BucketSpanOrBuilder> getNegativeSpanOrBuilderList()
       Negative buckets for the native histogram.
      repeated .io.prometheus.client.BucketSpan negative_span = 9;

    • getNegativeSpanOrBuilder

      Metrics.BucketSpanOrBuilder getNegativeSpanOrBuilder(int index)
       Negative buckets for the native histogram.
      repeated .io.prometheus.client.BucketSpan negative_span = 9;

    • getNegativeDeltaList

      List<Long> getNegativeDeltaList()
       Use either "negative_delta" or "negative_count", the former for
 regular histograms with integer counts, the latter for float
 histograms.
      repeated sint64 negative_delta = 10;
      Returns:
      A list containing the negativeDelta.

    • getNegativeDeltaCount

      int getNegativeDeltaCount()
       Use either "negative_delta" or "negative_count", the former for
 regular histograms with integer counts, the latter for float
 histograms.
      repeated sint64 negative_delta = 10;
      Returns:
      The count of negativeDelta.

    • getNegativeDelta

      long getNegativeDelta(int index)
       Use either "negative_delta" or "negative_count", the former for
 regular histograms with integer counts, the latter for float
 histograms.
      repeated sint64 negative_delta = 10;
      Parameters:
      index - The index of the element to return.
      Returns:
      The negativeDelta at the given index.

    • getNegativeCountList

      List<Double> getNegativeCountList()
       Absolute count of each bucket.
      repeated double negative_count = 11;
      Returns:
      A list containing the negativeCount.

    • getNegativeCountCount

      int getNegativeCountCount()
       Absolute count of each bucket.
      repeated double negative_count = 11;
      Returns:
      The count of negativeCount.

    • getNegativeCount

      double getNegativeCount(int index)
       Absolute count of each bucket.
      repeated double negative_count = 11;
      Parameters:
      index - The index of the element to return.
      Returns:
      The negativeCount at the given index.

    • getPositiveSpanList

      List<Metrics.BucketSpan> getPositiveSpanList()
       Positive buckets for the native histogram.
 Use a no-op span (offset 0, length 0) for a native histogram without any
 observations yet and with a zero_threshold of 0. Otherwise, it would be
 indistinguishable from a classic histogram.
      repeated .io.prometheus.client.BucketSpan positive_span = 12;

    • getPositiveSpan

      Metrics.BucketSpan getPositiveSpan(int index)
       Positive buckets for the native histogram.
 Use a no-op span (offset 0, length 0) for a native histogram without any
 observations yet and with a zero_threshold of 0. Otherwise, it would be
 indistinguishable from a classic histogram.
      repeated .io.prometheus.client.BucketSpan positive_span = 12;

    • getPositiveSpanCount

      int getPositiveSpanCount()
       Positive buckets for the native histogram.
 Use a no-op span (offset 0, length 0) for a native histogram without any
 observations yet and with a zero_threshold of 0. Otherwise, it would be
 indistinguishable from a classic histogram.
      repeated .io.prometheus.client.BucketSpan positive_span = 12;

    • getPositiveSpanOrBuilderList

      List<? extends Metrics.BucketSpanOrBuilder> getPositiveSpanOrBuilderList()
       Positive buckets for the native histogram.
 Use a no-op span (offset 0, length 0) for a native histogram without any
 observations yet and with a zero_threshold of 0. Otherwise, it would be
 indistinguishable from a classic histogram.
      repeated .io.prometheus.client.BucketSpan positive_span = 12;

    • getPositiveSpanOrBuilder

      Metrics.BucketSpanOrBuilder getPositiveSpanOrBuilder(int index)
       Positive buckets for the native histogram.
 Use a no-op span (offset 0, length 0) for a native histogram without any
 observations yet and with a zero_threshold of 0. Otherwise, it would be
 indistinguishable from a classic histogram.
      repeated .io.prometheus.client.BucketSpan positive_span = 12;

    • getPositiveDeltaList

      List<Long> getPositiveDeltaList()
       Use either "positive_delta" or "positive_count", the former for
 regular histograms with integer counts, the latter for float
 histograms.
      repeated sint64 positive_delta = 13;
      Returns:
      A list containing the positiveDelta.

    • getPositiveDeltaCount

      int getPositiveDeltaCount()
       Use either "positive_delta" or "positive_count", the former for
 regular histograms with integer counts, the latter for float
 histograms.
      repeated sint64 positive_delta = 13;
      Returns:
      The count of positiveDelta.

    • getPositiveDelta

      long getPositiveDelta(int index)
       Use either "positive_delta" or "positive_count", the former for
 regular histograms with integer counts, the latter for float
 histograms.
      repeated sint64 positive_delta = 13;
      Parameters:
      index - The index of the element to return.
      Returns:
      The positiveDelta at the given index.

    • getPositiveCountList

      List<Double> getPositiveCountList()
       Absolute count of each bucket.
      repeated double positive_count = 14;
      Returns:
      A list containing the positiveCount.

    • getPositiveCountCount

      int getPositiveCountCount()
       Absolute count of each bucket.
      repeated double positive_count = 14;
      Returns:
      The count of positiveCount.

    • getPositiveCount

      double getPositiveCount(int index)
       Absolute count of each bucket.
      repeated double positive_count = 14;
      Parameters:
      index - The index of the element to return.
      Returns:
      The positiveCount at the given index.

    • getExemplarsList

      List<Metrics.Exemplar> getExemplarsList()
       Only used for native histograms. These exemplars MUST have a timestamp.
      repeated .io.prometheus.client.Exemplar exemplars = 16;

    • getExemplars

      Metrics.Exemplar getExemplars(int index)
       Only used for native histograms. These exemplars MUST have a timestamp.
      repeated .io.prometheus.client.Exemplar exemplars = 16;

    • getExemplarsCount

      int getExemplarsCount()
       Only used for native histograms. These exemplars MUST have a timestamp.
      repeated .io.prometheus.client.Exemplar exemplars = 16;

    • getExemplarsOrBuilderList

      List<? extends Metrics.ExemplarOrBuilder> getExemplarsOrBuilderList()
       Only used for native histograms. These exemplars MUST have a timestamp.
      repeated .io.prometheus.client.Exemplar exemplars = 16;

    • getExemplarsOrBuilder

      Metrics.ExemplarOrBuilder getExemplarsOrBuilder(int index)
       Only used for native histograms. These exemplars MUST have a timestamp.
      repeated .io.prometheus.client.Exemplar exemplars = 16;