Google Cloud Service Control V1 Client - Class Distribution (2.0.2)

Reference documentation and code samples for the Google Cloud Service Control V1 Client class Distribution.

Distribution represents a frequency distribution of double-valued sample points. It contains the size of the population of sample points plus additional optional information:

the arithmetic mean of the samples
the minimum and maximum of the samples
the sum-squared-deviation of the samples, used to compute variance
a histogram of the values of the sample points

Generated from protobuf message google.api.servicecontrol.v1.Distribution

Namespace

Google \ Cloud \ ServiceControl \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ count`	`int\|string` The total number of samples in the distribution. Must be >= 0.
`↳ mean`	`float` The arithmetic mean of the samples in the distribution. If `count` is zero then this field must be zero.
`↳ minimum`	`float` The minimum of the population of values. Ignored if `count` is zero.
`↳ maximum`	`float` The maximum of the population of values. Ignored if `count` is zero.
`↳ sum_of_squared_deviation`	`float` The sum of squared deviations from the mean: Sum[i=1..count]((x_i - mean)^2) where each x_i is a sample values. If `count` is zero then this field must be zero, otherwise validation of the request fails.
`↳ bucket_counts`	`array` The number of samples in each histogram bucket. `bucket_counts` are optional. If present, they must sum to the `count` value. The buckets are defined below in `bucket_option`. There are N buckets. `bucket_counts[0]` is the number of samples in the underflow bucket. `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in each of the finite buckets. And `bucket_counts[N] is the number of samples in the overflow bucket. See the comments of`bucket_option` below for more details. Any suffix of trailing zeros may be omitted.
`↳ linear_buckets`	`Distribution\LinearBuckets` Buckets with constant width.
`↳ exponential_buckets`	`Distribution\ExponentialBuckets` Buckets with exponentially growing width.
`↳ explicit_buckets`	`Distribution\ExplicitBuckets` Buckets with arbitrary user-provided width.
`↳ exemplars`	`array<Google\Api\Distribution\Exemplar>` Example points. Must be in increasing order of `value` field.

getCount

The total number of samples in the distribution. Must be >= 0.

Returns
Type	Description
`int\|string`

setCount

The total number of samples in the distribution. Must be >= 0.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getMean

The arithmetic mean of the samples in the distribution. If count is zero then this field must be zero.

Returns
Type	Description
`float`

setMean

The arithmetic mean of the samples in the distribution. If count is zero then this field must be zero.

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getMinimum

The minimum of the population of values. Ignored if count is zero.

Returns
Type	Description
`float`

setMinimum

The minimum of the population of values. Ignored if count is zero.

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getMaximum

The maximum of the population of values. Ignored if count is zero.

Returns
Type	Description
`float`

setMaximum

The maximum of the population of values. Ignored if count is zero.

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getSumOfSquaredDeviation

The sum of squared deviations from the mean: Sum[i=1..count]((x_i - mean)^2) where each x_i is a sample values. If count is zero then this field must be zero, otherwise validation of the request fails.

Returns
Type	Description
`float`

setSumOfSquaredDeviation

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getBucketCounts

The number of samples in each histogram bucket. bucket_counts are optional. If present, they must sum to the count value.

The buckets are defined below in bucket_option. There are N buckets. bucket_counts[0] is the number of samples in the underflow bucket. bucket_counts[1] to bucket_counts[N-1] are the numbers of samples in each of the finite buckets. And bucket_counts[N] is the number of samples in the overflow bucket. See the comments ofbucket_option` below for more details. Any suffix of trailing zeros may be omitted.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setBucketCounts

The number of samples in each histogram bucket. bucket_counts are optional. If present, they must sum to the count value.

Parameter
Name	Description
`var`	`int[]\|string[]\|Google\Protobuf\Internal\RepeatedField`

Returns
Type	Description
`$this`

getLinearBuckets

Buckets with constant width.

Returns
Type	Description
`Distribution\LinearBuckets\|null`

hasLinearBuckets

setLinearBuckets

Buckets with constant width.

Parameter
Name	Description
`var`	`Distribution\LinearBuckets`

Returns
Type	Description
`$this`

getExponentialBuckets

Buckets with exponentially growing width.

Returns
Type	Description
`Distribution\ExponentialBuckets\|null`

hasExponentialBuckets

setExponentialBuckets

Buckets with exponentially growing width.

Parameter
Name	Description
`var`	`Distribution\ExponentialBuckets`

Returns
Type	Description
`$this`

getExplicitBuckets

Buckets with arbitrary user-provided width.

Returns
Type	Description
`Distribution\ExplicitBuckets\|null`

hasExplicitBuckets

setExplicitBuckets

Buckets with arbitrary user-provided width.

Parameter
Name	Description
`var`	`Distribution\ExplicitBuckets`

Returns
Type	Description
`$this`

getExemplars

Example points. Must be in increasing order of value field.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setExemplars

Example points. Must be in increasing order of value field.

Parameter
Name	Description
`var`	`array<Google\Api\Distribution\Exemplar>`

Returns
Type	Description
`$this`

getBucketOption

Returns
Type	Description
`string`