Class: NucleusApi::Allocation

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

Overview

Allocation Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Allocation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/nucleus_api/models/allocation.rb', line 100

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

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

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

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

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

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

Instance Attribute Details

#benchmark_id ⇒ Object

benchmarkId



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

def benchmark_id
  @benchmark_id
end

#category ⇒ Object

Returns the value of attribute category.



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

def category
  @category
end

#client_id ⇒ Object

clientId



24
25
26
 
# File 'lib/nucleus_api/models/allocation.rb', line 24

def client_id
  @client_id
end

#create_date ⇒ Object

Returns the value of attribute create_date.



26
27
28
 
# File 'lib/nucleus_api/models/allocation.rb', line 26

def create_date
  @create_date
end

#description ⇒ Object

description



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

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#inception_date ⇒ Object

inceptionDate



34
35
36
 
# File 'lib/nucleus_api/models/allocation.rb', line 34

def inception_date
  @inception_date
end

#is_active ⇒ Object

isActive



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

def is_active
  @is_active
end

#metadata ⇒ Object

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#name ⇒ Object

name



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

def name
  @name
end

#node_map ⇒ Object

Returns the value of attribute node_map.



44
45
46
 
# File 'lib/nucleus_api/models/allocation.rb', line 44

def node_map
  @node_map
end

#performance ⇒ Object

performance



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

def performance
  @performance
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



49
50
51
 
# File 'lib/nucleus_api/models/allocation.rb', line 49

def secondary_id
  @secondary_id
end

#update_date ⇒ Object

Returns the value of attribute update_date.



51
52
53
 
# File 'lib/nucleus_api/models/allocation.rb', line 51

def update_date
  @update_date
end

#volatility ⇒ Object

volatility



54
55
56
 
# File 'lib/nucleus_api/models/allocation.rb', line 54

def volatility
  @volatility
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/nucleus_api/models/allocation.rb', line 57

def self.attribute_map
  {
    :'benchmark_id' => :'benchmark_id',
    :'category' => :'category',
    :'client_id' => :'client_id',
    :'create_date' => :'create_date',
    :'description' => :'description',
    :'id' => :'id',
    :'inception_date' => :'inception_date',
    :'is_active' => :'is_active',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'node_map' => :'node_map',
    :'performance' => :'performance',
    :'secondary_id' => :'secondary_id',
    :'update_date' => :'update_date',
    :'volatility' => :'volatility'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/nucleus_api/models/allocation.rb', line 78

def self.swagger_types
  {
    :'benchmark_id' => :'String',
    :'category' => :'String',
    :'client_id' => :'String',
    :'create_date' => :'DateTime',
    :'description' => :'String',
    :'id' => :'String',
    :'inception_date' => :'Date',
    :'is_active' => :'BOOLEAN',
    :'metadata' => :'Hash<String, String>',
    :'name' => :'String',
    :'node_map' => :'Array<AllocationNodeMap>',
    :'performance' => :'Float',
    :'secondary_id' => :'String',
    :'update_date' => :'DateTime',
    :'volatility' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nucleus_api/models/allocation.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      benchmark_id == o.benchmark_id &&
      category == o.category &&
      client_id == o.client_id &&
      create_date == o.create_date &&
      description == o.description &&
      id == o.id &&
      inception_date == o.inception_date &&
      is_active == o.is_active &&
      metadata == o.metadata &&
      name == o.name &&
      node_map == o.node_map &&
      performance == o.performance &&
      secondary_id == o.secondary_id &&
      update_date == o.update_date &&
      volatility == o.volatility
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



245
246
247
248
249
250
251
252
253
254
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
281
 
# File 'lib/nucleus_api/models/allocation.rb', line 245

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/nucleus_api/models/allocation.rb', line 311

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/nucleus_api/models/allocation.rb', line 226

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


213
214
215
 
# File 'lib/nucleus_api/models/allocation.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



219
220
221
 
# File 'lib/nucleus_api/models/allocation.rb', line 219

def hash
  [benchmark_id, category, client_id, create_date, description, id, inception_date, is_active, metadata, name, node_map, performance, secondary_id, update_date, volatility].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



173
174
175
176
177
178
179
180
 
# File 'lib/nucleus_api/models/allocation.rb', line 173

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



292
293
294
 
# File 'lib/nucleus_api/models/allocation.rb', line 292

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



298
299
300
301
302
303
304
305
 
# File 'lib/nucleus_api/models/allocation.rb', line 298

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



286
287
288
 
# File 'lib/nucleus_api/models/allocation.rb', line 286

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



184
185
186
187
 
# File 'lib/nucleus_api/models/allocation.rb', line 184

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