Class Distribution (2.43.0)

public final class Distribution extends GeneratedMessageV3 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 Fields

BUCKET_COUNTS_FIELD_NUMBER

public static final int BUCKET_COUNTS_FIELD_NUMBER
Field Value
Type Description
int

BUCKET_OPTIONS_FIELD_NUMBER

public static final int BUCKET_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

COUNT_FIELD_NUMBER

public static final int COUNT_FIELD_NUMBER
Field Value
Type Description
int

EXEMPLARS_FIELD_NUMBER

public static final int EXEMPLARS_FIELD_NUMBER
Field Value
Type Description
int

MEAN_FIELD_NUMBER

public static final int MEAN_FIELD_NUMBER
Field Value
Type Description
int

RANGE_FIELD_NUMBER

public static final int RANGE_FIELD_NUMBER
Field Value
Type Description
int

SUM_OF_SQUARED_DEVIATION_FIELD_NUMBER

public static final int SUM_OF_SQUARED_DEVIATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Distribution getDefaultInstance()
Returns
Type Description
Distribution

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Distribution.Builder newBuilder()
Returns
Type Description
Distribution.Builder

newBuilder(Distribution prototype)

public static Distribution.Builder newBuilder(Distribution prototype)
Parameter
Name Description
prototype Distribution
Returns
Type Description
Distribution.Builder

parseDelimitedFrom(InputStream input)

public static Distribution parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Distribution
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Distribution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Distribution parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Distribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Distribution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Distribution parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Distribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Distribution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Distribution parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Distribution
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Distribution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Distribution parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Distribution
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Distribution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Distribution parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Distribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Distribution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Distribution> parser()
Returns
Type Description
Parser<Distribution>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Name Description
index int

The index of the element to return.

Returns
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;

Returns
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;

Returns
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;

Returns
Type Description
Distribution.BucketOptions

The bucketOptions.

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

Returns
Type Description
long

The count.

getDefaultInstanceForType()

public Distribution getDefaultInstanceForType()
Returns
Type Description
Distribution

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
Name Description
index int
Returns
Type Description
Distribution.Exemplar

getExemplarsCount()

public int getExemplarsCount()

Must be in increasing order of value field.

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

Returns
Type Description
int

getExemplarsList()

public 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 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 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 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.

getParserForType()

public Parser<Distribution> getParserForType()
Returns
Type Description
Parser<Distribution>
Overrides

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
Type Description
Distribution.Range

The range.

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
Type Description
Distribution.RangeOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSumOfSquaredDeviation()

public 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Distribution.Builder newBuilderForType()
Returns
Type Description
Distribution.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Distribution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Distribution.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Distribution.Builder toBuilder()
Returns
Type Description
Distribution.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException