Class: OCI::Opsi::Models::SummaryStatistics

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opsi/models/summary_statistics.rb

Overview

Contains common summary statistics.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SummaryStatistics

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :minimum (Float) —

    The value to assign to the #minimum property

  • :maximum (Float) —

    The value to assign to the #maximum property

  • :average (Float) —

    The value to assign to the #average property

  • :median (Float) —

    The value to assign to the #median property

  • :lower_quartile (Float) —

    The value to assign to the #lower_quartile property

  • :upper_quartile (Float) —

    The value to assign to the #upper_quartile property



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 76

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

Instance Attribute Details

#average ⇒ Float

[Required] The average number in the data set.

Returns:

  • (Float) 


22
23
24
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 22

def average
  @average
end

#lower_quartile ⇒ Float

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

Returns:

  • (Float) 


30
31
32
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 30

def lower_quartile
  @lower_quartile
end

#maximum ⇒ Float

[Required] The largest number in the data set.

Returns:

  • (Float) 


18
19
20
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 18

def maximum
  @maximum
end

#median ⇒ Float

[Required] The middle number in the data set.

Returns:

  • (Float) 


26
27
28
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 26

def median
  @median
end

#minimum ⇒ Float

[Required] The smallest number in the data set.

Returns:

  • (Float) 


14
15
16
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 14

def minimum
  @minimum
end

#upper_quartile ⇒ Float

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

Returns:

  • (Float) 


34
35
36
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 34

def upper_quartile
  @upper_quartile
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 37

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

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 51

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 110

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 145

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) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


125
126
127
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 125

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



134
135
136
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 134

def hash
  [minimum, maximum, average, median, lower_quartile, upper_quartile].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 178

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



172
173
174
 
# File 'lib/oci/opsi/models/summary_statistics.rb', line 172

def to_s
  to_hash.to_s
end