1. class
  2. Google
  3. \
  4. Api
  5. \
  6. Distribution
  7. \
  8. BucketOptions

BucketOptions

class BucketOptions extends Message

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.

Generated from protobuf message google.api.Distribution.BucketOptions

Properties

protected $options

Methods

__construct(array $data = NULL)

Constructor.

Linear
getLinearBuckets()

The linear bucket.

$this
setLinearBuckets(Linear $var)

The linear bucket.

Exponential
getExponentialBuckets()

The exponential buckets.

$this
setExponentialBuckets(Exponential $var)

The exponential buckets.

Explicit
getExplicitBuckets()

The explicit buckets.

$this
setExplicitBuckets(Explicit $var)

The explicit buckets.

string
getOptions()

No description

Details

at line 47
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type \Google\Api\Distribution\BucketOptions\Linear $linear_buckets
      The linear bucket.
@type \Google\Api\Distribution\BucketOptions\Exponential $exponential_buckets
      The exponential buckets.
@type \Google\Api\Distribution\BucketOptions\Explicit $explicit_buckets
      The explicit buckets.

}

at line 58
Linear getLinearBuckets()

The linear bucket.

Generated from protobuf field .google.api.Distribution.BucketOptions.Linear linear_buckets = 1;

Return Value

Linear

at line 70
$this setLinearBuckets(Linear $var)

The linear bucket.

Generated from protobuf field .google.api.Distribution.BucketOptions.Linear linear_buckets = 1;

Parameters

Linear $var

Return Value

$this

at line 84
Exponential getExponentialBuckets()

The exponential buckets.

Generated from protobuf field .google.api.Distribution.BucketOptions.Exponential exponential_buckets = 2;

Return Value

Exponential

at line 96
$this setExponentialBuckets(Exponential $var)

The exponential buckets.

Generated from protobuf field .google.api.Distribution.BucketOptions.Exponential exponential_buckets = 2;

Parameters

Exponential $var

Return Value

$this

at line 110
Explicit getExplicitBuckets()

The explicit buckets.

Generated from protobuf field .google.api.Distribution.BucketOptions.Explicit explicit_buckets = 3;

Return Value

Explicit

at line 122
$this setExplicitBuckets(Explicit $var)

The explicit buckets.

Generated from protobuf field .google.api.Distribution.BucketOptions.Explicit explicit_buckets = 3;

Parameters

Explicit $var

Return Value

$this

at line 133
string getOptions()

Return Value

string