io.opencensus.proto.metrics.v1

Class DistributionValue

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.opencensus.proto.metrics.v1.DistributionValue

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DistributionValueOrBuilder, Serializable

public final class DistributionValue
extends com.google.protobuf.GeneratedMessageV3
implements DistributionValueOrBuilder

 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.
 

Protobuf type opencensus.proto.metrics.v1.DistributionValue

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistributionValue.Bucket Protobuf type opencensus.proto.metrics.v1.DistributionValue.Bucket
static class	DistributionValue.BucketOptions A Distribution may optionally contain a histogram of the values in the population.
static interface	DistributionValue.BucketOptionsOrBuilder
static interface	DistributionValue.BucketOrBuilder
static class	DistributionValue.Builder Distribution contains summary statistics for a population of values.
static class	DistributionValue.Exemplar Exemplars are example points that may be used to annotate aggregated Distribution values.
static interface	DistributionValue.ExemplarOrBuilder

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUCKET_OPTIONS_FIELD_NUMBER
static int	BUCKETS_FIELD_NUMBER
static int	COUNT_FIELD_NUMBER
static int	SUM_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(Object obj)
DistributionValue.BucketOptions	getBucketOptions() Don't change bucket boundaries within a TimeSeries if your backend doesn't support this.
DistributionValue.BucketOptionsOrBuilder	getBucketOptionsOrBuilder() Don't change bucket boundaries within a TimeSeries if your backend doesn't support this.
DistributionValue.Bucket	getBuckets(int index) If the distribution does not have a histogram, then omit this field.
int	getBucketsCount() If the distribution does not have a histogram, then omit this field.
List<DistributionValue.Bucket>	getBucketsList() If the distribution does not have a histogram, then omit this field.
DistributionValue.BucketOrBuilder	getBucketsOrBuilder(int index) If the distribution does not have a histogram, then omit this field.
List<? extends DistributionValue.BucketOrBuilder>	getBucketsOrBuilderList() If the distribution does not have a histogram, then omit this field.
long	getCount() The number of values in the population.
static DistributionValue	getDefaultInstance()
DistributionValue	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<DistributionValue>	getParserForType()
int	getSerializedSize()
double	getSum() The sum of the values in the population.
double	getSumOfSquaredDeviation() The sum of squared deviations from the mean of the values in the population.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasBucketOptions() Don't change bucket boundaries within a TimeSeries if your backend doesn't support this.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DistributionValue.Builder	newBuilder()
static DistributionValue.Builder	newBuilder(DistributionValue prototype)
DistributionValue.Builder	newBuilderForType()
protected DistributionValue.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static DistributionValue	parseDelimitedFrom(InputStream input)
static DistributionValue	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DistributionValue	parseFrom(byte[] data)
static DistributionValue	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DistributionValue	parseFrom(ByteBuffer data)
static DistributionValue	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DistributionValue	parseFrom(com.google.protobuf.ByteString data)
static DistributionValue	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DistributionValue	parseFrom(com.google.protobuf.CodedInputStream input)
static DistributionValue	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DistributionValue	parseFrom(InputStream input)
static DistributionValue	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DistributionValue>	parser()
DistributionValue.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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

SUM_FIELD_NUMBER

public static final int SUM_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

BUCKET_OPTIONS_FIELD_NUMBER

public static final int BUCKET_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

BUCKETS_FIELD_NUMBER

public static final int BUCKETS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.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 DistributionValueOrBuilder

getSum

public double getSum()

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

double sum = 2;

Specified by:

getSum in interface DistributionValueOrBuilder

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 DistributionValueOrBuilder

hasBucketOptions

