Class: NucleusApi::Model

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/models/model.rb

Overview

Model Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Model

Initializes the object

Parameters:

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

    Model attributes in the form of hash



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/nucleus_api/models/model.rb', line 136

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?(:'benchmark_id')
    self.benchmark_id = attributes[:'benchmark_id']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

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

  if attributes.has_key?(:'node_map')
    if (value = attributes[:'node_map']).is_a?(Array)
      self.node_map = value
    end
  end

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

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

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

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

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

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

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

Instance Attribute Details

#benchmark_id ⇒ Object

benchmarkId



19
20
21
 
# File 'lib/nucleus_api/models/model.rb', line 19

def benchmark_id
  @benchmark_id
end

#cash_sec ⇒ Object

cashSec



22
23
24
 
# File 'lib/nucleus_api/models/model.rb', line 22

def cash_sec
  @cash_sec
end

#category ⇒ Object

category



25
26
27
 
# File 'lib/nucleus_api/models/model.rb', line 25

def category
  @category
end

#client_id ⇒ Object

clientId



28
29
30
 
# File 'lib/nucleus_api/models/model.rb', line 28

def client_id
  @client_id
end

#create_date ⇒ Object

Returns the value of attribute create_date.



30
31
32
 
# File 'lib/nucleus_api/models/model.rb', line 30

def create_date
  @create_date
end

#currency_code ⇒ Object

currency_code



33
34
35
 
# File 'lib/nucleus_api/models/model.rb', line 33

def currency_code
  @currency_code
end

#default_drift_factor ⇒ Object

defaultDriftFactor



36
37
38
 
# File 'lib/nucleus_api/models/model.rb', line 36

def default_drift_factor
  @default_drift_factor
end

#description ⇒ Object

description



39
40
41
 
# File 'lib/nucleus_api/models/model.rb', line 39

def description
  @description
end

#downside ⇒ Object

downside



42
43
44
 
# File 'lib/nucleus_api/models/model.rb', line 42

def downside
  @downside
end

#drift_rebal ⇒ Object

driftRebal



45
46
47
 
# File 'lib/nucleus_api/models/model.rb', line 45

def drift_rebal
  @drift_rebal
end

#id ⇒ Object

Returns the value of attribute id.



47
48
49
 
# File 'lib/nucleus_api/models/model.rb', line 47

def id
  @id
end

#is_active ⇒ Object

isActive



50
51
52
 
# File 'lib/nucleus_api/models/model.rb', line 50

def is_active
  @is_active
end

#metadata ⇒ Object

Returns the value of attribute metadata.



52
53
54
 
# File 'lib/nucleus_api/models/model.rb', line 52

def metadata
  @metadata
end

#name ⇒ Object

name



55
56
57
 
# File 'lib/nucleus_api/models/model.rb', line 55

def name
  @name
end

#node_map ⇒ Object

Returns the value of attribute node_map.



57
58
59
 
# File 'lib/nucleus_api/models/model.rb', line 57

def node_map
  @node_map
end

#period_rebal ⇒ Object

periodRebal



60
61
62
 
# File 'lib/nucleus_api/models/model.rb', line 60

def period_rebal
  @period_rebal
end

#rebalance_period ⇒ Object

rebalancePeriod



63
64
65
 
# File 'lib/nucleus_api/models/model.rb', line 63

def rebalance_period
  @rebalance_period
end

#safe_sec ⇒ Object

safeSec



66
67
68
 
# File 'lib/nucleus_api/models/model.rb', line 66

def safe_sec
  @safe_sec
end

#sec_rotation ⇒ Object

secRotation



69
70
71
 
# File 'lib/nucleus_api/models/model.rb', line 69

def sec_rotation
  @sec_rotation
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



71
72
73
 
# File 'lib/nucleus_api/models/model.rb', line 71

def secondary_id
  @secondary_id
end

#tax_efficiency_id ⇒ Object

taxEfficiencyId



74
75
76
 
# File 'lib/nucleus_api/models/model.rb', line 74

def tax_efficiency_id
  @tax_efficiency_id
end

#update_date ⇒ Object

