Package com.google.api
Interface DistributionOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Distribution
,Distribution.Builder
public interface DistributionOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionlong
getBucketCounts
(int index) The number of values in each bucket of the histogram, as described in `bucket_options`.int
The number of values in each bucket of the histogram, as described in `bucket_options`.The number of values in each bucket of the histogram, as described in `bucket_options`.Defines the histogram bucket boundaries.Defines the histogram bucket boundaries.long
getCount()
The number of values in the population.getExemplars
(int index) Must be in increasing order of `value` field.int
Must be in increasing order of `value` field.Must be in increasing order of `value` field.getExemplarsOrBuilder
(int index) Must be in increasing order of `value` field.List<? extends Distribution.ExemplarOrBuilder>
Must be in increasing order of `value` field.double
getMean()
The arithmetic mean of the values in the population.getRange()
If specified, contains the range of the population values.If specified, contains the range of the population values.double
The sum of squared deviations from the mean of the values in the population.boolean
Defines the histogram bucket boundaries.boolean
hasRange()
If specified, contains the range of the population values.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
-
getCount
long getCount()The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.
int64 count = 1;
- Returns:
- The count.
-
getMean
double getMean()The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
double mean = 2;
- Returns:
- The mean.
-
getSumOfSquaredDeviation
double getSumOfSquaredDeviation()The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.
double sum_of_squared_deviation = 3;
- Returns:
- The sumOfSquaredDeviation.
-
hasRange
boolean hasRange()If specified, contains the range of the population values. The field must not be present if the `count` is zero.
.google.api.Distribution.Range range = 4;
- Returns:
- Whether the range field is set.
-
getRange
Distribution.Range getRange()If specified, contains the range of the population values. The field must not be present if the `count` is zero.
.google.api.Distribution.Range range = 4;
- Returns:
- The range.
-
getRangeOrBuilder
Distribution.RangeOrBuilder getRangeOrBuilder()If specified, contains the range of the population values. The field must not be present if the `count` is zero.
.google.api.Distribution.Range range = 4;
-
hasBucketOptions
boolean hasBucketOptions()Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
.google.api.Distribution.BucketOptions bucket_options = 6;
- Returns:
- Whether the bucketOptions field is set.
-
getBucketOptions
Distribution.BucketOptions getBucketOptions()Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
.google.api.Distribution.BucketOptions bucket_options = 6;
- Returns:
- The bucketOptions.
-
getBucketOptionsOrBuilder
Distribution.BucketOptionsOrBuilder getBucketOptionsOrBuilder()Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
.google.api.Distribution.BucketOptions bucket_options = 6;
-
getBucketCountsList
The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).
repeated int64 bucket_counts = 7;
- Returns:
- A list containing the bucketCounts.
-
getBucketCountsCount
int getBucketCountsCount()The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).
repeated int64 bucket_counts = 7;
- Returns:
- The count of bucketCounts.
-
getBucketCounts
long getBucketCounts(int index) The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).
repeated int64 bucket_counts = 7;
- Parameters:
index
- The index of the element to return.- Returns:
- The bucketCounts at the given index.
-
getExemplarsList
List<Distribution.Exemplar> getExemplarsList()Must be in increasing order of `value` field.
repeated .google.api.Distribution.Exemplar exemplars = 10;
-
getExemplars
Must be in increasing order of `value` field.
repeated .google.api.Distribution.Exemplar exemplars = 10;
-
getExemplarsCount
int getExemplarsCount()Must be in increasing order of `value` field.
repeated .google.api.Distribution.Exemplar exemplars = 10;
-
getExemplarsOrBuilderList
List<? extends Distribution.ExemplarOrBuilder> getExemplarsOrBuilderList()Must be in increasing order of `value` field.
repeated .google.api.Distribution.Exemplar exemplars = 10;
-
getExemplarsOrBuilder
Must be in increasing order of `value` field.
repeated .google.api.Distribution.Exemplar exemplars = 10;
-