Class: Ionoscloud::SnapshotProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud/models/snapshot_properties.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SnapshotProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 209

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Ionoscloud::SnapshotProperties` 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 `Ionoscloud::SnapshotProperties`. 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?(:'name')
    self.name = attributes[:'name']
  end


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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

Instance Attribute Details

#cpu_hot_plug ⇒ Object

Hot-plug capable CPU (no reboot required).



40
41
42
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 40

def cpu_hot_plug
  @cpu_hot_plug
end

#cpu_hot_unplug ⇒ Object

Hot-unplug capable CPU (no reboot required).



44
45
46
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 44

def cpu_hot_unplug
  @cpu_hot_unplug
end

#description ⇒ Object

Human-readable description.



24
25
26
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 24

def description
  @description
end

#disc_scsi_hot_plug ⇒ Object

Hot-plug capable SCSI drive (no reboot required).



72
73
74
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 72

def disc_scsi_hot_plug
  @disc_scsi_hot_plug
end

#disc_scsi_hot_unplug ⇒ Object

Is capable of SCSI drive hot unplug (no reboot required). This works only for non-Windows virtual Machines.



76
77
78
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 76

def disc_scsi_hot_unplug
  @disc_scsi_hot_unplug
end

#disc_virtio_hot_plug ⇒ Object

Hot-plug capable Virt-IO drive (no reboot required).



64
65
66
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 64

def disc_virtio_hot_plug
  @disc_virtio_hot_plug
end

#disc_virtio_hot_unplug ⇒ Object

Hot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs.



68
69
70
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 68

def disc_virtio_hot_unplug
  @disc_virtio_hot_unplug
end

#licence_type ⇒ Object

OS type of this snapshot



80
81
82
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 80

def licence_type
  @licence_type
end

#location ⇒ Object

Location of that image/snapshot.



28
29
30
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 28

def location
  @location
end

#name ⇒ Object

The name of the resource.



20
21
22
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 20

def name
  @name
end

#nic_hot_plug ⇒ Object

Hot-plug capable NIC (no reboot required).



56
57
58
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 56

def nic_hot_plug
  @nic_hot_plug
end

#nic_hot_unplug ⇒ Object

Hot-unplug capable NIC (no reboot required).



60
61
62
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 60

def nic_hot_unplug
  @nic_hot_unplug
end

#ram_hot_plug ⇒ Object

Hot-plug capable RAM (no reboot required).



48
49
50
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 48

def ram_hot_plug
  @ram_hot_plug
end

#ram_hot_unplug ⇒ Object

Hot-unplug capable RAM (no reboot required).



52
53
54
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 52

def ram_hot_unplug
  @ram_hot_unplug
end

#sec_auth_protection ⇒ Object

Boolean value representing if the snapshot requires extra protection, such as two-step verification.



36
37
38
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 36

def sec_auth_protection
  @sec_auth_protection
end

#size ⇒ Object

The size of the image in GB.



32
33
34
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 32

def size
  @size
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



143
144
145
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 143

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 105

def self.attribute_map
  {
    
    :'name' => :'name',

    :'description' => :'description',

    :'location' => :'location',

    :'size' => :'size',

    :'sec_auth_protection' => :'secAuthProtection',

    :'cpu_hot_plug' => :'cpuHotPlug',

    :'cpu_hot_unplug' => :'cpuHotUnplug',

    :'ram_hot_plug' => :'ramHotPlug',

    :'ram_hot_unplug' => :'ramHotUnplug',

    :'nic_hot_plug' => :'nicHotPlug',

    :'nic_hot_unplug' => :'nicHotUnplug',

    :'disc_virtio_hot_plug' => :'discVirtioHotPlug',

    :'disc_virtio_hot_unplug' => :'discVirtioHotUnplug',

    :'disc_scsi_hot_plug' => :'discScsiHotPlug',

    :'disc_scsi_hot_unplug' => :'discScsiHotUnplug',

    :'licence_type' => :'licenceType'
  }
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



414
415
416
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 414

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 186

def self.openapi_nullable
  Set.new([
    















  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 148

def self.openapi_types
  {
    
    :'name' => :'String',

    :'description' => :'String',

    :'location' => :'String',

    :'size' => :'Float',

    :'sec_auth_protection' => :'Boolean',

    :'cpu_hot_plug' => :'Boolean',

    :'cpu_hot_unplug' => :'Boolean',

    :'ram_hot_plug' => :'Boolean',

    :'ram_hot_unplug' => :'Boolean',

    :'nic_hot_plug' => :'Boolean',

    :'nic_hot_unplug' => :'Boolean',

    :'disc_virtio_hot_plug' => :'Boolean',

    :'disc_virtio_hot_unplug' => :'Boolean',

    :'disc_scsi_hot_plug' => :'Boolean',

    :'disc_scsi_hot_unplug' => :'Boolean',

    :'licence_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 378

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    name == o.name &&
    description == o.description &&
    location == o.location &&
    size == o.size &&
    sec_auth_protection == o.sec_auth_protection &&
    cpu_hot_plug == o.cpu_hot_plug &&
    cpu_hot_unplug == o.cpu_hot_unplug &&
    ram_hot_plug == o.ram_hot_plug &&
    ram_hot_unplug == o.ram_hot_unplug &&
    nic_hot_plug == o.nic_hot_plug &&
    nic_hot_unplug == o.nic_hot_unplug &&
    disc_virtio_hot_plug == o.disc_virtio_hot_plug &&
    disc_virtio_hot_unplug == o.disc_virtio_hot_unplug &&
    disc_scsi_hot_plug == o.disc_scsi_hot_plug &&
    disc_scsi_hot_unplug == o.disc_scsi_hot_unplug &&
    licence_type == o.licence_type
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



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
474
475
476
477
478
479
480
481
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 444

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 = Ionoscloud.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



515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 515

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



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 421

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


401
402
403
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 401

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



407
408
409
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 407

def hash
  [name, description, location, size, sec_auth_protection, cpu_hot_plug, cpu_hot_unplug, ram_hot_plug, ram_hot_unplug, nic_hot_plug, nic_hot_unplug, disc_virtio_hot_plug, disc_virtio_hot_unplug, disc_scsi_hot_plug, disc_scsi_hot_unplug, licence_type].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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 305

def list_invalid_properties
  invalid_properties = Array.new
  















  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



491
492
493
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 491

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



497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 497

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



485
486
487
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 485

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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/ionoscloud/models/snapshot_properties.rb', line 328

def valid?
  















  licence_type_validator = EnumAttributeValidator.new('String', ["UNKNOWN", "WINDOWS", "WINDOWS2016", "WINDOWS2022", "LINUX", "OTHER"])
  return false unless licence_type_validator.valid?(@licence_type)
  true
end