Class Distribution.Types.BucketOptions (2.15.0)

Version latest

• 2.15.0 (latest)
• 2.10.0
• 2.2.0

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

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

IMessageDistributionTypesBucketOptions, IEquatableDistributionTypesBucketOptions, IDeepCloneableDistributionTypesBucketOptions, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

BucketOptions()

public BucketOptions()

BucketOptions(BucketOptions)

public BucketOptions(Distribution.Types.BucketOptions other)

Parameter
Name	Description
other	DistributionTypesBucketOptions

Fields

ExplicitBucketsFieldNumber

public const int ExplicitBucketsFieldNumber = 3

Field number for the "explicit_buckets" field.

Field Value
Type	Description
int

ExponentialBucketsFieldNumber

public const int ExponentialBucketsFieldNumber = 2

Field number for the "exponential_buckets" field.

Field Value
Type	Description
int

LinearBucketsFieldNumber

public const int LinearBucketsFieldNumber = 1

Field number for the "linear_buckets" field.

Field Value
Type	Description
int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
MessageDescriptor

ExplicitBuckets

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

The explicit buckets.

Property Value
Type	Description
DistributionTypesBucketOptionsTypesExplicit

ExponentialBuckets

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

The exponential buckets.

Property Value
Type	Description
DistributionTypesBucketOptionsTypesExponential

LinearBuckets

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

The linear bucket.

Property Value
Type	Description
DistributionTypesBucketOptionsTypesLinear

OptionsCase

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

Property Value
Type	Description
DistributionTypesBucketOptionsOptionsOneofCase

Parser

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

Property Value
Type	Description
MessageParserDistributionTypesBucketOptions

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type	Description
int	The number of bytes required to write this message to a coded output stream.

ClearOptions()

public void ClearOptions()

Clone()

public Distribution.Types.BucketOptions Clone()

Creates a deep clone of this object.

Returns
Type	Description
DistributionTypesBucketOptions	A deep clone of this object.

Equals(BucketOptions)

public bool Equals(Distribution.Types.BucketOptions other)

Parameter
Name	Description
other	DistributionTypesBucketOptions

Returns
Type	Description
bool

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
other	object

Returns
Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
int

Overrides

object.GetHashCode()

MergeFrom(BucketOptions)

public void MergeFrom(Distribution.Types.BucketOptions other)

Merges the given message into this one.

Parameter
Name	Description
other	DistributionTypesBucketOptions

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name	Description
input	CodedInputStream

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns
Type	Description
string

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name	Description
output	CodedOutputStream Coded output stream to write the data to. Must not be null.