Class Distribution (1.33.0)

public final class Distribution extends GeneratedMessageV3 implements DistributionOrBuilder

Distribution represents a frequency distribution of double-valued sample points. It contains the size of the population of sample points plus additional optional information:

  • the arithmetic mean of the samples
  • the minimum and maximum of the samples
  • the sum-squared-deviation of the samples, used to compute variance
  • a histogram of the values of the sample points

Protobuf type google.api.servicecontrol.v1.Distribution

Static Fields

BUCKET_COUNTS_FIELD_NUMBER

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

EXPLICIT_BUCKETS_FIELD_NUMBER

public static final int EXPLICIT_BUCKETS_FIELD_NUMBER
Field Value
TypeDescription
int

EXPONENTIAL_BUCKETS_FIELD_NUMBER

public static final int EXPONENTIAL_BUCKETS_FIELD_NUMBER
Field Value
TypeDescription
int

LINEAR_BUCKETS_FIELD_NUMBER

public static final int LINEAR_BUCKETS_FIELD_NUMBER
Field Value
TypeDescription
int

MAXIMUM_FIELD_NUMBER

public static final int MAXIMUM_FIELD_NUMBER
Field Value
TypeDescription
int

MEAN_FIELD_NUMBER

public static final int MEAN_FIELD_NUMBER
Field Value
TypeDescription
int

MINIMUM_FIELD_NUMBER

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

Static Methods

getDefaultInstance()

public static Distribution getDefaultInstance()
Returns
TypeDescription
Distribution

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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

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>

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 samples in each histogram bucket. bucket_counts are optional. If present, they must sum to the count value.

The buckets are defined below in bucket_option. There are N buckets. bucket_counts[0] is the number of samples in the underflow bucket. bucket_counts[1] to bucket_counts[N-1] are the numbers of samples in each of the finite buckets. And bucket_counts[N] is the number of samples in the overflow bucket. See the comments of bucket_option` below for more details.

Any suffix of trailing zeros may be omitted.

repeated int64 bucket_counts = 6;

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 samples in each histogram bucket. bucket_counts are optional. If present, they must sum to the count value.

The buckets are defined below in bucket_option. There are N buckets. bucket_counts[0] is the number of samples in the underflow bucket. bucket_counts[1] to bucket_counts[N-1] are the numbers of samples in each of the finite buckets. And bucket_counts[N] is the number of samples in the overflow bucket. See the comments of bucket_option` below for more details.

Any suffix of trailing zeros may be omitted.

repeated int64 bucket_counts = 6;

Returns
TypeDescription
int

The count of bucketCounts.

getBucketCountsList()

public List<Long> getBucketCountsList()

The number of samples in each histogram bucket. bucket_counts are optional. If present, they must sum to the count value.

