Service Control API V1 API - Class Google::Api::Distribution::BucketOptions (v1.4.1)

Reference documentation and code samples for the Service Control API V1 API class Google::Api::Distribution::BucketOptions.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#explicit_buckets

defexplicit_buckets()->::Google::Api::Distribution::BucketOptions::Explicit
Returns
  • (::Google::Api::Distribution::BucketOptions::Explicit) — The explicit buckets.

    Note: The following fields are mutually exclusive: explicit_buckets, linear_buckets, exponential_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.

#explicit_buckets=

defexplicit_buckets=(value)->::Google::Api::Distribution::BucketOptions::Explicit
Parameter
  • value (::Google::Api::Distribution::BucketOptions::Explicit) — The explicit buckets.

    Note: The following fields are mutually exclusive: explicit_buckets, linear_buckets, exponential_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Api::Distribution::BucketOptions::Explicit) — The explicit buckets.

    Note: The following fields are mutually exclusive: explicit_buckets, linear_buckets, exponential_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.

#exponential_buckets

defexponential_buckets()->::Google::Api::Distribution::BucketOptions::Exponential
Returns
  • (::Google::Api::Distribution::BucketOptions::Exponential) — The exponential buckets.

    Note: The following fields are mutually exclusive: exponential_buckets, linear_buckets, explicit_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.

#exponential_buckets=

defexponential_buckets=(value)->::Google::Api::Distribution::BucketOptions::Exponential
Parameter
  • value (::Google::Api::Distribution::BucketOptions::Exponential) — The exponential buckets.

    Note: The following fields are mutually exclusive: exponential_buckets, linear_buckets, explicit_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Api::Distribution::BucketOptions::Exponential) — The exponential buckets.

    Note: The following fields are mutually exclusive: exponential_buckets, linear_buckets, explicit_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.

#linear_buckets

deflinear_buckets()->::Google::Api::Distribution::BucketOptions::Linear
Returns
  • (::Google::Api::Distribution::BucketOptions::Linear) — The linear bucket.

    Note: The following fields are mutually exclusive: linear_buckets, exponential_buckets, explicit_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.

#linear_buckets=

deflinear_buckets=(value)->::Google::Api::Distribution::BucketOptions::Linear
Parameter
  • value (::Google::Api::Distribution::BucketOptions::Linear) — The linear bucket.

    Note: The following fields are mutually exclusive: linear_buckets, exponential_buckets, explicit_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Api::Distribution::BucketOptions::Linear) — The linear bucket.

    Note: The following fields are mutually exclusive: linear_buckets, exponential_buckets, explicit_buckets. If a field in that set is populated, all other fields in the set will automatically be cleared.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.