Interface DistributionOrBuilder (2.48.0)

Version latest

• 2.48.0 (latest)
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public interface DistributionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBucketCounts(int index)

public abstract 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;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
long	The bucketCounts at the given index.

getBucketCountsCount()

public abstract 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
Type	Description
int	The count of bucketCounts.

getBucketCountsList()

public abstract List<Long> 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
Type	Description
List<Long>	A list containing the bucketCounts.

getBucketOptions()

public abstract 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
Type	Description
Distribution.BucketOptions	The bucketOptions.

getBucketOptionsOrBuilder()

public abstract 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;

Returns
Type	Description
Distribution.BucketOptionsOrBuilder

getCount()

public abstract 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
Type	Description
long	The count.

getExemplars(int index)

public abstract Distribution.Exemplar getExemplars(int index)

Must be in increasing order of value field.

repeated .google.api.Distribution.Exemplar exemplars = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
Distribution.Exemplar

getExemplarsCount()

public abstract int getExemplarsCount()

Must be in increasing order of value field.

repeated .google.api.Distribution.Exemplar exemplars = 10;

Returns
Type	Description
int

getExemplarsList()

public abstract List<Distribution.Exemplar> getExemplarsList()

Must be in increasing order of value field.

repeated .google.api.Distribution.Exemplar exemplars = 10;

Returns
Type	Description
List<Exemplar>

getExemplarsOrBuilder(int index)

public abstract Distribution.ExemplarOrBuilder getExemplarsOrBuilder(int index)

Must be in increasing order of value field.

repeated .google.api.Distribution.Exemplar exemplars = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
Distribution.ExemplarOrBuilder

getExemplarsOrBuilderList()

public abstract List<? extends Distribution.ExemplarOrBuilder> getExemplarsOrBuilderList()

Must be in increasing order of value field.

repeated .google.api.Distribution.Exemplar exemplars = 10;

Returns
Type	Description
List<? extends com.google.api.Distribution.ExemplarOrBuilder>

getMean()

public abstract 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
Type	Description
double	The mean.

getRange()

public abstract 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
Type	Description
Distribution.Range	The range.

getRangeOrBuilder()

public abstract 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;

Returns
Type	Description
Distribution.RangeOrBuilder

getSumOfSquaredDeviation()

public abstract double getSumOfSquaredDeviation()

The sum of squared deviations from the mean of the values in the population. For values x_i this is:

 Sum<a href="(x_i - mean">i=1..n</a>^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
Type	Description
double	The sumOfSquaredDeviation.

hasBucketOptions()

public abstract 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
Type	Description
boolean	Whether the bucketOptions field is set.

hasRange()

public abstract 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
Type	Description
boolean	Whether the range field is set.