Class: IbmCloudPower::PVMInstanceCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_power/models/pvm_instance_create.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PVMInstanceCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
234
235
236
237
238
239
240
241
242
243
244
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
282
283
284
285
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 171

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IbmCloudPower::PVMInstanceCreate` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `IbmCloudPower::PVMInstanceCreate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'server_name')
    self.server_name = attributes[:'server_name']
  end

  if attributes.key?(:'replicants')
    self.replicants = attributes[:'replicants']
  end

  if attributes.key?(:'replicant_naming_scheme')
    self.replicant_naming_scheme = attributes[:'replicant_naming_scheme']
  else
    self.replicant_naming_scheme = 'suffix'
  end

  if attributes.key?(:'replicant_affinity_policy')
    self.replicant_affinity_policy = attributes[:'replicant_affinity_policy']
  else
    self.replicant_affinity_policy = 'none'
  end

  if attributes.key?(:'image_id')
    self.image_id = attributes[:'image_id']
  end

  if attributes.key?(:'processors')
    self.processors = attributes[:'processors']
  end

  if attributes.key?(:'proc_type')
    self.proc_type = attributes[:'proc_type']
  else
    self.proc_type = 'dedicated'
  end

  if attributes.key?(:'memory')
    self.memory = attributes[:'memory']
  end

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

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

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

  if attributes.key?(:'key_pair_name')
    self.key_pair_name = attributes[:'key_pair_name']
  end

  if attributes.key?(:'sys_type')
    self.sys_type = attributes[:'sys_type']
  end

  if attributes.key?(:'migratable')
    self.migratable = attributes[:'migratable']
  else
    self.migratable = true
  end

  if attributes.key?(:'user_data')
    self.user_data = attributes[:'user_data']
  end

  if attributes.key?(:'storage_type')
    self.storage_type = attributes[:'storage_type']
  end

  if attributes.key?(:'storage_affinity')
    self.storage_affinity = attributes[:'storage_affinity']
  end

  if attributes.key?(:'storage_pool')
    self.storage_pool = attributes[:'storage_pool']
  end

  if attributes.key?(:'software_licenses')
    self.software_licenses = attributes[:'software_licenses']
  end

  if attributes.key?(:'pin_policy')
    self.pin_policy = attributes[:'pin_policy']
  end

  if attributes.key?(:'virtual_cores')
    self.virtual_cores = attributes[:'virtual_cores']
  end

  if attributes.key?(:'placement_group')
    self.placement_group = attributes[:'placement_group']
  end
end

Instance Attribute Details

#image_id ⇒ Object

Image ID of the image to use for the server



31
32
33
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 31

def image_id
  @image_id
end

#key_pair_name ⇒ Object

The name of the SSH key pair provided to the server for authenticating users (looked up in the tenant’s list of keys)



52
53
54
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 52

def key_pair_name
  @key_pair_name
end

#memory ⇒ Object

Amount of memory allocated (in GB)



40
41
42
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 40

def memory
  @memory
end

#migratable ⇒ Object

Indicates if the server is allowed to migrate between hosts



58
59
60
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 58

def migratable
  @migratable
end

#network_ids ⇒ Object

(deprecated - replaced by networks) List of Network IDs



43
44
45
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 43

def network_ids
  @network_ids
end

#networks ⇒ Object

The pvm instance networks information



46
47
48
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 46

def networks
  @networks
end

#pin_policy ⇒ Object

Returns the value of attribute pin_policy.



73
74
75
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 73

def pin_policy
  @pin_policy
end

#placement_group ⇒ Object

The placement group for the server



78
79
80
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 78

def placement_group
  @placement_group
end

#proc_type ⇒ Object

Processor type (dedicated, shared, capped)



37
38
39
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 37

def proc_type
  @proc_type
end

#processors ⇒ Object

Number of processors allocated



34
35
36
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 34

def processors
  @processors
end

#replicant_affinity_policy ⇒ Object

Affinity policy for replicants being created; affinity for the same host, anti-affinity for different hosts, none for no preference



28
29
30
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 28

def replicant_affinity_policy
  @replicant_affinity_policy
end

#replicant_naming_scheme ⇒ Object

How to name the created vms



25
26
27
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 25

def replicant_naming_scheme
  @replicant_naming_scheme
end

#replicants ⇒ Object

Number of duplicate instances to create in this request



22
23
24
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 22

def replicants
  @replicants
end

#server_name ⇒ Object

Name of the server to create



19
20
21
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 19

def server_name
  @server_name
end

#software_licenses ⇒ Object

Returns the value of attribute software_licenses.



71
72
73
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 71

def software_licenses
  @software_licenses
end

#storage_affinity ⇒ Object

Returns the value of attribute storage_affinity.



66
67
68
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 66

def storage_affinity
  @storage_affinity
end

#storage_pool ⇒ Object

Storage Pool for server deployment; if provided then storageAffinity and storageType will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage type and pool for a custom image (an imported image or an image that is created from a PVMInstance capture) defaults to the storage type and pool the image was created in



69
70
71
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 69

def storage_pool
  @storage_pool
end

#storage_type ⇒ Object

Storage type for server deployment; will be ignored if storagePool or storageAffinity is provided; Only valid when you deploy one of the IBM supplied stock images. Storage type and pool for a custom image (an imported image or an image that is created from a PVMInstance capture) defaults to the storage type and pool the image was created in



64
65
66
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 64

def storage_type
  @storage_type
end

#sys_type ⇒ Object

