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
COUNT_FIELD_NUMBER
public static final int COUNT_FIELD_NUMBER
Field Value
EXEMPLARS_FIELD_NUMBER
public static final int EXEMPLARS_FIELD_NUMBER
Field Value
EXPLICIT_BUCKETS_FIELD_NUMBER
public static final int EXPLICIT_BUCKETS_FIELD_NUMBER
Field Value
EXPONENTIAL_BUCKETS_FIELD_NUMBER
public static final int EXPONENTIAL_BUCKETS_FIELD_NUMBER
Field Value
LINEAR_BUCKETS_FIELD_NUMBER
public static final int LINEAR_BUCKETS_FIELD_NUMBER
Field Value
MAXIMUM_FIELD_NUMBER
public static final int MAXIMUM_FIELD_NUMBER
Field Value
MEAN_FIELD_NUMBER
public static final int MEAN_FIELD_NUMBER
Field Value
MINIMUM_FIELD_NUMBER
public static final int MINIMUM_FIELD_NUMBER
Field Value
SUM_OF_SQUARED_DEVIATION_FIELD_NUMBER
public static final int SUM_OF_SQUARED_DEVIATION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Distribution getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Distribution.Builder newBuilder()
Returns
newBuilder(Distribution prototype)
public static Distribution.Builder newBuilder(Distribution prototype)
Parameter
Returns
public static Distribution parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Distribution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Distribution parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Distribution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Distribution parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Distribution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Distribution parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Distribution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Distribution parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Distribution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Distribution parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Distribution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Distribution> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
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 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
Type | Description |
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
Type | Description |
List<Long> | A list containing the bucketCounts.
|
getBucketOptionCase()
public Distribution.BucketOptionCase getBucketOptionCase()
Returns
getCount()
The total number of samples in the distribution. Must be >= 0.
int64 count = 1;
Returns
Type | Description |
long | The count.
|
getDefaultInstanceForType()
public Distribution getDefaultInstanceForType()
Returns
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
Returns
Type | Description |
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
getExemplarsList()
public List<Distribution.Exemplar> getExemplarsList()
Example points. Must be in increasing order of value
field.
repeated .google.api.Distribution.Exemplar exemplars = 10;
Returns
Type | Description |
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
Returns
Type | Description |
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
Type | Description |
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
getExplicitBucketsOrBuilder()
public Distribution.ExplicitBucketsOrBuilder getExplicitBucketsOrBuilder()
Buckets with arbitrary user-provided width.
.google.api.servicecontrol.v1.Distribution.ExplicitBuckets explicit_buckets = 9;
Returns
getExponentialBuckets()
public Distribution.ExponentialBuckets getExponentialBuckets()
Buckets with exponentially growing width.
.google.api.servicecontrol.v1.Distribution.ExponentialBuckets exponential_buckets = 8;
Returns
getExponentialBucketsOrBuilder()
public Distribution.ExponentialBucketsOrBuilder getExponentialBucketsOrBuilder()
Buckets with exponentially growing width.
.google.api.servicecontrol.v1.Distribution.ExponentialBuckets exponential_buckets = 8;
Returns
getLinearBuckets()
public Distribution.LinearBuckets getLinearBuckets()
Buckets with constant width.
.google.api.servicecontrol.v1.Distribution.LinearBuckets linear_buckets = 7;
Returns
getLinearBucketsOrBuilder()
public Distribution.LinearBucketsOrBuilder getLinearBucketsOrBuilder()
Buckets with constant width.
.google.api.servicecontrol.v1.Distribution.LinearBuckets linear_buckets = 7;
Returns
getMaximum()
public double getMaximum()
The maximum of the population of values. Ignored if count
is zero.
double maximum = 4;
Returns
Type | Description |
double | The maximum.
|
getMean()
The arithmetic mean of the samples in the distribution. If count
is
zero then this field must be zero.
double mean = 2;
Returns
Type | Description |
double | The mean.
|
getMinimum()
public double getMinimum()
The minimum of the population of values. Ignored if count
is zero.
double minimum = 3;
Returns
Type | Description |
double | The minimum.
|
getParserForType()
public Parser<Distribution> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
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
Type | Description |
double | The sumOfSquaredDeviation.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasExplicitBuckets()
public boolean hasExplicitBuckets()
Buckets with arbitrary user-provided width.
.google.api.servicecontrol.v1.Distribution.ExplicitBuckets explicit_buckets = 9;
Returns
Type | Description |
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
Type | Description |
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
Type | Description |
boolean | Whether the linearBuckets field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Distribution.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Distribution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Distribution.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions