Reference documentation and code samples for the Service Control API V1 API class Google::Cloud::ServiceControl::V1::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
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#bucket_counts
def bucket_counts() -> ::Array<::Integer>
-
(::Array<::Integer>) — The number of samples in each histogram bucket.
bucket_counts
are optional. If present, they must sum to thecount
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]
tobucket_counts[N-1]
are the numbers of samples in each of the finite buckets. Andbucket_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.
#bucket_counts=
def bucket_counts=(value) -> ::Array<::Integer>
-
value (::Array<::Integer>) — The number of samples in each histogram bucket.
bucket_counts
are optional. If present, they must sum to thecount
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]
tobucket_counts[N-1]
are the numbers of samples in each of the finite buckets. Andbucket_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.
-
(::Array<::Integer>) — The number of samples in each histogram bucket.
bucket_counts
are optional. If present, they must sum to thecount
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]
tobucket_counts[N-1]
are the numbers of samples in each of the finite buckets. Andbucket_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.
#count
def count() -> ::Integer
- (::Integer) — The total number of samples in the distribution. Must be >= 0.
#count=
def count=(value) -> ::Integer
- value (::Integer) — The total number of samples in the distribution. Must be >= 0.
- (::Integer) — The total number of samples in the distribution. Must be >= 0.
#exemplars
def exemplars() -> ::Array<::Google::Api::Distribution::Exemplar>
-
(::Array<::Google::Api::Distribution::Exemplar>) — Example points. Must be in increasing order of
value
field.
#exemplars=
def exemplars=(value) -> ::Array<::Google::Api::Distribution::Exemplar>
-
value (::Array<::Google::Api::Distribution::Exemplar>) — Example points. Must be in increasing order of
value
field.
-
(::Array<::Google::Api::Distribution::Exemplar>) — Example points. Must be in increasing order of
value
field.
#explicit_buckets
def explicit_buckets() -> ::Google::Cloud::ServiceControl::V1::Distribution::ExplicitBuckets
- (::Google::Cloud::ServiceControl::V1::Distribution::ExplicitBuckets) — Buckets with arbitrary user-provided width.
#explicit_buckets=
def explicit_buckets=(value) -> ::Google::Cloud::ServiceControl::V1::Distribution::ExplicitBuckets
- value (::Google::Cloud::ServiceControl::V1::Distribution::ExplicitBuckets) — Buckets with arbitrary user-provided width.
- (::Google::Cloud::ServiceControl::V1::Distribution::ExplicitBuckets) — Buckets with arbitrary user-provided width.
#exponential_buckets
def exponential_buckets() -> ::Google::Cloud::ServiceControl::V1::Distribution::ExponentialBuckets
- (::Google::Cloud::ServiceControl::V1::Distribution::ExponentialBuckets) — Buckets with exponentially growing width.
#exponential_buckets=
def exponential_buckets=(value) -> ::Google::Cloud::ServiceControl::V1::Distribution::ExponentialBuckets
- value (::Google::Cloud::ServiceControl::V1::Distribution::ExponentialBuckets) — Buckets with exponentially growing width.
- (::Google::Cloud::ServiceControl::V1::Distribution::ExponentialBuckets) — Buckets with exponentially growing width.
#linear_buckets
def linear_buckets() -> ::Google::Cloud::ServiceControl::V1::Distribution::LinearBuckets
- (::Google::Cloud::ServiceControl::V1::Distribution::LinearBuckets) — Buckets with constant width.
#linear_buckets=
def linear_buckets=(value) -> ::Google::Cloud::ServiceControl::V1::Distribution::LinearBuckets
- value (::Google::Cloud::ServiceControl::V1::Distribution::LinearBuckets) — Buckets with constant width.
- (::Google::Cloud::ServiceControl::V1::Distribution::LinearBuckets) — Buckets with constant width.
#maximum
def maximum() -> ::Float
-
(::Float) — The maximum of the population of values. Ignored if
count
is zero.
#maximum=
def maximum=(value) -> ::Float
-
value (::Float) — The maximum of the population of values. Ignored if
count
is zero.
-
(::Float) — The maximum of the population of values. Ignored if
count
is zero.
#mean
def mean() -> ::Float
-
(::Float) — The arithmetic mean of the samples in the distribution. If
count
is zero then this field must be zero.
#mean=
def mean=(value) -> ::Float
-
value (::Float) — The arithmetic mean of the samples in the distribution. If
count
is zero then this field must be zero.
-
(::Float) — The arithmetic mean of the samples in the distribution. If
count
is zero then this field must be zero.
#minimum
def minimum() -> ::Float
-
(::Float) — The minimum of the population of values. Ignored if
count
is zero.
#minimum=
def minimum=(value) -> ::Float
-
value (::Float) — The minimum of the population of values. Ignored if
count
is zero.
-
(::Float) — The minimum of the population of values. Ignored if
count
is zero.
#sum_of_squared_deviation
def sum_of_squared_deviation() -> ::Float
-
(::Float) — The sum of squared deviations from the mean:
Sumi=1..count
where each x_i is a sample values. If
count
is zero then this field must be zero, otherwise validation of the request fails.
#sum_of_squared_deviation=
def sum_of_squared_deviation=(value) -> ::Float
-
value (::Float) — The sum of squared deviations from the mean:
Sumi=1..count
where each x_i is a sample values. If
count
is zero then this field must be zero, otherwise validation of the request fails.
-
(::Float) — The sum of squared deviations from the mean:
Sumi=1..count
where each x_i is a sample values. If
count
is zero then this field must be zero, otherwise validation of the request fails.