Package prometheus
Interface Types.HistogramOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Types.Histogram,Types.Histogram.Builder
- Enclosing class:
- Types
public static interface Types.HistogramOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptiondoubledouble count_float = 2;longuint64 count_int = 1;doublegetCustomValues(int index) custom_values are not part of the specification, DO NOT use in remote write clients.intcustom_values are not part of the specification, DO NOT use in remote write clients.custom_values are not part of the specification, DO NOT use in remote write clients.doublegetNegativeCounts(int index) Absolute count of each bucket.intAbsolute count of each bucket.Absolute count of each bucket.longgetNegativeDeltas(int index) Use either "negative_deltas" or "negative_counts", the former for regular histograms with integer counts, the latter for float histograms.intUse either "negative_deltas" or "negative_counts", the former for regular histograms with integer counts, the latter for float histograms.Use either "negative_deltas" or "negative_counts", the former for regular histograms with integer counts, the latter for float histograms.getNegativeSpans(int index) Negative Buckets.intNegative Buckets.Negative Buckets.getNegativeSpansOrBuilder(int index) Negative Buckets.List<? extends Types.BucketSpanOrBuilder>Negative Buckets.doublegetPositiveCounts(int index) Absolute count of each bucket.intAbsolute count of each bucket.Absolute count of each bucket.longgetPositiveDeltas(int index) Use either "positive_deltas" or "positive_counts", the former for regular histograms with integer counts, the latter for float histograms.intUse either "positive_deltas" or "positive_counts", the former for regular histograms with integer counts, the latter for float histograms.Use either "positive_deltas" or "positive_counts", the former for regular histograms with integer counts, the latter for float histograms.getPositiveSpans(int index) Positive Buckets.intPositive Buckets.Positive Buckets.getPositiveSpansOrBuilder(int index) Positive Buckets.List<? extends Types.BucketSpanOrBuilder>Positive Buckets..prometheus.Histogram.ResetHint reset_hint = 14;int.prometheus.Histogram.ResetHint reset_hint = 14;intThe schema defines the bucket schema.doublegetSum()Sum of observations in the histogram.longtimestamp is in ms format, see model/timestamp/timestamp.go for conversion from time.Time to Prometheus timestamp.doubledouble zero_count_float = 7;longuint64 zero_count_int = 6;doubleBreadth of the zero bucket.booleandouble count_float = 2;booleanuint64 count_int = 1;booleandouble zero_count_float = 7;booleanuint64 zero_count_int = 6;Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasCountInt
boolean hasCountInt()uint64 count_int = 1;- Returns:
- Whether the countInt field is set.
-
getCountInt
long getCountInt()uint64 count_int = 1;- Returns:
- The countInt.
-
hasCountFloat
boolean hasCountFloat()double count_float = 2;- Returns:
- Whether the countFloat field is set.
-
getCountFloat
double getCountFloat()double count_float = 2;- Returns:
- The countFloat.
-
getSum
double getSum()Sum of observations in the histogram.
double sum = 3;- Returns:
- The sum.
-
getSchema
int getSchema()The 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.
sint32 schema = 4;- Returns:
- The schema.
-
getZeroThreshold
double getZeroThreshold()Breadth of the zero bucket.
double zero_threshold = 5;- Returns:
- The zeroThreshold.
-
hasZeroCountInt
boolean hasZeroCountInt()uint64 zero_count_int = 6;- Returns:
- Whether the zeroCountInt field is set.
-
getZeroCountInt
long getZeroCountInt()uint64 zero_count_int = 6;- Returns:
- The zeroCountInt.
-
hasZeroCountFloat
boolean hasZeroCountFloat()double zero_count_float = 7;- Returns:
- Whether the zeroCountFloat field is set.
-
getZeroCountFloat
double getZeroCountFloat()double zero_count_float = 7;- Returns:
- The zeroCountFloat.
-
getNegativeSpansList
List<Types.BucketSpan> getNegativeSpansList()Negative Buckets.
repeated .prometheus.BucketSpan negative_spans = 8 [(.gogoproto.nullable) = false]; -
getNegativeSpans
Negative Buckets.
repeated .prometheus.BucketSpan negative_spans = 8 [(.gogoproto.nullable) = false]; -
getNegativeSpansCount
int getNegativeSpansCount()Negative Buckets.
repeated .prometheus.BucketSpan negative_spans = 8 [(.gogoproto.nullable) = false]; -
getNegativeSpansOrBuilderList
List<? extends Types.BucketSpanOrBuilder> getNegativeSpansOrBuilderList()Negative Buckets.
repeated .prometheus.BucketSpan negative_spans = 8 [(.gogoproto.nullable) = false]; -
getNegativeSpansOrBuilder
Negative Buckets.
repeated .prometheus.BucketSpan negative_spans = 8 [(.gogoproto.nullable) = false]; -
getNegativeDeltasList
Use either "negative_deltas" or "negative_counts", the former for regular histograms with integer counts, the latter for float histograms.
repeated sint64 negative_deltas = 9;- Returns:
- A list containing the negativeDeltas.
-
getNegativeDeltasCount
int getNegativeDeltasCount()Use either "negative_deltas" or "negative_counts", the former for regular histograms with integer counts, the latter for float histograms.
repeated sint64 negative_deltas = 9;- Returns:
- The count of negativeDeltas.
-
getNegativeDeltas
long getNegativeDeltas(int index) Use either "negative_deltas" or "negative_counts", the former for regular histograms with integer counts, the latter for float histograms.
repeated sint64 negative_deltas = 9;- Parameters:
index- The index of the element to return.- Returns:
- The negativeDeltas at the given index.
-
getNegativeCountsList
Absolute count of each bucket.
repeated double negative_counts = 10;- Returns:
- A list containing the negativeCounts.
-
getNegativeCountsCount
int getNegativeCountsCount()Absolute count of each bucket.
repeated double negative_counts = 10;- Returns:
- The count of negativeCounts.
-
getNegativeCounts
double getNegativeCounts(int index) Absolute count of each bucket.
repeated double negative_counts = 10;- Parameters:
index- The index of the element to return.- Returns:
- The negativeCounts at the given index.
-
getPositiveSpansList
List<Types.BucketSpan> getPositiveSpansList()Positive Buckets.
repeated .prometheus.BucketSpan positive_spans = 11 [(.gogoproto.nullable) = false]; -
getPositiveSpans
Positive Buckets.
repeated .prometheus.BucketSpan positive_spans = 11 [(.gogoproto.nullable) = false]; -
getPositiveSpansCount
int getPositiveSpansCount()Positive Buckets.
repeated .prometheus.BucketSpan positive_spans = 11 [(.gogoproto.nullable) = false]; -
getPositiveSpansOrBuilderList
List<? extends Types.BucketSpanOrBuilder> getPositiveSpansOrBuilderList()Positive Buckets.
repeated .prometheus.BucketSpan positive_spans = 11 [(.gogoproto.nullable) = false]; -
getPositiveSpansOrBuilder
Positive Buckets.
repeated .prometheus.BucketSpan positive_spans = 11 [(.gogoproto.nullable) = false]; -
getPositiveDeltasList
Use either "positive_deltas" or "positive_counts", the former for regular histograms with integer counts, the latter for float histograms.
repeated sint64 positive_deltas = 12;- Returns:
- A list containing the positiveDeltas.
-
getPositiveDeltasCount
int getPositiveDeltasCount()Use either "positive_deltas" or "positive_counts", the former for regular histograms with integer counts, the latter for float histograms.
repeated sint64 positive_deltas = 12;- Returns:
- The count of positiveDeltas.
-
getPositiveDeltas
long getPositiveDeltas(int index) Use either "positive_deltas" or "positive_counts", the former for regular histograms with integer counts, the latter for float histograms.
repeated sint64 positive_deltas = 12;- Parameters:
index- The index of the element to return.- Returns:
- The positiveDeltas at the given index.
-
getPositiveCountsList
Absolute count of each bucket.
repeated double positive_counts = 13;- Returns:
- A list containing the positiveCounts.
-
getPositiveCountsCount
int getPositiveCountsCount()Absolute count of each bucket.
repeated double positive_counts = 13;- Returns:
- The count of positiveCounts.
-
getPositiveCounts
double getPositiveCounts(int index) Absolute count of each bucket.
repeated double positive_counts = 13;- Parameters:
index- The index of the element to return.- Returns:
- The positiveCounts at the given index.
-
getResetHintValue
int getResetHintValue().prometheus.Histogram.ResetHint reset_hint = 14;- Returns:
- The enum numeric value on the wire for resetHint.
-
getResetHint
Types.Histogram.ResetHint getResetHint().prometheus.Histogram.ResetHint reset_hint = 14;- Returns:
- The resetHint.
-
getTimestamp
long getTimestamp()timestamp is in ms format, see model/timestamp/timestamp.go for conversion from time.Time to Prometheus timestamp.
int64 timestamp = 15;- Returns:
- The timestamp.
-
getCustomValuesList
custom_values are not part of the specification, DO NOT use in remote write clients. Used only for converting from OpenTelemetry to Prometheus internally.
repeated double custom_values = 16;- Returns:
- A list containing the customValues.
-
getCustomValuesCount
int getCustomValuesCount()custom_values are not part of the specification, DO NOT use in remote write clients. Used only for converting from OpenTelemetry to Prometheus internally.
repeated double custom_values = 16;- Returns:
- The count of customValues.
-
getCustomValues
double getCustomValues(int index) custom_values are not part of the specification, DO NOT use in remote write clients. Used only for converting from OpenTelemetry to Prometheus internally.
repeated double custom_values = 16;- Parameters:
index- The index of the element to return.- Returns:
- The customValues at the given index.
-
getCountCase
Types.Histogram.CountCase getCountCase() -
getZeroCountCase
Types.Histogram.ZeroCountCase getZeroCountCase()
-