Class: Google::Apis::MonitoringV3::Distribution
 Inherits:

Object
 Object
 Google::Apis::MonitoringV3::Distribution
 Includes:
 Core::Hashable, Core::JsonObjectSupport
 Defined in:
 generated/google/apis/monitoring_v3/classes.rb,
generated/google/apis/monitoring_v3/representations.rb,
generated/google/apis/monitoring_v3/representations.rb
Overview
Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values.The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).Although it is not forbidden, it is generally a bad idea to include nonfinite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.
Instance Attribute Summary collapse

#bucket_counts ⇒ Array<String>
If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count.

#bucket_options ⇒ Google::Apis::MonitoringV3::BucketOptions
A Distribution may optionally contain a histogram of the values in the population.

#count ⇒ String
The number of values in the population.

#mean ⇒ Float
The arithmetic mean of the values in the population.

#range ⇒ Google::Apis::MonitoringV3::Range
The range of the population values.

#sum_of_squared_deviation ⇒ Float
The sum of squared deviations from the mean of the values in the population.
Instance Method Summary collapse

#initialize(**args) ⇒ Distribution
constructor
A new instance of Distribution.

#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Distribution
Returns a new instance of Distribution.
726 727 728 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 726 def initialize(**args) update!(**args) end 
Instance Attribute Details
#bucket_counts ⇒ Array<String>
If bucket_options is given, then the sum of the values in bucket_counts must
equal the value in count. If bucket_options is not given, no bucket_counts
fields may be given.Bucket counts are given in order under the numbering
scheme described above (the underflow bucket has number 0; the finite buckets,
if any, have numbers 1 through N2; the overflow bucket has number N1).The
size of bucket_counts must be no greater than N as defined in bucket_options.
Any suffix of trailing zero bucket_count fields may be omitted.
Corresponds to the JSON property bucketCounts
677 678 679 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 677 def bucket_counts @bucket_counts end 
#bucket_options ⇒ Google::Apis::MonitoringV3::BucketOptions
A Distribution may optionally contain a histogram of the values in the
population. The histogram is given in bucket_counts as counts of values that
fall into one of a sequence of nonoverlapping buckets. The sequence of
buckets is described by bucket_options.A bucket specifies an inclusive lower
bound and exclusive upper bound for the values that are counted for that
bucket. The upper bound of a bucket is 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 socalled because both bounds are finite.BucketOptions
describes bucket boundaries in one of three ways. Two describe the boundaries
by giving parameters for a formula to generate boundaries and one gives the
bucket boundaries explicitly.If bucket_options is not given, then no
bucket_counts may be given.
Corresponds to the JSON property bucketOptions
698 699 700 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 698 def @bucket_options end 
#count ⇒ String
The number of values in the population. Must be nonnegative.
Corresponds to the JSON property count
703 704 705 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 703 def count @count end 
#mean ⇒ Float
The arithmetic mean of the values in the population. If count is zero then
this field must be zero.
Corresponds to the JSON property mean
719 720 721 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 719 def mean @mean end 
#range ⇒ Google::Apis::MonitoringV3::Range
The range of the population values.
Corresponds to the JSON property range
724 725 726 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 724 def range @range end 
#sum_of_squared_deviation ⇒ Float
The sum of squared deviations from the mean of the values in the population.
For values x_i this is:
Sumi=1..n
Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
describes Welford's method for accumulating this sum in one pass.If count is
zero then this field must be zero.
Corresponds to the JSON property sumOfSquaredDeviation
713 714 715 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 713 def sum_of_squared_deviation @sum_of_squared_deviation end 
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
731 732 733 734 735 736 737 738 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 731 def update!(**args) @bucket_counts = args[:bucket_counts] if args.key?(:bucket_counts) @bucket_options = args[:bucket_options] if args.key?(:bucket_options) @count = args[:count] if args.key?(:count) @sum_of_squared_deviation = args[:sum_of_squared_deviation] if args.key?(:sum_of_squared_deviation) @mean = args[:mean] if args.key?(:mean) @range = args[:range] if args.key?(:range) end 