System type used to host the instance



55
56
57
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 55

def sys_type
  @sys_type
end

#user_data ⇒ Object

Cloud-init user-defined data. The user-defined data is made available to the VM instance as a config drive.



61
62
63
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 61

def user_data
  @user_data
end

#virtual_cores ⇒ Object

Returns the value of attribute virtual_cores.



75
76
77
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 75

def virtual_cores
  @virtual_cores
end

#volume_ids ⇒ Object

List of volume IDs



49
50
51
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 49

def volume_ids
  @volume_ids
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



131
132
133
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 131

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 103

def self.attribute_map
  {
    :'server_name' => :'serverName',
    :'replicants' => :'replicants',
    :'replicant_naming_scheme' => :'replicantNamingScheme',
    :'replicant_affinity_policy' => :'replicantAffinityPolicy',
    :'image_id' => :'imageID',
    :'processors' => :'processors',
    :'proc_type' => :'procType',
    :'memory' => :'memory',
    :'network_ids' => :'networkIDs',
    :'networks' => :'networks',
    :'volume_ids' => :'volumeIDs',
    :'key_pair_name' => :'keyPairName',
    :'sys_type' => :'sysType',
    :'migratable' => :'migratable',
    :'user_data' => :'userData',
    :'storage_type' => :'storageType',
    :'storage_affinity' => :'storageAffinity',
    :'storage_pool' => :'storagePool',
    :'software_licenses' => :'softwareLicenses',
    :'pin_policy' => :'pinPolicy',
    :'virtual_cores' => :'virtualCores',
    :'placement_group' => :'placementGroup'
  }
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



405
406
407
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 405

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



164
165
166
167
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 164

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 136

def self.openapi_types
  {
    :'server_name' => :'String',
    :'replicants' => :'Float',
    :'replicant_naming_scheme' => :'String',
    :'replicant_affinity_policy' => :'String',
    :'image_id' => :'String',
    :'processors' => :'Float',
    :'proc_type' => :'String',
    :'memory' => :'Float',
    :'network_ids' => :'Array<String>',
    :'networks' => :'Array<PVMInstanceAddNetwork>',
    :'volume_ids' => :'Array<String>',
    :'key_pair_name' => :'String',
    :'sys_type' => :'String',
    :'migratable' => :'Boolean',
    :'user_data' => :'String',
    :'storage_type' => :'String',
    :'storage_affinity' => :'StorageAffinity',
    :'storage_pool' => :'String',
    :'software_licenses' => :'SoftwareLicenses',
    :'pin_policy' => :'PinPolicy',
    :'virtual_cores' => :'VirtualCores',
    :'placement_group' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 363

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      server_name == o.server_name &&
      replicants == o.replicants &&
      replicant_naming_scheme == o.replicant_naming_scheme &&
      replicant_affinity_policy == o.replicant_affinity_policy &&
      image_id == o.image_id &&
      processors == o.processors &&
      proc_type == o.proc_type &&
      memory == o.memory &&
      network_ids == o.network_ids &&
      networks == o.networks &&
      volume_ids == o.volume_ids &&
      key_pair_name == o.key_pair_name &&
      sys_type == o.sys_type &&
      migratable == o.migratable &&
      user_data == o.user_data &&
      storage_type == o.storage_type &&
      storage_affinity == o.storage_affinity &&
      storage_pool == o.storage_pool &&
      software_licenses == o.software_licenses &&
      pin_policy == o.pin_policy &&
      virtual_cores == o.virtual_cores &&
      placement_group == o.placement_group
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 436

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(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
    # models (e.g. Pet) or oneOf
    klass = IbmCloudPower.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 507

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



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 412

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


392
393
394
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 392

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



398
399
400
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 398

def hash
  [server_name, replicants, replicant_naming_scheme, replicant_affinity_policy, image_id, processors, proc_type, memory, network_ids, networks, volume_ids, key_pair_name, sys_type, migratable, user_data, storage_type, storage_affinity, storage_pool, software_licenses, pin_policy, virtual_cores, placement_group].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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 289

def list_invalid_properties
  invalid_properties = Array.new
  if @server_name.nil?
    invalid_properties.push('invalid value for "server_name", server_name cannot be nil.')
  end

  if @image_id.nil?
    invalid_properties.push('invalid value for "image_id", image_id cannot be nil.')
  end

  if @processors.nil?
    invalid_properties.push('invalid value for "processors", processors cannot be nil.')
  end

  if @proc_type.nil?
    invalid_properties.push('invalid value for "proc_type", proc_type cannot be nil.')
  end

  if @memory.nil?
    invalid_properties.push('invalid value for "memory", memory 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



483
484
485
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 483

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



489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 489

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



477
478
479
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 477

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 316

def valid?
  return false if @server_name.nil?
  replicant_naming_scheme_validator = EnumAttributeValidator.new('String', ["prefix", "suffix"])
  return false unless replicant_naming_scheme_validator.valid?(@replicant_naming_scheme)
  replicant_affinity_policy_validator = EnumAttributeValidator.new('String', ["affinity", "anti-affinity", "none"])
  return false unless replicant_affinity_policy_validator.valid?(@replicant_affinity_policy)
  return false if @image_id.nil?
  return false if @processors.nil?
  return false if @proc_type.nil?
  proc_type_validator = EnumAttributeValidator.new('String', ["dedicated", "shared", "capped"])
  return false unless proc_type_validator.valid?(@proc_type)
  return false if @memory.nil?
  true
end