Class: Google::Apis::ServicecontrolV1::Distribution

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/servicecontrol_v1/classes.rb,
generated/google/apis/servicecontrol_v1/representations.rb,
generated/google/apis/servicecontrol_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Distribution

Returns a new instance of Distribution.



792
793
794
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 792

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bucket_counts ⇒ Array<Fixnum>

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. Corresponds to the JSON propertybucketCounts`

Returns:

  • (Array<Fixnum>) 


741
742
743
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 741

def bucket_counts
  @bucket_counts
end

#count ⇒ Fixnum

The total number of samples in the distribution. Must be >= 0. Corresponds to the JSON property count

Returns:

  • (Fixnum) 


746
747
748
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 746

def count
  @count
end

#exemplars ⇒ Array<Google::Apis::ServicecontrolV1::Exemplar>

Example points. Must be in increasing order of value field. Corresponds to the JSON property exemplars

Returns:



751
752
753
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 751

def exemplars
  @exemplars
end

#explicit_buckets ⇒ Google::Apis::ServicecontrolV1::ExplicitBuckets

Describing buckets with arbitrary user-provided width. Corresponds to the JSON property explicitBuckets

Returns:



756
757
758
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 756

def explicit_buckets
  @explicit_buckets
end

#exponential_buckets ⇒ Google::Apis::ServicecontrolV1::ExponentialBuckets

Describing buckets with exponentially growing width. Corresponds to the JSON property exponentialBuckets

Returns:



761
762
763
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 761

def exponential_buckets
  @exponential_buckets
end

#linear_buckets ⇒ Google::Apis::ServicecontrolV1::LinearBuckets

Describing buckets with constant width. Corresponds to the JSON property linearBuckets

Returns:



766
767
768
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 766

def linear_buckets
  @linear_buckets
end

#maximum ⇒ Float

The maximum of the population of values. Ignored if count is zero. Corresponds to the JSON property maximum

Returns:

  • (Float) 


771
772
773
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 771

def maximum
  @maximum
end

#mean ⇒ Float

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

Returns:

  • (Float) 


777
778
779
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 777

def mean
  @mean
end

#minimum ⇒ Float

The minimum of the population of values. Ignored if count is zero. Corresponds to the JSON property minimum

Returns:

  • (Float) 


782
783
784
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 782

def minimum
  @minimum
end

#sum_of_squared_deviation ⇒ 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. Corresponds to the JSON property sumOfSquaredDeviation

Returns:

  • (Float) 


790
791
792
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 790

def sum_of_squared_deviation
  @sum_of_squared_deviation
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 797

def update!(**args)
  @bucket_counts = args[:bucket_counts] if args.key?(:bucket_counts)
  @count = args[:count] if args.key?(:count)
  @exemplars = args[:exemplars] if args.key?(:exemplars)
  @explicit_buckets = args[:explicit_buckets] if args.key?(:explicit_buckets)
  @exponential_buckets = args[:exponential_buckets] if args.key?(:exponential_buckets)
  @linear_buckets = args[:linear_buckets] if args.key?(:linear_buckets)
  @maximum = args[:maximum] if args.key?(:maximum)
  @mean = args[:mean] if args.key?(:mean)
  @minimum = args[:minimum] if args.key?(:minimum)
  @sum_of_squared_deviation = args[:sum_of_squared_deviation] if args.key?(:sum_of_squared_deviation)
end