The buckets are defined below in bucket_option. There are N buckets. bucket_counts[0] is the number of samples in the underflow bucket. bucket_counts[1] to bucket_counts[N-1] are the numbers of samples in each of the finite buckets. And bucket_counts[N] is the number of samples in the overflow bucket. See the comments of bucket_option` below for more details.

Any suffix of trailing zeros may be omitted.

repeated int64 bucket_counts = 6;

Returns
TypeDescription
List<Long>

A list containing the bucketCounts.

getBucketOptionCase()

public Distribution.BucketOptionCase getBucketOptionCase()
Returns
TypeDescription
Distribution.BucketOptionCase

getCount()

public long getCount()

The total number of samples in the distribution. Must be >= 0.

int64 count = 1;

Returns
TypeDescription
long

The count.

getDefaultInstanceForType()

public Distribution getDefaultInstanceForType()
Returns
TypeDescription
Distribution

getExemplars(int index)

public Distribution.Exemplar getExemplars(int index)

Example points. Must be in increasing order of value field.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
com.google.api.Distribution.Exemplar

getExemplarsCount()

public int getExemplarsCount()

Example points. Must be in increasing order of value field.

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

Returns
TypeDescription
int

getExemplarsList()

public List<Distribution.Exemplar> getExemplarsList()

Example points. Must be in increasing order of value field.

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

Returns
TypeDescription
List<com.google.api.Distribution.Exemplar>

getExemplarsOrBuilder(int index)

public Distribution.ExemplarOrBuilder getExemplarsOrBuilder(int index)

Example points. Must be in increasing order of value field.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
com.google.api.Distribution.ExemplarOrBuilder

getExemplarsOrBuilderList()

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

Example points. Must be in increasing order of value field.

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

Returns
TypeDescription
List<? extends com.google.api.Distribution.ExemplarOrBuilder>

getExplicitBuckets()

public Distribution.ExplicitBuckets getExplicitBuckets()

Buckets with arbitrary user-provided width.

.google.api.servicecontrol.v1.Distribution.ExplicitBuckets explicit_buckets = 9;

Returns
TypeDescription
Distribution.ExplicitBuckets

The explicitBuckets.

getExplicitBucketsOrBuilder()

public Distribution.ExplicitBucketsOrBuilder getExplicitBucketsOrBuilder()

Buckets with arbitrary user-provided width.

.google.api.servicecontrol.v1.Distribution.ExplicitBuckets explicit_buckets = 9;

Returns
TypeDescription
Distribution.ExplicitBucketsOrBuilder

getExponentialBuckets()

public Distribution.ExponentialBuckets getExponentialBuckets()

Buckets with exponentially growing width.

.google.api.servicecontrol.v1.Distribution.ExponentialBuckets exponential_buckets = 8;

Returns
TypeDescription
Distribution.ExponentialBuckets

The exponentialBuckets.

getExponentialBucketsOrBuilder()

public Distribution.ExponentialBucketsOrBuilder getExponentialBucketsOrBuilder()

Buckets with exponentially growing width.

.google.api.servicecontrol.v1.Distribution.ExponentialBuckets exponential_buckets = 8;

Returns
TypeDescription
Distribution.ExponentialBucketsOrBuilder

getLinearBuckets()

public Distribution.LinearBuckets getLinearBuckets()

Buckets with constant width.

.google.api.servicecontrol.v1.Distribution.LinearBuckets linear_buckets = 7;

Returns
TypeDescription
Distribution.LinearBuckets

The linearBuckets.

getLinearBucketsOrBuilder()

public Distribution.LinearBucketsOrBuilder getLinearBucketsOrBuilder()

Buckets with constant width.

.google.api.servicecontrol.v1.Distribution.LinearBuckets linear_buckets = 7;

Returns
TypeDescription
Distribution.LinearBucketsOrBuilder

getMaximum()

public double getMaximum()

The maximum of the population of values. Ignored if count is zero.

double maximum = 4;

Returns
TypeDescription
double

The maximum.

getMean()

public double getMean()

The arithmetic mean of the samples in the distribution. If count is zero then this field must be zero.

double mean = 2;

Returns
TypeDescription
double

The mean.

getMinimum()

public double getMinimum()

The minimum of the population of values. Ignored if count is zero.

double minimum = 3;

Returns
TypeDescription
double

The minimum.

getParserForType()

public Parser<Distribution> getParserForType()
Returns
TypeDescription
Parser<Distribution>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSumOfSquaredDeviation()

public double getSumOfSquaredDeviation()

The sum of squared deviations from the mean: Sumi=1..count^2) where each x_i is a sample values. If count is zero then this field must be zero, otherwise validation of the request fails.

double sum_of_squared_deviation = 5;

Returns
TypeDescription
double

The sumOfSquaredDeviation.

hasExplicitBuckets()

public boolean hasExplicitBuckets()

Buckets with arbitrary user-provided width.

.google.api.servicecontrol.v1.Distribution.ExplicitBuckets explicit_buckets = 9;

Returns
TypeDescription
boolean

Whether the explicitBuckets field is set.

hasExponentialBuckets()

public boolean hasExponentialBuckets()

Buckets with exponentially growing width.

.google.api.servicecontrol.v1.Distribution.ExponentialBuckets exponential_buckets = 8;

Returns
TypeDescription
boolean

Whether the exponentialBuckets field is set.

hasLinearBuckets()

public boolean hasLinearBuckets()

Buckets with constant width.

.google.api.servicecontrol.v1.Distribution.LinearBuckets linear_buckets = 7;

Returns
TypeDescription
boolean

Whether the linearBuckets 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

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

toBuilder()

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

writeTo(CodedOutputStream output)

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