Returns the value of attribute update_date.



76
77
78
 
# File 'lib/nucleus_api/models/model.rb', line 76

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/nucleus_api/models/model.rb', line 79

def self.attribute_map
  {
    :'benchmark_id' => :'benchmark_id',
    :'cash_sec' => :'cash_sec',
    :'category' => :'category',
    :'client_id' => :'client_id',
    :'create_date' => :'create_date',
    :'currency_code' => :'currency_code',
    :'default_drift_factor' => :'default_drift_factor',
    :'description' => :'description',
    :'downside' => :'downside',
    :'drift_rebal' => :'drift_rebal',
    :'id' => :'id',
    :'is_active' => :'is_active',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'node_map' => :'node_map',
    :'period_rebal' => :'period_rebal',
    :'rebalance_period' => :'rebalance_period',
    :'safe_sec' => :'safe_sec',
    :'sec_rotation' => :'sec_rotation',
    :'secondary_id' => :'secondary_id',
    :'tax_efficiency_id' => :'tax_efficiency_id',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/nucleus_api/models/model.rb', line 107

def self.swagger_types
  {
    :'benchmark_id' => :'String',
    :'cash_sec' => :'String',
    :'category' => :'String',
    :'client_id' => :'String',
    :'create_date' => :'DateTime',
    :'currency_code' => :'String',
    :'default_drift_factor' => :'Float',
    :'description' => :'String',
    :'downside' => :'BOOLEAN',
    :'drift_rebal' => :'BOOLEAN',
    :'id' => :'String',
    :'is_active' => :'BOOLEAN',
    :'metadata' => :'Hash<String, String>',
    :'name' => :'String',
    :'node_map' => :'Array<AllocationNodeMap>',
    :'period_rebal' => :'BOOLEAN',
    :'rebalance_period' => :'Integer',
    :'safe_sec' => :'String',
    :'sec_rotation' => :'BOOLEAN',
    :'secondary_id' => :'String',
    :'tax_efficiency_id' => :'Integer',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/nucleus_api/models/model.rb', line 255

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      benchmark_id == o.benchmark_id &&
      cash_sec == o.cash_sec &&
      category == o.category &&
      client_id == o.client_id &&
      create_date == o.create_date &&
      currency_code == o.currency_code &&
      default_drift_factor == o.default_drift_factor &&
      description == o.description &&
      downside == o.downside &&
      drift_rebal == o.drift_rebal &&
      id == o.id &&
      is_active == o.is_active &&
      metadata == o.metadata &&
      name == o.name &&
      node_map == o.node_map &&
      period_rebal == o.period_rebal &&
      rebalance_period == o.rebalance_period &&
      safe_sec == o.safe_sec &&
      sec_rotation == o.sec_rotation &&
      secondary_id == o.secondary_id &&
      tax_efficiency_id == o.tax_efficiency_id &&
      update_date == o.update_date
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/nucleus_api/models/model.rb', line 316

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 = NucleusApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of 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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/nucleus_api/models/model.rb', line 382

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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/nucleus_api/models/model.rb', line 297

def build_from_hash(attributes)
  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


284
285
286
 
# File 'lib/nucleus_api/models/model.rb', line 284

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



290
291
292
 
# File 'lib/nucleus_api/models/model.rb', line 290

def hash
  [benchmark_id, cash_sec, category, client_id, create_date, currency_code, default_drift_factor, description, downside, drift_rebal, id, is_active, metadata, name, node_map, period_rebal, rebalance_period, safe_sec, sec_rotation, secondary_id, tax_efficiency_id, update_date].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



237
238
239
240
241
242
243
244
 
# File 'lib/nucleus_api/models/model.rb', line 237

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  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



363
364
365
 
# File 'lib/nucleus_api/models/model.rb', line 363

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



369
370
371
372
373
374
375
376
 
# File 'lib/nucleus_api/models/model.rb', line 369

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(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



357
358
359
 
# File 'lib/nucleus_api/models/model.rb', line 357

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



248
249
250
251
 
# File 'lib/nucleus_api/models/model.rb', line 248

def valid?
  return false if @name.nil?
  true
end