com.google.api

Class Distribution

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.api.Distribution

All Implemented Interfaces:

DistributionOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Distribution.BucketOptions `BucketOptions` describes the bucket boundaries used to create a histogram for the distribution.
static interface	Distribution.BucketOptionsOrBuilder
static class	Distribution.Builder `Distribution` contains summary statistics for a population of values.
static class	Distribution.Exemplar Exemplars are example points that may be used to annotate aggregated distribution values.
static interface	Distribution.ExemplarOrBuilder
static class	Distribution.Range The range of the population values.
static interface	Distribution.RangeOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUCKET_COUNTS_FIELD_NUMBER
static int	BUCKET_OPTIONS_FIELD_NUMBER
static int	COUNT_FIELD_NUMBER
static int	EXEMPLARS_FIELD_NUMBER
static int	MEAN_FIELD_NUMBER
static int	RANGE_FIELD_NUMBER
static int	SUM_OF_SQUARED_DEVIATION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
long	getBucketCounts(int index) The number of values in each bucket of the histogram, as described in `bucket_options`.
int	getBucketCountsCount() The number of values in each bucket of the histogram, as described in `bucket_options`.
java.util.List<java.lang.Long>	getBucketCountsList() The number of values in each bucket of the histogram, as described in `bucket_options`.
Distribution.BucketOptions	getBucketOptions() Defines the histogram bucket boundaries.
Distribution.BucketOptionsOrBuilder	getBucketOptionsOrBuilder() Defines the histogram bucket boundaries.
long	getCount() The number of values in the population.
static Distribution	getDefaultInstance()
Distribution	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Distribution.Exemplar	getExemplars(int index) Must be in increasing order of `value` field.
int	getExemplarsCount() Must be in increasing order of `value` field.
java.util.List<Distribution.Exemplar>	getExemplarsList() Must be in increasing order of `value` field.
Distribution.ExemplarOrBuilder	getExemplarsOrBuilder(int index) Must be in increasing order of `value` field.
java.util.List<? extends Distribution.ExemplarOrBuilder>	getExemplarsOrBuilderList() Must be in increasing order of `value` field.
double	getMean() The arithmetic mean of the values in the population.
Parser<Distribution>	getParserForType()
Distribution.Range	getRange() If specified, contains the range of the population values.
Distribution.RangeOrBuilder	getRangeOrBuilder() If specified, contains the range of the population values.
int	getSerializedSize()
double	getSumOfSquaredDeviation() The sum of squared deviations from the mean of the values in the population.
UnknownFieldSet	getUnknownFields()
boolean	hasBucketOptions() Defines the histogram bucket boundaries.
int	hashCode()
boolean	hasRange() If specified, contains the range of the population values.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Distribution.Builder	newBuilder()
static Distribution.Builder	newBuilder(Distribution prototype)
Distribution.Builder	newBuilderForType()
protected Distribution.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static Distribution	parseDelimitedFrom(java.io.InputStream input)
static Distribution	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Distribution	parseFrom(byte[] data)
static Distribution	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Distribution	parseFrom(java.nio.ByteBuffer data)
static Distribution	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Distribution	parseFrom(ByteString data)
static Distribution	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Distribution	parseFrom(CodedInputStream input)
static Distribution	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Distribution	parseFrom(java.io.InputStream input)
static Distribution	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Distribution>	parser()
Distribution.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

COUNT_FIELD_NUMBER

public static final int COUNT_FIELD_NUMBER

See Also:

Constant Field Values

MEAN_FIELD_NUMBER

public static final int MEAN_FIELD_NUMBER

See Also:

Constant Field Values

SUM_OF_SQUARED_DEVIATION_FIELD_NUMBER

public static final int SUM_OF_SQUARED_DEVIATION_FIELD_NUMBER

See Also:

Constant Field Values

RANGE_FIELD_NUMBER

public static final int RANGE_FIELD_NUMBER

See Also:

Constant Field Values

BUCKET_OPTIONS_FIELD_NUMBER

public static final int BUCKET_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

BUCKET_COUNTS_FIELD_NUMBER

public static final int BUCKET_COUNTS_FIELD_NUMBER

See Also:

Constant Field Values

EXEMPLARS_FIELD_NUMBER

public static final int EXEMPLARS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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;

Specified by:

getCount in interface DistributionOrBuilder

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;

Specified by:

getMean in interface DistributionOrBuilder

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[i=1..n]((x_i - mean)^2)
 Knuth, "The Art of Computer Programming", Vol. 2, page 323, 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;

Specified by:

getSumOfSquaredDeviation in interface DistributionOrBuilder

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;

Specified by:

hasRange in interface DistributionOrBuilder

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;

Specified by:

getRange in interface DistributionOrBuilder

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;

Specified by:

getRangeOrBuilder in interface DistributionOrBuilder

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;

Specified by:

hasBucketOptions in interface DistributionOrBuilder

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;

Specified by:

getBucketOptions in interface DistributionOrBuilder

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;

Specified by:

getBucketOptionsOrBuilder in interface DistributionOrBuilder

getBucketCountsList

public java.util.List<java.lang.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;

Specified by:

getBucketCountsList in interface DistributionOrBuilder

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;

Specified by:

getBucketCountsCount in interface DistributionOrBuilder

getBucketCounts

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;

Specified by:

getBucketCounts in interface DistributionOrBuilder

getExemplarsList

public java.util.List<Distribution.Exemplar> getExemplarsList()

 Must be in increasing order of `value` field.
 

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

Specified by:

getExemplarsList in interface DistributionOrBuilder

getExemplarsOrBuilderList

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

 Must be in increasing order of `value` field.
 

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

Specified by:

getExemplarsOrBuilderList in interface DistributionOrBuilder

getExemplarsCount

public int getExemplarsCount()

 Must be in increasing order of `value` field.
 

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

Specified by:

getExemplarsCount in interface DistributionOrBuilder

getExemplars

public Distribution.Exemplar getExemplars(int index)

 Must be in increasing order of `value` field.
 

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

Specified by:

getExemplars in interface DistributionOrBuilder

getExemplarsOrBuilder

public Distribution.ExemplarOrBuilder getExemplarsOrBuilder(int index)

 Must be in increasing order of `value` field.
 

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

Specified by:

getExemplarsOrBuilder in interface DistributionOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Distribution parseFrom(java.nio.ByteBuffer data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Distribution parseFrom(java.nio.ByteBuffer data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Distribution parseFrom(ByteString data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Distribution parseFrom(ByteString data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Distribution parseFrom(byte[] data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Distribution parseFrom(byte[] data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Distribution parseFrom(java.io.InputStream input)
                              throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Distribution parseFrom(java.io.InputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Distribution parseDelimitedFrom(java.io.InputStream input)
                                       throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Distribution parseDelimitedFrom(java.io.InputStream input,
                                              ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Distribution parseFrom(CodedInputStream input)
                              throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Distribution parseFrom(CodedInputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Distribution.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Distribution.Builder newBuilder()

newBuilder

public static Distribution.Builder newBuilder(Distribution prototype)

toBuilder

public Distribution.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Distribution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Distribution getDefaultInstance()

parser

public static Parser<Distribution> parser()

getParserForType

public Parser<Distribution> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Distribution getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder