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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Distribution.BucketOptionsImplements
Distribution.BucketOptionsOrBuilderStatic Fields
EXPLICIT_BUCKETS_FIELD_NUMBER
public static final int EXPLICIT_BUCKETS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
EXPONENTIAL_BUCKETS_FIELD_NUMBER
public static final int EXPONENTIAL_BUCKETS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LINEAR_BUCKETS_FIELD_NUMBER
public static final int LINEAR_BUCKETS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static Distribution.BucketOptions getDefaultInstance()
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static Distribution.BucketOptions.Builder newBuilder()
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions.Builder |
newBuilder(Distribution.BucketOptions prototype)
public static Distribution.BucketOptions.Builder newBuilder(Distribution.BucketOptions prototype)
Parameter | |
---|---|
Name | Description |
prototype |
Distribution.BucketOptions |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions.Builder |
parseDelimitedFrom(InputStream input)
public static Distribution.BucketOptions parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Distribution.BucketOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static Distribution.BucketOptions parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Distribution.BucketOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Distribution.BucketOptions parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Distribution.BucketOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Distribution.BucketOptions parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Distribution.BucketOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static Distribution.BucketOptions parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Distribution.BucketOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static Distribution.BucketOptions parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Distribution.BucketOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<Distribution.BucketOptions> parser()
Returns | |
---|---|
Type | Description |
Parser<BucketOptions> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public Distribution.BucketOptions getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions |
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. |
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. |
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. |
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 |
getParserForType()
public Parser<Distribution.BucketOptions> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<BucketOptions> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public Distribution.BucketOptions.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Distribution.BucketOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public Distribution.BucketOptions.Builder toBuilder()
Returns | |
---|---|
Type | Description |
Distribution.BucketOptions.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |