GoogleApi.Monitoring.V3.Model.Distribution (google_api_monitoring v0.46.3) View Source

Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of 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 formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.

Attributes

  • bucketCounts (type: list(String.t), default: nil) - Required in the Cloud Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.
  • bucketOptions (type: GoogleApi.Monitoring.V3.Model.BucketOptions.t, default: nil) - Required in the Cloud Monitoring API v3. Defines the histogram bucket boundaries.
  • count (type: String.t, default: nil) - The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided.
  • exemplars (type: list(GoogleApi.Monitoring.V3.Model.Exemplar.t), default: nil) - Must be in increasing order of value field.
  • mean (type: float(), default: nil) - The arithmetic mean of the values in the population. If count is zero then this field must be zero.
  • range (type: GoogleApi.Monitoring.V3.Model.Range.t, default: nil) - If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Cloud Monitoring API v3.
  • sumOfSquaredDeviation (type: float(), default: nil) - 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 232, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Monitoring.V3.Model.Distribution{
  bucketCounts: [String.t()] | nil,
  bucketOptions: GoogleApi.Monitoring.V3.Model.BucketOptions.t() | nil,
  count: String.t() | nil,
  exemplars: [GoogleApi.Monitoring.V3.Model.Exemplar.t()] | nil,
  mean: float() | nil,
  range: GoogleApi.Monitoring.V3.Model.Range.t() | nil,
  sumOfSquaredDeviation: float() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.