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



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

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_i_ds')
    if (value = attributes[:'network_i_ds']).is_a?(Array)
      self.network_i_ds = value
    end
  end

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

  if attributes.key?(:'volume_i_ds')
    if (value = attributes[:'volume_i_ds']).is_a?(Array)
      self.volume_i_ds = 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?(:'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



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

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)



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

def key_pair_name
  @key_pair_name
end

#memory ⇒ Object

Amount of memory allocated (in GB)



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

def memory
  @memory
end

#migratable ⇒ Object

Indicates if the server is allowed to migrate between hosts



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

def migratable
  @migratable
end

#network_i_ds ⇒ Object

(deprecated - replaced by networks) List of Network IDs



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

def network_i_ds
  @network_i_ds
end

#networks ⇒ Object

The pvm instance networks information



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

def networks
  @networks
end

#pin_policy ⇒ Object

Returns the value of attribute pin_policy.



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

def pin_policy
  @pin_policy
end

#placement_group ⇒ Object

The placement group for the server



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

def placement_group
  @placement_group
end

#proc_type ⇒ Object

Processor type (dedicated, shared, capped)



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

def proc_type
  @proc_type
end

#processors ⇒ Object

Number of processors allocated



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

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



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

def replicant_affinity_policy
  @replicant_affinity_policy
end

#replicant_naming_scheme ⇒ Object

How to name the created vms



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

def replicant_naming_scheme
  @replicant_naming_scheme
end

#replicants ⇒ Object

Number of duplicate instances to create in this request



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

def replicants
  @replicants
end

#server_name ⇒ Object

Name of the server to create



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

def server_name
  @server_name
end

#software_licenses ⇒ Object

Returns the value of attribute software_licenses.



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

def software_licenses
  @software_licenses
end

#storage_type ⇒ Object

Storage type for server deployment. Only valid when you deploy one of the IBM supplied stock images. Storage type for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage type the image was created in



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

def storage_type
  @storage_type
end

#sys_type ⇒ Object

System type used to host the instance



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

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.



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

def user_data
  @user_data
end

#virtual_cores ⇒ Object

Returns the value of attribute virtual_cores.



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

def virtual_cores
  @virtual_cores
end

#volume_i_ds ⇒ Object

List of volume IDs



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

def volume_i_ds
  @volume_i_ds
end

Class Method Details

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 97

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_i_ds' => :'networkIDs',
    :'networks' => :'networks',
    :'volume_i_ds' => :'volumeIDs',
    :'key_pair_name' => :'keyPairName',
    :'sys_type' => :'sysType',
    :'migratable' => :'migratable',
    :'user_data' => :'userData',
    :'storage_type' => :'storageType',
    :'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



380
381
382
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 380

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



149
150
151
152
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 149

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

.openapi_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 123

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_i_ds' => :'Array<String>',
    :'networks' => :'Array<PVMInstanceAddNetwork>',
    :'volume_i_ds' => :'Array<String>',
    :'key_pair_name' => :'String',
    :'sys_type' => :'String',
    :'migratable' => :'Boolean',
    :'user_data' => :'String',
    :'storage_type' => :'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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 340

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_i_ds == o.network_i_ds &&
      networks == o.networks &&
      volume_i_ds == o.volume_i_ds &&
      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 &&
      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



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 410

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    IbmCloudPower.const_get(type).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



479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 479

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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 387

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


367
368
369
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 367

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



373
374
375
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 373

def hash
  [server_name, replicants, replicant_naming_scheme, replicant_affinity_policy, image_id, processors, proc_type, memory, network_i_ds, networks, volume_i_ds, key_pair_name, sys_type, migratable, user_data, storage_type, 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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 266

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



455
456
457
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 455

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



461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 461

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



449
450
451
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 449

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/ibm_cloud_power/models/pvm_instance_create.rb', line 293

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