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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Distribution.BuilderImplements
DistributionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| 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;
| Name | Description |
| values | Iterable<? extends java.lang.Long>The bucketCounts to add. |
| Type | Description |
| 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;
| Name | Description |
| values | Iterable<? extends com.google.api.Distribution.Exemplar> |
| Type | Description |
| 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;
| Name | Description |
| value | longThe bucketCounts to add. |
| Type | Description |
| 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;
| Name | Description |
| value | Distribution.Exemplar |
| Type | Description |
| 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;
| Name | Description |
| builderForValue | Distribution.Exemplar.Builder |
| Type | Description |
| 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;
| Name | Description |
| index | int |
| value | Distribution.Exemplar |
| Type | Description |
| 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;
| Name | Description |
| index | int |
| builderForValue | Distribution.Exemplar.Builder |
| Type | Description |
| Distribution.Builder |
addExemplarsBuilder()
public Distribution.Exemplar.Builder addExemplarsBuilder() Must be in increasing order of value field.
repeated .google.api.Distribution.Exemplar exemplars = 10;
| Type | Description |
| 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;
| Name | Description |
| index | int |
| Type | Description |
| Distribution.Exemplar.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Distribution.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| Distribution.Builder |
build()
public Distribution build()| Type | Description |
| Distribution |
buildPartial()
public Distribution buildPartial()| Type | Description |
| Distribution |
clear()
public Distribution.Builder clear()| Type | Description |
| Distribution.Builder |
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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| Distribution.Builder |
clearField(Descriptors.FieldDescriptor field)
public Distribution.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| Distribution.Builder |
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;
| Type | Description |
| Distribution.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Distribution.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| Distribution.Builder |
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;
| Type | Description |
| 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;
| Type | Description |
| Distribution.Builder | This builder for chaining. |
clone()
public Distribution.Builder clone()| Type | Description |
| Distribution.Builder |
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;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| long | The count. |
getDefaultInstanceForType()
public Distribution getDefaultInstanceForType()| Type | Description |
| Distribution |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getExemplars(int index)
public Distribution.Exemplar getExemplars(int index) Must be in increasing order of value field.
repeated .google.api.Distribution.Exemplar exemplars = 10;
| Name | Description |
| index | int |
| Type | Description |
| 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;
| Name | Description |
| index | int |
| Type | Description |
| 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;
| Type | Description |
| List<Builder> |
getExemplarsCount()
public int getExemplarsCount() Must be in increasing order of value field.
repeated .google.api.Distribution.Exemplar exemplars = 10;
| Type | Description |
| int |
getExemplarsList()
public List<Distribution.Exemplar> getExemplarsList() Must be in increasing order of value field.
repeated .google.api.Distribution.Exemplar exemplars = 10;
| Type | Description |
| 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;
| Name | Description |
| index | int |
| Type | Description |
| Distribution.ExemplarOrBuilder |
getExemplarsOrBuilderList()
public List<? extends Distribution.ExemplarOrBuilder> getExemplarsOrBuilderList() Must be in increasing order of value field.
repeated .google.api.Distribution.Exemplar exemplars = 10;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| boolean | Whether the range field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
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;
| Name | Description |
| value | Distribution.BucketOptions |
| Type | Description |
| Distribution.Builder |
mergeFrom(Distribution other)
public Distribution.Builder mergeFrom(Distribution other)| Name | Description |
| other | Distribution |
| Type | Description |
| Distribution.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Distribution.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Distribution.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public Distribution.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| Distribution.Builder |
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;
| Name | Description |
| value | Distribution.Range |
| Type | Description |
| Distribution.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Distribution.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| Distribution.Builder |
removeExemplars(int index)
public Distribution.Builder removeExemplars(int index) Must be in increasing order of value field.
repeated .google.api.Distribution.Exemplar exemplars = 10;
| Name | Description |
| index | int |
| Type | Description |
| 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;
| Name | Description |
| index | intThe index to set the value at. |
| value | longThe bucketCounts to set. |
| Type | Description |
| 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;
| Name | Description |
| value | Distribution.BucketOptions |
| Type | Description |
| 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;
| Name | Description |
| builderForValue | Distribution.BucketOptions.Builder |
| Type | Description |
| 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;
| Name | Description |
| value | longThe count to set. |
| Type | Description |
| 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;
| Name | Description |
| index | int |
| value | Distribution.Exemplar |
| Type | Description |
| 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;
| Name | Description |
| index | int |
| builderForValue | Distribution.Exemplar.Builder |
| Type | Description |
| Distribution.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public Distribution.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| Distribution.Builder |
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;
| Name | Description |
| value | doubleThe mean to set. |
| Type | Description |
| 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;
| Name | Description |
| value | Distribution.Range |
| Type | Description |
| 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;
| Name | Description |
| builderForValue | Distribution.Range.Builder |
| Type | Description |
| Distribution.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Distribution.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| Distribution.Builder |
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;
| Name | Description |
| value | doubleThe sumOfSquaredDeviation to set. |
| Type | Description |
| Distribution.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Distribution.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| Distribution.Builder |