Class: NucleusApi::SecurityCompositionVO

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecurityCompositionVO

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 87

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#end_dateObject

Returns the value of attribute end_date.



17
18
19
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 17

def end_date
  @end_date
end

#security_asset_classObject

Returns the value of attribute security_asset_class.



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

def security_asset_class
  @security_asset_class
end

#security_countriesObject

Returns the value of attribute security_countries.



21
22
23
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 21

def security_countries
  @security_countries
end

#security_create_dateObject

Returns the value of attribute security_create_date.



23
24
25
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 23

def security_create_date
  @security_create_date
end

#security_idObject

Returns the value of attribute security_id.



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

def security_id
  @security_id
end

#security_industryObject

Returns the value of attribute security_industry.



27
28
29
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 27

def security_industry
  @security_industry
end

#security_nameObject

Returns the value of attribute security_name.



29
30
31
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 29

def security_name
  @security_name
end

#security_secondary_idObject

Returns the value of attribute security_secondary_id.



31
32
33
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 31

def security_secondary_id
  @security_secondary_id
end

#security_sectorObject

Returns the value of attribute security_sector.



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

def security_sector
  @security_sector
end

#security_security_classObject

Returns the value of attribute security_security_class.



35
36
37
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 35

def security_security_class
  @security_security_class
end

#security_tickerObject

Returns the value of attribute security_ticker.



37
38
39
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 37

def security_ticker
  @security_ticker
end

#security_update_dateObject

Returns the value of attribute security_update_date.



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

def security_update_date
  @security_update_date
end

#security_weightObject

Returns the value of attribute security_weight.



41
42
43
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 41

def security_weight
  @security_weight
end

#start_dateObject

Returns the value of attribute start_date.



43
44
45
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 43

def start_date
  @start_date
end

Class Method Details

.attribute_mapObject

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 46

def self.attribute_map
  {
    :'end_date' => :'end_date',
    :'security_asset_class' => :'security_asset_class',
    :'security_countries' => :'security_countries',
    :'security_create_date' => :'security_create_date',
    :'security_id' => :'security_id',
    :'security_industry' => :'security_industry',
    :'security_name' => :'security_name',
    :'security_secondary_id' => :'security_secondary_id',
    :'security_sector' => :'security_sector',
    :'security_security_class' => :'security_security_class',
    :'security_ticker' => :'security_ticker',
    :'security_update_date' => :'security_update_date',
    :'security_weight' => :'security_weight',
    :'start_date' => :'start_date'
  }
end

.swagger_typesObject

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 66

def self.swagger_types
  {
    :'end_date' => :'Date',
    :'security_asset_class' => :'String',
    :'security_countries' => :'Array<SecurityCountryVO>',
    :'security_create_date' => :'DateTime',
    :'security_id' => :'String',
    :'security_industry' => :'String',
    :'security_name' => :'String',
    :'security_secondary_id' => :'String',
    :'security_sector' => :'String',
    :'security_security_class' => :'String',
    :'security_ticker' => :'String',
    :'security_update_date' => :'DateTime',
    :'security_weight' => :'Float',
    :'start_date' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 167

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      end_date == o.end_date &&
      security_asset_class == o.security_asset_class &&
      security_countries == o.security_countries &&
      security_create_date == o.security_create_date &&
      security_id == o.security_id &&
      security_industry == o.security_industry &&
      security_name == o.security_name &&
      security_secondary_id == o.security_secondary_id &&
      security_sector == o.security_sector &&
      security_security_class == o.security_security_class &&
      security_ticker == o.security_ticker &&
      security_update_date == o.security_update_date &&
      security_weight == o.security_weight &&
      start_date == o.start_date
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 220

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



286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 286

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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 201

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


188
189
190
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 188

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



194
195
196
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 194

def hash
  [end_date, security_asset_class, security_countries, security_create_date, security_id, security_industry, security_name, security_secondary_id, security_sector, security_security_class, security_ticker, security_update_date, security_weight, start_date].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



154
155
156
157
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 154

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



267
268
269
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 267

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



273
274
275
276
277
278
279
280
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 273

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



261
262
263
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 261

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



161
162
163
# File 'lib/nucleus_api/models/security_composition_vo.rb', line 161

def valid?
  true
end