Class Distribution.BucketOptions (2.33.0)

public static final class Distribution.BucketOptions extends GeneratedMessageV3 implements Distribution.BucketOptionsOrBuilder

BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.

A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.

Protobuf type google.api.Distribution.BucketOptions

Static Fields

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

Static Methods

getDefaultInstance()

public static Distribution.BucketOptions getDefaultInstance()
Returns
TypeDescription
Distribution.BucketOptions

getDescriptor()

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

newBuilder()

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

newBuilder(Distribution.BucketOptions prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Distribution.BucketOptions getDefaultInstanceForType()
Returns
TypeDescription
Distribution.BucketOptions

getExplicitBuckets()

public Distribution.BucketOptions.Explicit getExplicitBuckets()

The explicit buckets.

.google.api.Distribution.BucketOptions.Explicit explicit_buckets = 3;

Returns
TypeDescription
Distribution.BucketOptions.Explicit

The explicitBuckets.

getExplicitBucketsOrBuilder()

public Distribution.BucketOptions.ExplicitOrBuilder getExplicitBucketsOrBuilder()

The explicit buckets.

.google.api.Distribution.BucketOptions.Explicit explicit_buckets = 3;

Returns
TypeDescription
Distribution.BucketOptions.ExplicitOrBuilder

getExponentialBuckets()

public Distribution.BucketOptions.Exponential getExponentialBuckets()

The exponential buckets.

.google.api.Distribution.BucketOptions.Exponential exponential_buckets = 2;

Returns
TypeDescription
Distribution.BucketOptions.Exponential

The exponentialBuckets.

getExponentialBucketsOrBuilder()

public Distribution.BucketOptions.ExponentialOrBuilder getExponentialBucketsOrBuilder()

The exponential buckets.

.google.api.Distribution.BucketOptions.Exponential exponential_buckets = 2;

Returns
TypeDescription
Distribution.BucketOptions.ExponentialOrBuilder

getLinearBuckets()

public Distribution.BucketOptions.Linear getLinearBuckets()

The linear bucket.

.google.api.Distribution.BucketOptions.Linear linear_buckets = 1;

Returns
TypeDescription
Distribution.BucketOptions.Linear

The linearBuckets.

getLinearBucketsOrBuilder()

public Distribution.BucketOptions.LinearOrBuilder getLinearBucketsOrBuilder()

The linear bucket.

.google.api.Distribution.BucketOptions.Linear linear_buckets = 1;

Returns
TypeDescription
Distribution.BucketOptions.LinearOrBuilder

getOptionsCase()

public Distribution.BucketOptions.OptionsCase getOptionsCase()
Returns
TypeDescription
Distribution.BucketOptions.OptionsCase

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasExplicitBuckets()

public boolean hasExplicitBuckets()

The explicit buckets.

.google.api.Distribution.BucketOptions.Explicit explicit_buckets = 3;

Returns
TypeDescription
boolean

Whether the explicitBuckets field is set.

hasExponentialBuckets()

public boolean hasExponentialBuckets()

The exponential buckets.

.google.api.Distribution.BucketOptions.Exponential exponential_buckets = 2;

Returns
TypeDescription
boolean

Whether the exponentialBuckets field is set.

hasLinearBuckets()

public boolean hasLinearBuckets()

The linear bucket.

.google.api.Distribution.BucketOptions.Linear linear_buckets = 1;

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.BucketOptions.Builder newBuilderForType()
Returns
TypeDescription
Distribution.BucketOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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