Class: Ionoscloud::VolumeProperties

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VolumeProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#availability_zone ⇒ Object

The availability zone in which the volume should exist. The storage volume will be provisioned on as less physical storages as possible but cannot guarantee upfront



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

def availability_zone
  @availability_zone
end

#backupunit_id ⇒ Object

The uuid of the Backup Unit that user has access to. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either ‘public image’ or ‘imageAlias’ in conjunction with this property.



69
70
71
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 69

def backupunit_id
  @backupunit_id
end

#bus ⇒ Object

The bus type of the volume. Default is VIRTIO



42
43
44
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 42

def bus
  @bus
end

#cpu_hot_plug ⇒ Object

Is capable of CPU hot plug (no reboot required)



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

def cpu_hot_plug
  @cpu_hot_plug
end

#device_number ⇒ Object

The LUN ID of the storage volume. Null for volumes not mounted to any VM



66
67
68
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 66

def device_number
  @device_number
end

#disc_virtio_hot_plug ⇒ Object

Is capable of Virt-IO drive hot plug (no reboot required)



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

def disc_virtio_hot_plug
  @disc_virtio_hot_plug
end

#disc_virtio_hot_unplug ⇒ Object

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



63
64
65
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 63

def disc_virtio_hot_unplug
  @disc_virtio_hot_unplug
end

#image ⇒ Object

Image or snapshot ID to be used as template for this volume



31
32
33
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 31

def image
  @image
end

#image_alias ⇒ Object

Returns the value of attribute image_alias.



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

def image_alias
  @image_alias
end

#image_password ⇒ Object

Initial password to be set for installed OS. Works with public images only. Not modifiable, forbidden in update requests. Password rules allows all characters from a-z, A-Z, 0-9



34
35
36
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 34

def image_password
  @image_password
end

#licence_type ⇒ Object

OS type of this volume



45
46
47
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 45

def licence_type
  @licence_type
end

#name ⇒ Object

A name of that resource



19
20
21
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 19

def name
  @name
end

#nic_hot_plug ⇒ Object

Is capable of nic hot plug (no reboot required)



54
55
56
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 54

def nic_hot_plug
  @nic_hot_plug
end

#nic_hot_unplug ⇒ Object

Is capable of nic hot unplug (no reboot required)



57
58
59
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 57

def nic_hot_unplug
  @nic_hot_unplug
end

#ram_hot_plug ⇒ Object

Is capable of memory hot plug (no reboot required)



51
52
53
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 51

def ram_hot_plug
  @ram_hot_plug
end

#size ⇒ Object

The size of the volume in GB



25
26
27
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 25

def size
  @size
end

#ssh_keys ⇒ Object

Public SSH keys are set on the image as authorized keys for appropriate SSH login to the instance using the corresponding private key. This field may only be set in creation requests. When reading, it always returns null. SSH keys are only supported if a public Linux image is used for the volume creation.



39
40
41
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 39

def ssh_keys
  @ssh_keys
end

#type ⇒ Object

Hardware type of the volume.



22
23
24
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 22

def type
  @type
end

#user_data ⇒ Object

The cloud-init configuration for the volume as base64 encoded string. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either ‘public image’ or ‘imageAlias’ that has cloud-init compatibility in conjunction with this property.



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

def user_data
  @user_data
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



122
123
124
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 122

def self.acceptable_attributes
  attribute_map.values
end

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

def self.attribute_map
  {
    :'name' => :'name',
    :'type' => :'type',
    :'size' => :'size',
    :'availability_zone' => :'availabilityZone',
    :'image' => :'image',
    :'image_password' => :'imagePassword',
    :'image_alias' => :'imageAlias',
    :'ssh_keys' => :'sshKeys',
    :'bus' => :'bus',
    :'licence_type' => :'licenceType',
    :'cpu_hot_plug' => :'cpuHotPlug',
    :'ram_hot_plug' => :'ramHotPlug',
    :'nic_hot_plug' => :'nicHotPlug',
    :'nic_hot_unplug' => :'nicHotUnplug',
    :'disc_virtio_hot_plug' => :'discVirtioHotPlug',
    :'disc_virtio_hot_unplug' => :'discVirtioHotUnplug',
    :'device_number' => :'deviceNumber',
    :'backupunit_id' => :'backupunitId',
    :'user_data' => :'userData'
  }
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



358
359
360
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 358

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



152
153
154
155
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 152

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

.openapi_types ⇒ Object

Attribute type mapping.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 127

def self.openapi_types
  {
    :'name' => :'String',
    :'type' => :'String',
    :'size' => :'Float',
    :'availability_zone' => :'String',
    :'image' => :'String',
    :'image_password' => :'String',
    :'image_alias' => :'String',
    :'ssh_keys' => :'Array<String>',
    :'bus' => :'String',
    :'licence_type' => :'String',
    :'cpu_hot_plug' => :'Boolean',
    :'ram_hot_plug' => :'Boolean',
    :'nic_hot_plug' => :'Boolean',
    :'nic_hot_unplug' => :'Boolean',
    :'disc_virtio_hot_plug' => :'Boolean',
    :'disc_virtio_hot_unplug' => :'Boolean',
    :'device_number' => :'Integer',
    :'backupunit_id' => :'String',
    :'user_data' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 319

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      type == o.type &&
      size == o.size &&
      availability_zone == o.availability_zone &&
      image == o.image &&
      image_password == o.image_password &&
      image_alias == o.image_alias &&
      ssh_keys == o.ssh_keys &&
      bus == o.bus &&
      licence_type == o.licence_type &&
      cpu_hot_plug == o.cpu_hot_plug &&
      ram_hot_plug == o.ram_hot_plug &&
      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 &&
      device_number == o.device_number &&
      backupunit_id == o.backupunit_id &&
      user_data == o.user_data
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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 388

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



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 459

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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 365

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


345
346
347
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 345

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



351
352
353
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 351

def hash
  [name, type, size, availability_zone, image, image_password, image_alias, ssh_keys, bus, licence_type, cpu_hot_plug, ram_hot_plug, nic_hot_plug, nic_hot_unplug, disc_virtio_hot_plug, disc_virtio_hot_unplug, device_number, backupunit_id, user_data].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



253
254
255
256
257
258
259
260
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 253

def list_invalid_properties
  invalid_properties = Array.new
  if @size.nil?
    invalid_properties.push('invalid value for "size", size 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



435
436
437
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 435

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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 441

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



429
430
431
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 429

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



264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/ionoscloud/models/volume_properties.rb', line 264

def valid?
  type_validator = EnumAttributeValidator.new('String', ["HDD", "SSD", "SSD Standard", "SSD Premium", "DAS", "ISO"])
  return false unless type_validator.valid?(@type)
  return false if @size.nil?
  availability_zone_validator = EnumAttributeValidator.new('String', ["AUTO", "ZONE_1", "ZONE_2", "ZONE_3"])
  return false unless availability_zone_validator.valid?(@availability_zone)
  bus_validator = EnumAttributeValidator.new('String', ["VIRTIO", "IDE", "UNKNOWN"])
  return false unless bus_validator.valid?(@bus)
  licence_type_validator = EnumAttributeValidator.new('String', ["UNKNOWN", "WINDOWS", "WINDOWS2016", "LINUX", "OTHER"])
  return false unless licence_type_validator.valid?(@licence_type)
  true
end