Class Distribution.Types.BucketOptions (2.2.0)

public sealed class BucketOptions : Protobuf.IMessage<Distribution.Types.BucketOptions>, Protobuf.IBufferMessage

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.

Inheritance

Object > Distribution.Types.BucketOptions

Implements

Protobuf.IBufferMessage

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

BucketOptions()

public BucketOptions()

BucketOptions(Distribution.Types.BucketOptions)

public BucketOptions(Distribution.Types.BucketOptions other)

Parameter
Name	Description
`other`	`Distribution.Types.BucketOptions`

Fields

ExplicitBucketsFieldNumber

public const int ExplicitBucketsFieldNumber = 3

Field number for the "explicit_buckets" field.

Field Value
Type	Description
`Int32`

ExponentialBucketsFieldNumber

public const int ExponentialBucketsFieldNumber = 2

Field number for the "exponential_buckets" field.

Field Value
Type	Description
`Int32`

LinearBucketsFieldNumber

public const int LinearBucketsFieldNumber = 1

Field number for the "linear_buckets" field.

Field Value
Type	Description
`Int32`

Properties

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`Protobuf.Reflection.MessageDescriptor`

ExplicitBuckets

public Distribution.Types.BucketOptions.Types.Explicit ExplicitBuckets { get; set; }

The explicit buckets.

Property Value
Type	Description
`Distribution.Types.BucketOptions.Types.Explicit`

ExponentialBuckets

public Distribution.Types.BucketOptions.Types.Exponential ExponentialBuckets { get; set; }

The exponential buckets.

Property Value
Type	Description
`Distribution.Types.BucketOptions.Types.Exponential`

LinearBuckets

public Distribution.Types.BucketOptions.Types.Linear LinearBuckets { get; set; }

The linear bucket.

Property Value
Type	Description
`Distribution.Types.BucketOptions.Types.Linear`

OptionsCase

public Distribution.Types.BucketOptions.OptionsOneofCase OptionsCase { get; }

Property Value
Type	Description
`Distribution.Types.BucketOptions.OptionsOneofCase`

Parser

public static Protobuf.MessageParser<Distribution.Types.BucketOptions> Parser { get; }

Property Value
Type	Description
`Protobuf.MessageParser<Distribution.Types.BucketOptions>`

Methods

CalculateSize()

public int CalculateSize()

Returns
Type	Description
`Int32`

ClearOptions()

public void ClearOptions()

Clone()

public Distribution.Types.BucketOptions Clone()

Returns
Type	Description
`Distribution.Types.BucketOptions`

Equals(Distribution.Types.BucketOptions)

public bool Equals(Distribution.Types.BucketOptions other)

Parameter
Name	Description
`other`	`Distribution.Types.BucketOptions`

Returns
Type	Description
`Boolean`

Equals(Object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`Object`

Returns
Type	Description
`Boolean`

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`Int32`

MergeFrom(Distribution.Types.BucketOptions)

public void MergeFrom(Distribution.Types.BucketOptions other)

Parameter
Name	Description
`other`	`Distribution.Types.BucketOptions`

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)

Parameter
Name	Description
`input`	`Protobuf.CodedInputStream`

ToString()

public override string ToString()

Returns
Type	Description
`String`

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)

Parameter
Name	Description
`output`	`Protobuf.CodedOutputStream`