Class Distribution.BucketOptions.Builder (2.42.0)

public static final class Distribution.BucketOptions.Builder extends GeneratedMessageV3.Builder<Distribution.BucketOptions.Builder> 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 Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Distribution.BucketOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Distribution.BucketOptions.Builder
Overrides

build()

public Distribution.BucketOptions build()
Returns
Type Description
Distribution.BucketOptions

buildPartial()

public Distribution.BucketOptions buildPartial()
Returns
Type Description
Distribution.BucketOptions

clear()

public Distribution.BucketOptions.Builder clear()
Returns
Type Description
Distribution.BucketOptions.Builder
Overrides

clearExplicitBuckets()

public Distribution.BucketOptions.Builder clearExplicitBuckets()

The explicit buckets.

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

Returns
Type Description
Distribution.BucketOptions.Builder

clearExponentialBuckets()

public Distribution.BucketOptions.Builder clearExponentialBuckets()

The exponential buckets.

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

Returns
Type Description
Distribution.BucketOptions.Builder

clearField(Descriptors.FieldDescriptor field)

public Distribution.BucketOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Distribution.BucketOptions.Builder
Overrides

clearLinearBuckets()

public Distribution.BucketOptions.Builder clearLinearBuckets()

The linear bucket.

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

Returns
Type Description
Distribution.BucketOptions.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Distribution.BucketOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Distribution.BucketOptions.Builder
Overrides

clearOptions()

public Distribution.BucketOptions.Builder clearOptions()
Returns
Type Description
Distribution.BucketOptions.Builder

clone()

public Distribution.BucketOptions.Builder clone()
Returns
Type Description
Distribution.BucketOptions.Builder
Overrides

getDefaultInstanceForType()

public Distribution.BucketOptions getDefaultInstanceForType()
Returns
Type Description
Distribution.BucketOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExplicitBuckets()

public Distribution.BucketOptions.Explicit getExplicitBuckets()

The explicit buckets.

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

Returns
Type Description
Distribution.BucketOptions.Explicit

The explicitBuckets.

getExplicitBucketsBuilder()

public Distribution.BucketOptions.Explicit.Builder getExplicitBucketsBuilder()

The explicit buckets.

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

Returns
Type Description
Distribution.BucketOptions.Explicit.Builder

getExplicitBucketsOrBuilder()

public Distribution.BucketOptions.ExplicitOrBuilder getExplicitBucketsOrBuilder()

The explicit buckets.

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

Returns
Type Description
Distribution.BucketOptions.ExplicitOrBuilder

getExponentialBuckets()

public Distribution.BucketOptions.Exponential getExponentialBuckets()

The exponential buckets.

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

Returns
Type Description
Distribution.BucketOptions.Exponential

The exponentialBuckets.

getExponentialBucketsBuilder()

public Distribution.BucketOptions.Exponential.Builder getExponentialBucketsBuilder()

The exponential buckets.

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

Returns
Type Description
Distribution.BucketOptions.Exponential.Builder

getExponentialBucketsOrBuilder()

public Distribution.BucketOptions.ExponentialOrBuilder getExponentialBucketsOrBuilder()

The exponential buckets.

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

Returns
Type Description
Distribution.BucketOptions.ExponentialOrBuilder

getLinearBuckets()

public Distribution.BucketOptions.Linear getLinearBuckets()

The linear bucket.

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

Returns
Type Description
Distribution.BucketOptions.Linear

The linearBuckets.

getLinearBucketsBuilder()

public Distribution.BucketOptions.Linear.Builder getLinearBucketsBuilder()

The linear bucket.

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

Returns
Type Description
Distribution.BucketOptions.Linear.Builder

getLinearBucketsOrBuilder()

public Distribution.BucketOptions.LinearOrBuilder getLinearBucketsOrBuilder()

The linear bucket.

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

Returns
Type Description
Distribution.BucketOptions.LinearOrBuilder

getOptionsCase()

public Distribution.BucketOptions.OptionsCase getOptionsCase()
Returns
Type Description
Distribution.BucketOptions.OptionsCase

hasExplicitBuckets()

public boolean hasExplicitBuckets()

The explicit buckets.

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

Returns
Type Description
boolean

Whether the explicitBuckets field is set.

hasExponentialBuckets()

