Class: ProtonApi::RecommendationConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/models/recommendation_config.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecommendationConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



63
64
65
66
67
68
69
70
71
72
73
74
75
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
102
103
104
105
106
107
108
 
# File 'lib/proton_api/models/recommendation_config.rb', line 63

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 }

  if attributes.has_key?(:'horizon_max')
    self.horizon_max = attributes[:'horizon_max']
  else
    self.horizon_max = 64
  end

  if attributes.has_key?(:'dep_min')
    self.dep_min = attributes[:'dep_min']
  end

  if attributes.has_key?(:'inv_max')
    self.inv_max = attributes[:'inv_max']
  end

  if attributes.has_key?(:'inv_min')
    self.inv_min = attributes[:'inv_min']
  end

  if attributes.has_key?(:'recommended_inflation')
    self.recommended_inflation = attributes[:'recommended_inflation']
  else
    self.recommended_inflation = 0.0
  end

  if attributes.has_key?(:'horizon_min')
    self.horizon_min = attributes[:'horizon_min']
  else
    self.horizon_min = 1
  end

  if attributes.has_key?(:'recommend')
    self.recommend = attributes[:'recommend']
  else
    self.recommend = true
  end

  if attributes.has_key?(:'dep_max')
    self.dep_max = attributes[:'dep_max']
  end
end

Instance Attribute Details

#dep_max ⇒ Object

Returns the value of attribute dep_max.



31
32
33
 
# File 'lib/proton_api/models/recommendation_config.rb', line 31

def dep_max
  @dep_max
end

#dep_min ⇒ Object

Returns the value of attribute dep_min.



19
20
21
 
# File 'lib/proton_api/models/recommendation_config.rb', line 19

def dep_min
  @dep_min
end

#horizon_max ⇒ Object

Returns the value of attribute horizon_max.



17
18
19
 
# File 'lib/proton_api/models/recommendation_config.rb', line 17

def horizon_max
  @horizon_max
end

#horizon_min ⇒ Object

Returns the value of attribute horizon_min.



27
28
29
 
# File 'lib/proton_api/models/recommendation_config.rb', line 27

def horizon_min
  @horizon_min
end

#inv_max ⇒ Object

Returns the value of attribute inv_max.



21
22
23
 
# File 'lib/proton_api/models/recommendation_config.rb', line 21

def inv_max
  @inv_max
end

#inv_min ⇒ Object

Returns the value of attribute inv_min.



23
24
25
 
# File 'lib/proton_api/models/recommendation_config.rb', line 23

def inv_min
  @inv_min
end

#recommend ⇒ Object

Returns the value of attribute recommend.



29
30
31
 
# File 'lib/proton_api/models/recommendation_config.rb', line 29

def recommend
  @recommend
end

#recommended_inflation ⇒ Object

Returns the value of attribute recommended_inflation.



25
26
27
 
# File 'lib/proton_api/models/recommendation_config.rb', line 25

def recommended_inflation
  @recommended_inflation
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/proton_api/models/recommendation_config.rb', line 34

def self.attribute_map
  {
    :'horizon_max' => :'horizon_max',
    :'dep_min' => :'dep_min',
    :'inv_max' => :'inv_max',
    :'inv_min' => :'inv_min',
    :'recommended_inflation' => :'recommended_inflation',
    :'horizon_min' => :'horizon_min',
    :'recommend' => :'recommend',
    :'dep_max' => :'dep_max'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/proton_api/models/recommendation_config.rb', line 48

def self.swagger_types
  {
    :'horizon_max' => :'Integer',
    :'dep_min' => :'Float',
    :'inv_max' => :'Float',
    :'inv_min' => :'Float',
    :'recommended_inflation' => :'Float',
    :'horizon_min' => :'Integer',
    :'recommend' => :'BOOLEAN',
    :'dep_max' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/proton_api/models/recommendation_config.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      horizon_max == o.horizon_max &&
      dep_min == o.dep_min &&
      inv_max == o.inv_max &&
      inv_min == o.inv_min &&
      recommended_inflation == o.recommended_inflation &&
      horizon_min == o.horizon_min &&
      recommend == o.recommend &&
      dep_max == o.dep_max
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/proton_api/models/recommendation_config.rb', line 278

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    value
  when :Date
    value
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = ProtonApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/proton_api/models/recommendation_config.rb', line 342

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

#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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/proton_api/models/recommendation_config.rb', line 258

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(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?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


245
246
247
 
# File 'lib/proton_api/models/recommendation_config.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



251
252
253
 
# File 'lib/proton_api/models/recommendation_config.rb', line 251

def hash
  [horizon_max, dep_min, inv_max, inv_min, recommended_inflation, horizon_min, recommend, dep_max].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/proton_api/models/recommendation_config.rb', line 112

def list_invalid_properties
  invalid_properties = Array.new
  if !@horizon_max.nil? && @horizon_max < 0
    invalid_properties.push('invalid value for "horizon_max", must be greater than or equal to 0.')
  end

  if !@dep_min.nil? && @dep_min < 0
    invalid_properties.push('invalid value for "dep_min", must be greater than or equal to 0.')
  end

  if !@inv_max.nil? && @inv_max < 0
    invalid_properties.push('invalid value for "inv_max", must be greater than or equal to 0.')
  end

  if !@inv_min.nil? && @inv_min < 0
    invalid_properties.push('invalid value for "inv_min", must be greater than or equal to 0.')
  end

  if !@recommended_inflation.nil? && @recommended_inflation < -1
    invalid_properties.push('invalid value for "recommended_inflation", must be greater than or equal to -1.')
  end

  if !@horizon_min.nil? && @horizon_min < 0
    invalid_properties.push('invalid value for "horizon_min", must be greater than or equal to 0.')
  end

  if !@dep_max.nil? && @dep_max < 0
    invalid_properties.push('invalid value for "dep_max", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



323
324
325
 
# File 'lib/proton_api/models/recommendation_config.rb', line 323

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



329
330
331
332
333
334
335
336
337
 
# File 'lib/proton_api/models/recommendation_config.rb', line 329

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



317
318
319
 
# File 'lib/proton_api/models/recommendation_config.rb', line 317

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/proton_api/models/recommendation_config.rb', line 147

def valid?
  return false if !@horizon_max.nil? && @horizon_max < 0
  return false if !@dep_min.nil? && @dep_min < 0
  return false if !@inv_max.nil? && @inv_max < 0
  return false if !@inv_min.nil? && @inv_min < 0
  return false if !@recommended_inflation.nil? && @recommended_inflation < -1
  return false if !@horizon_min.nil? && @horizon_min < 0
  return false if !@dep_max.nil? && @dep_max < 0
  true
end