Reference documentation and code samples for the Google API Common Protos Client class 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.
Generated from protobuf message google.api.Distribution.BucketOptions
Namespace
Google \ Api \ DistributionMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ linear_buckets |
Google\Api\Distribution\BucketOptions\Linear
The linear bucket. |
↳ exponential_buckets |
Google\Api\Distribution\BucketOptions\Exponential
The exponential buckets. |
↳ explicit_buckets |
Google\Api\Distribution\BucketOptions\Explicit
The explicit buckets. |
getLinearBuckets
The linear bucket.
| Returns | |
|---|---|
| Type | Description |
Google\Api\Distribution\BucketOptions\Linear|null |
|
hasLinearBuckets
setLinearBuckets
The linear bucket.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Api\Distribution\BucketOptions\Linear
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExponentialBuckets
The exponential buckets.
| Returns | |
|---|---|
| Type | Description |
Google\Api\Distribution\BucketOptions\Exponential|null |
|
hasExponentialBuckets
setExponentialBuckets
The exponential buckets.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Api\Distribution\BucketOptions\Exponential
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExplicitBuckets
The explicit buckets.
| Returns | |
|---|---|
| Type | Description |
Google\Api\Distribution\BucketOptions\Explicit|null |
|
hasExplicitBuckets
setExplicitBuckets
The explicit buckets.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Api\Distribution\BucketOptions\Explicit
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOptions
| Returns | |
|---|---|
| Type | Description |
string |
|