public boolean hasExponentialBuckets()

The exponential buckets.

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

Returns
Type Description
boolean

Whether the exponentialBuckets field is set.

hasLinearBuckets()

public boolean hasLinearBuckets()

The linear bucket.

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

Returns
Type Description
boolean

Whether the linearBuckets field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeExplicitBuckets(Distribution.BucketOptions.Explicit value)

public Distribution.BucketOptions.Builder mergeExplicitBuckets(Distribution.BucketOptions.Explicit value)

The explicit buckets.

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

Parameter
Name Description
value Distribution.BucketOptions.Explicit
Returns
Type Description
Distribution.BucketOptions.Builder

mergeExponentialBuckets(Distribution.BucketOptions.Exponential value)

public Distribution.BucketOptions.Builder mergeExponentialBuckets(Distribution.BucketOptions.Exponential value)

The exponential buckets.

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

Parameter
Name Description
value Distribution.BucketOptions.Exponential
Returns
Type Description
Distribution.BucketOptions.Builder

mergeFrom(Distribution.BucketOptions other)

public Distribution.BucketOptions.Builder mergeFrom(Distribution.BucketOptions other)
Parameter
Name Description
other Distribution.BucketOptions
Returns
Type Description
Distribution.BucketOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Distribution.BucketOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution.BucketOptions.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Distribution.BucketOptions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Distribution.BucketOptions.Builder
Overrides

mergeLinearBuckets(Distribution.BucketOptions.Linear value)

public Distribution.BucketOptions.Builder mergeLinearBuckets(Distribution.BucketOptions.Linear value)

The linear bucket.

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

Parameter
Name Description
value Distribution.BucketOptions.Linear
Returns
Type Description
Distribution.BucketOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Distribution.BucketOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Distribution.BucketOptions.Builder
Overrides

setExplicitBuckets(Distribution.BucketOptions.Explicit value)

public Distribution.BucketOptions.Builder setExplicitBuckets(Distribution.BucketOptions.Explicit value)

The explicit buckets.

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

Parameter
Name Description
value Distribution.BucketOptions.Explicit
Returns
Type Description
Distribution.BucketOptions.Builder

setExplicitBuckets(Distribution.BucketOptions.Explicit.Builder builderForValue)

public Distribution.BucketOptions.Builder setExplicitBuckets(Distribution.BucketOptions.Explicit.Builder builderForValue)

The explicit buckets.

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

Parameter
Name Description
builderForValue Distribution.BucketOptions.Explicit.Builder
Returns
Type Description
Distribution.BucketOptions.Builder

setExponentialBuckets(Distribution.BucketOptions.Exponential value)

public Distribution.BucketOptions.Builder setExponentialBuckets(Distribution.BucketOptions.Exponential value)

The exponential buckets.

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

Parameter
Name Description
value Distribution.BucketOptions.Exponential
Returns
Type Description
Distribution.BucketOptions.Builder

setExponentialBuckets(Distribution.BucketOptions.Exponential.Builder builderForValue)

public Distribution.BucketOptions.Builder setExponentialBuckets(Distribution.BucketOptions.Exponential.Builder builderForValue)

The exponential buckets.

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

Parameter
Name Description
builderForValue Distribution.BucketOptions.Exponential.Builder
Returns
Type Description
Distribution.BucketOptions.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Distribution.BucketOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Distribution.BucketOptions.Builder
Overrides

setLinearBuckets(Distribution.BucketOptions.Linear value)

public Distribution.BucketOptions.Builder setLinearBuckets(Distribution.BucketOptions.Linear value)

The linear bucket.

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

Parameter
Name Description
value Distribution.BucketOptions.Linear
Returns
Type Description
Distribution.BucketOptions.Builder

setLinearBuckets(Distribution.BucketOptions.Linear.Builder builderForValue)

public Distribution.BucketOptions.Builder setLinearBuckets(Distribution.BucketOptions.Linear.Builder builderForValue)

The linear bucket.

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

Parameter
Name Description
builderForValue Distribution.BucketOptions.Linear.Builder
Returns
Type Description
Distribution.BucketOptions.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Distribution.BucketOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Distribution.BucketOptions.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Distribution.BucketOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Distribution.BucketOptions.Builder
Overrides