public boolean hasBucketOptions()

 Don't change bucket boundaries within a TimeSeries if your backend doesn't
 support this.
 TODO(issue #152): consider not required to send bucket options for
 optimization.
 

.opencensus.proto.metrics.v1.DistributionValue.BucketOptions bucket_options = 4;

Specified by:

hasBucketOptions in interface DistributionValueOrBuilder

getBucketOptions

public DistributionValue.BucketOptions getBucketOptions()

 Don't change bucket boundaries within a TimeSeries if your backend doesn't
 support this.
 TODO(issue #152): consider not required to send bucket options for
 optimization.
 

.opencensus.proto.metrics.v1.DistributionValue.BucketOptions bucket_options = 4;

Specified by:

getBucketOptions in interface DistributionValueOrBuilder

getBucketOptionsOrBuilder

public DistributionValue.BucketOptionsOrBuilder getBucketOptionsOrBuilder()

 Don't change bucket boundaries within a TimeSeries if your backend doesn't
 support this.
 TODO(issue #152): consider not required to send bucket options for
 optimization.
 

.opencensus.proto.metrics.v1.DistributionValue.BucketOptions bucket_options = 4;

Specified by:

getBucketOptionsOrBuilder in interface DistributionValueOrBuilder

getBucketsList

public List<DistributionValue.Bucket> getBucketsList()

 If the distribution does not have a histogram, then omit this field.
 If there is a histogram, then the sum of the values in the Bucket counts
 must equal the value in the count field of the distribution.
 

repeated .opencensus.proto.metrics.v1.DistributionValue.Bucket buckets = 5;

Specified by:

getBucketsList in interface DistributionValueOrBuilder

getBucketsOrBuilderList

public List<? extends DistributionValue.BucketOrBuilder> getBucketsOrBuilderList()

 If the distribution does not have a histogram, then omit this field.
 If there is a histogram, then the sum of the values in the Bucket counts
 must equal the value in the count field of the distribution.
 

repeated .opencensus.proto.metrics.v1.DistributionValue.Bucket buckets = 5;

Specified by:

getBucketsOrBuilderList in interface DistributionValueOrBuilder

getBucketsCount

public int getBucketsCount()

 If the distribution does not have a histogram, then omit this field.
 If there is a histogram, then the sum of the values in the Bucket counts
 must equal the value in the count field of the distribution.
 

repeated .opencensus.proto.metrics.v1.DistributionValue.Bucket buckets = 5;

Specified by:

getBucketsCount in interface DistributionValueOrBuilder

getBuckets

public DistributionValue.Bucket getBuckets(int index)

 If the distribution does not have a histogram, then omit this field.
 If there is a histogram, then the sum of the values in the Bucket counts
 must equal the value in the count field of the distribution.
 

repeated .opencensus.proto.metrics.v1.DistributionValue.Bucket buckets = 5;

Specified by:

getBuckets in interface DistributionValueOrBuilder

getBucketsOrBuilder

public DistributionValue.BucketOrBuilder getBucketsOrBuilder(int index)

 If the distribution does not have a histogram, then omit this field.
 If there is a histogram, then the sum of the values in the Bucket counts
 must equal the value in the count field of the distribution.
 

repeated .opencensus.proto.metrics.v1.DistributionValue.Bucket buckets = 5;

Specified by:

getBucketsOrBuilder in interface DistributionValueOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DistributionValue parseFrom(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DistributionValue parseFrom(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DistributionValue parseFrom(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DistributionValue parseFrom(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DistributionValue parseFrom(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DistributionValue parseFrom(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DistributionValue parseFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static DistributionValue parseFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static DistributionValue parseDelimitedFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static DistributionValue parseDelimitedFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseFrom

public static DistributionValue parseFrom(com.google.protobuf.CodedInputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static DistributionValue parseFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

newBuilderForType

public DistributionValue.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DistributionValue.Builder newBuilder()

newBuilder

public static DistributionValue.Builder newBuilder(DistributionValue prototype)

toBuilder

public DistributionValue.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DistributionValue.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DistributionValue getDefaultInstance()

parser

public static com.google.protobuf.Parser<DistributionValue> parser()

getParserForType

public com.google.protobuf.Parser<DistributionValue> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public DistributionValue getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder