Class Distribution

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

Fields

BUCKET_COUNTS_FIELD_NUMBER

public static final int BUCKET_COUNTS_FIELD_NUMBER
Field Value
TypeDescription
int

BUCKET_OPTIONS_FIELD_NUMBER

public static final int BUCKET_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

COUNT_FIELD_NUMBER

public static final int COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

EXEMPLARS_FIELD_NUMBER

public static final int EXEMPLARS_FIELD_NUMBER
Field Value
TypeDescription
int

MEAN_FIELD_NUMBER

public static final int MEAN_FIELD_NUMBER
Field Value
TypeDescription
int

RANGE_FIELD_NUMBER

public static final int RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

SUM_OF_SQUARED_DEVIATION_FIELD_NUMBER

public static final int SUM_OF_SQUARED_DEVIATION_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
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.

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.

getDefaultInstance()

public static Distribution getDefaultInstance()
Returns
TypeDescription
Distribution

getDefaultInstanceForType()

public Distribution getDefaultInstanceForType()
Returns
TypeDescription
Distribution

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
Distribution.Exemplar

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.

getParserForType()

public Parser<Distribution> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Distribution.RangeOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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: 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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static Distribution.Builder newBuilder()
Returns
TypeDescription
Distribution.Builder

newBuilder(Distribution prototype)

public static Distribution.Builder newBuilder(Distribution prototype)
Parameter
NameDescription
prototypeDistribution
Returns
TypeDescription
Distribution.Builder

newBuilderForType()

public Distribution.Builder newBuilderForType()
Returns
TypeDescription
Distribution.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Distribution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Distribution.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static Distribution parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Distribution
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Distribution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Distribution parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Distribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Distribution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Distribution parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Distribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Distribution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Distribution parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Distribution
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Distribution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Distribution parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Distribution
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Distribution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Distribution parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Distribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Distribution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Distribution> parser()
Returns
TypeDescription
Parser<Distribution>

toBuilder()

public Distribution.Builder toBuilder()
Returns
TypeDescription
Distribution.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException