Class Distribution.Builder (2.9.0)

public static final class Distribution.Builder extends GeneratedMessageV3.Builder<Distribution.Builder> implements DistributionOrBuilder

Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.

Protobuf type google.api.Distribution

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllBucketCounts(Iterable<? extends Long> values)

public Distribution.Builder addAllBucketCounts(Iterable<? extends Long> values)

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
NameDescription
valuesIterable<? extends java.lang.Long>

The bucketCounts to add.

Returns
TypeDescription
Distribution.Builder

This builder for chaining.

addAllExemplars(Iterable<? extends Distribution.Exemplar> values)

public Distribution.Builder addAllExemplars(Iterable<? extends Distribution.Exemplar> values)

Must be in increasing order of value field.

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

Parameter
NameDescription
valuesIterable<? extends com.google.api.Distribution.Exemplar>
Returns
TypeDescription
Distribution.Builder

addBucketCounts(long value)

public Distribution.Builder addBucketCounts(long value)

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
NameDescription
valuelong

The bucketCounts to add.

Returns
TypeDescription
Distribution.Builder

This builder for chaining.

addExemplars(Distribution.Exemplar value)

public Distribution.Builder addExemplars(Distribution.Exemplar value)

Must be in increasing order of value field.

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

Parameter
NameDescription
valueDistribution.Exemplar
Returns
TypeDescription
Distribution.Builder

addExemplars(Distribution.Exemplar.Builder builderForValue)

public Distribution.Builder addExemplars(Distribution.Exemplar.Builder builderForValue)

Must be in increasing order of value field.

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

Parameter
NameDescription
builderForValueDistribution.Exemplar.Builder
Returns
TypeDescription
Distribution.Builder

addExemplars(int index, Distribution.Exemplar value)

public Distribution.Builder addExemplars(int index, Distribution.Exemplar value)

Must be in increasing order of value field.

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

Parameters
NameDescription
indexint
valueDistribution.Exemplar
Returns
TypeDescription
Distribution.Builder

addExemplars(int index, Distribution.Exemplar.Builder builderForValue)

public Distribution.Builder addExemplars(int index, Distribution.Exemplar.Builder builderForValue)

Must be in increasing order of value field.

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

Parameters
NameDescription
indexint
builderForValueDistribution.Exemplar.Builder
Returns
TypeDescription
Distribution.Builder

addExemplarsBuilder()

public Distribution.Exemplar.Builder addExemplarsBuilder()

Must be in increasing order of value field.

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

Returns
TypeDescription
Distribution.Exemplar.Builder

addExemplarsBuilder(int index)

public Distribution.Exemplar.Builder addExemplarsBuilder(int index)

Must be in increasing order of value field.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Distribution.Exemplar.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Distribution.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Distribution.Builder
Overrides

build()

public Distribution build()
Returns
TypeDescription
Distribution

buildPartial()

public Distribution buildPartial()
Returns
TypeDescription
Distribution

clear()

public Distribution.Builder clear()
Returns
TypeDescription
Distribution.Builder
Overrides

clearBucketCounts()

public Distribution.Builder clearBucketCounts()

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
TypeDescription
Distribution.Builder

This builder for chaining.

clearBucketOptions()

public Distribution.Builder clearBucketOptions()

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
TypeDescription
Distribution.Builder

clearCount()

public Distribution.Builder clearCount()

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
TypeDescription
Distribution.Builder

This builder for chaining.

clearExemplars()

public Distribution.Builder clearExemplars()

Must be in increasing order of value field.

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

Returns
TypeDescription
Distribution.Builder

clearField(Descriptors.FieldDescriptor field)

public Distribution.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Distribution.Builder
Overrides

clearMean()

public Distribution.Builder clearMean()

The arithmetic mean of the values in the population. If count is zero then this field must be zero.

double mean = 2;

Returns
TypeDescription
Distribution.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Distribution.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Distribution.Builder
Overrides

clearRange()

public Distribution.Builder clearRange()

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
TypeDescription
Distribution.Builder

clearSumOfSquaredDeviation()

public Distribution.Builder clearSumOfSquaredDeviation()

The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sumi=1..n^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
TypeDescription
Distribution.Builder

This builder for chaining.

clone()

public Distribution.Builder clone()
Returns
TypeDescription
Distribution.Builder
Overrides

getBucketCounts(int index)

public 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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
long

The bucketCounts at the given index.

getBucketCountsCount()

public 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
TypeDescription
int

The count of bucketCounts.

getBucketCountsList()

public 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
TypeDescription
List<Long>

A list containing the bucketCounts.

getBucketOptions()

public 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
TypeDescription
Distribution.BucketOptions

The bucketOptions.

getBucketOptionsBuilder()

public Distribution.BucketOptions.Builder getBucketOptionsBuilder()

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
TypeDescription
Distribution.BucketOptions.Builder

getBucketOptionsOrBuilder()

public 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
TypeDescription
Distribution.BucketOptionsOrBuilder

getCount()

public 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
TypeDescription
long

The count.

getDefaultInstanceForType()

public Distribution getDefaultInstanceForType()
Returns
TypeDescription
Distribution

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getExemplars(int index)

public Distribution.Exemplar getExemplars(int index)

Must be in increasing order of value field.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Distribution.Exemplar

getExemplarsBuilder(int index)

public Distribution.Exemplar.Builder getExemplarsBuilder(int index)

Must be in increasing order of value field.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Distribution.Exemplar.Builder

getExemplarsBuilderList()

public List<Distribution.Exemplar.Builder> getExemplarsBuilderList()

Must be in increasing order of value field.

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

Returns
TypeDescription
List<Builder>

getExemplarsCount()

public int getExemplarsCount()

Must be in increasing order of value field.

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

Returns
TypeDescription
int

getExemplarsList()

public List<Distribution.Exemplar> getExemplarsList()

Must be in increasing order of value field.

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

Returns
TypeDescription
List<Exemplar>

getExemplarsOrBuilder(int index)

public Distribution.ExemplarOrBuilder getExemplarsOrBuilder(int index)

Must be in increasing order of value field.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Distribution.ExemplarOrBuilder

getExemplarsOrBuilderList()

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

Must be in increasing order of value field.

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

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

getMean()

public 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
TypeDescription
double

The mean.

getRange()

public 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
TypeDescription
Distribution.Range

The range.

getRangeBuilder()

public Distribution.Range.Builder getRangeBuilder()

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
TypeDescription
Distribution.Range.Builder

getRangeOrBuilder()

public 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
TypeDescription
Distribution.RangeOrBuilder

getSumOfSquaredDeviation()

public double getSumOfSquaredDeviation()

The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sumi=1..n^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
TypeDescription
double

The sumOfSquaredDeviation.

hasBucketOptions()

public 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
TypeDescription
boolean

Whether the bucketOptions field is set.

hasRange()

public 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
TypeDescription
boolean

Whether the range field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBucketOptions(Distribution.BucketOptions value)

public Distribution.Builder mergeBucketOptions(Distribution.BucketOptions value)

Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.

.google.api.Distribution.BucketOptions bucket_options = 6;

Parameter
NameDescription
valueDistribution.BucketOptions
Returns
TypeDescription
Distribution.Builder

mergeFrom(Distribution other)

public Distribution.Builder mergeFrom(Distribution other)
Parameter
NameDescription
otherDistribution
Returns
TypeDescription
Distribution.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Distribution.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Distribution.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Distribution.Builder
Overrides

mergeRange(Distribution.Range value)

public Distribution.Builder mergeRange(Distribution.Range value)

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;

Parameter
NameDescription
valueDistribution.Range
Returns
TypeDescription
Distribution.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Distribution.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Distribution.Builder
Overrides

removeExemplars(int index)

public Distribution.Builder removeExemplars(int index)

Must be in increasing order of value field.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Distribution.Builder

setBucketCounts(int index, long value)

public Distribution.Builder setBucketCounts(int index, long value)

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
NameDescription
indexint

The index to set the value at.

valuelong

The bucketCounts to set.

Returns
TypeDescription
Distribution.Builder

This builder for chaining.

setBucketOptions(Distribution.BucketOptions value)

public Distribution.Builder setBucketOptions(Distribution.BucketOptions value)

Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.

.google.api.Distribution.BucketOptions bucket_options = 6;

Parameter
NameDescription
valueDistribution.BucketOptions
Returns
TypeDescription
Distribution.Builder

setBucketOptions(Distribution.BucketOptions.Builder builderForValue)

public Distribution.Builder setBucketOptions(Distribution.BucketOptions.Builder builderForValue)

Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.

.google.api.Distribution.BucketOptions bucket_options = 6;

Parameter
NameDescription
builderForValueDistribution.BucketOptions.Builder
Returns
TypeDescription
Distribution.Builder

setCount(long value)

public Distribution.Builder setCount(long value)

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;

Parameter
NameDescription
valuelong

The count to set.

Returns
TypeDescription
Distribution.Builder

This builder for chaining.

setExemplars(int index, Distribution.Exemplar value)

public Distribution.Builder setExemplars(int index, Distribution.Exemplar value)

Must be in increasing order of value field.

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

Parameters
NameDescription
indexint
valueDistribution.Exemplar
Returns
TypeDescription
Distribution.Builder

setExemplars(int index, Distribution.Exemplar.Builder builderForValue)

public Distribution.Builder setExemplars(int index, Distribution.Exemplar.Builder builderForValue)

Must be in increasing order of value field.

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

Parameters
NameDescription
indexint
builderForValueDistribution.Exemplar.Builder
Returns
TypeDescription
Distribution.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Distribution.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Distribution.Builder
Overrides

setMean(double value)

public Distribution.Builder setMean(double value)

The arithmetic mean of the values in the population. If count is zero then this field must be zero.

double mean = 2;

Parameter
NameDescription
valuedouble

The mean to set.

Returns
TypeDescription
Distribution.Builder

This builder for chaining.

setRange(Distribution.Range value)

public Distribution.Builder setRange(Distribution.Range value)

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;

Parameter
NameDescription
valueDistribution.Range
Returns
TypeDescription
Distribution.Builder

setRange(Distribution.Range.Builder builderForValue)

public Distribution.Builder setRange(Distribution.Range.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueDistribution.Range.Builder
Returns
TypeDescription
Distribution.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Distribution.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Distribution.Builder
Overrides

setSumOfSquaredDeviation(double value)

public Distribution.Builder setSumOfSquaredDeviation(double value)

The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sumi=1..n^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;

Parameter
NameDescription
valuedouble

The sumOfSquaredDeviation to set.

Returns
TypeDescription
Distribution.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Distribution.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Distribution.Builder
Overrides