class OCI::Opsi::Models::SummaryStatistics

Contains common summary statistics.

Attributes

average[RW]

[Required] The average number in the data set. @return [Float]

lower_quartile[RW]

[Required] The middle number between the smallest number and the median of the data set. It's also known as the 25th quartile. @return [Float]

maximum[RW]

[Required] The largest number in the data set. @return [Float]

median[RW]

[Required] The middle number in the data set. @return [Float]

minimum[RW]

[Required] The smallest number in the data set. @return [Float]

upper_quartile[RW]

[Required] The middle number between the median and the largest number of the data set. It's also known as the 75th quartile. @return [Float]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/opsi/models/summary_statistics.rb, line 36
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'minimum': :'minimum',
    'maximum': :'maximum',
    'average': :'average',
    'median': :'median',
    'lower_quartile': :'lowerQuartile',
    'upper_quartile': :'upperQuartile'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Float] :minimum The value to assign to the {#minimum} property @option attributes [Float] :maximum The value to assign to the {#maximum} property @option attributes [Float] :average The value to assign to the {#average} property @option attributes [Float] :median The value to assign to the {#median} property @option attributes [Float] :lower_quartile The value to assign to the {#lower_quartile} property @option attributes [Float] :upper_quartile The value to assign to the {#upper_quartile} property

# File lib/oci/opsi/models/summary_statistics.rb, line 75
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.minimum = attributes[:'minimum'] if attributes[:'minimum']

  self.maximum = attributes[:'maximum'] if attributes[:'maximum']

  self.average = attributes[:'average'] if attributes[:'average']

  self.median = attributes[:'median'] if attributes[:'median']

  self.lower_quartile = attributes[:'lowerQuartile'] if attributes[:'lowerQuartile']

  raise 'You cannot provide both :lowerQuartile and :lower_quartile' if attributes.key?(:'lowerQuartile') && attributes.key?(:'lower_quartile')

  self.lower_quartile = attributes[:'lower_quartile'] if attributes[:'lower_quartile']

  self.upper_quartile = attributes[:'upperQuartile'] if attributes[:'upperQuartile']

  raise 'You cannot provide both :upperQuartile and :upper_quartile' if attributes.key?(:'upperQuartile') && attributes.key?(:'upper_quartile')

  self.upper_quartile = attributes[:'upper_quartile'] if attributes[:'upper_quartile']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/opsi/models/summary_statistics.rb, line 50
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'minimum': :'Float',
    'maximum': :'Float',
    'average': :'Float',
    'median': :'Float',
    'lower_quartile': :'Float',
    'upper_quartile': :'Float'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/opsi/models/summary_statistics.rb, line 109
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    minimum == other.minimum &&
    maximum == other.maximum &&
    average == other.average &&
    median == other.median &&
    lower_quartile == other.lower_quartile &&
    upper_quartile == other.upper_quartile
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/opsi/models/summary_statistics.rb, line 144
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/opsi/models/summary_statistics.rb, line 124
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/opsi/models/summary_statistics.rb, line 133
def hash
  [minimum, maximum, average, median, lower_quartile, upper_quartile].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/opsi/models/summary_statistics.rb, line 177
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/opsi/models/summary_statistics.rb, line 171
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/opsi/models/summary_statistics.rb, line 194
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end