Class: Ionoscloud::VolumeProperties
- Inherits:
-
Object
- Object
- Ionoscloud::VolumeProperties
- Defined in:
- lib/ionoscloud/models/volume_properties.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#availability_zone ⇒ Object
The availability zone in which the volume should be provisioned.
-
#backupunit_id ⇒ Object
The ID of the backup unit that the user has access to.
-
#boot_order ⇒ Object
Determines whether the volume will be used as a boot volume.
-
#boot_server ⇒ Object
The UUID of the attached server.
-
#bus ⇒ Object
The bus type for this volume; default is VIRTIO.
-
#cpu_hot_plug ⇒ Object
Hot-plug capable CPU (no reboot required).
-
#device_number ⇒ Object
The Logical Unit Number of the storage volume.
-
#disc_virtio_hot_plug ⇒ Object
Hot-plug capable Virt-IO drive (no reboot required).
-
#disc_virtio_hot_unplug ⇒ Object
Hot-unplug capable Virt-IO drive (no reboot required).
-
#image ⇒ Object
Image or snapshot ID to be used as template for this volume.
-
#image_alias ⇒ Object
Returns the value of attribute image_alias.
-
#image_password ⇒ Object
Initial password to be set for installed OS.
-
#licence_type ⇒ Object
OS type for this volume.
-
#name ⇒ Object
The name of the resource.
-
#nic_hot_plug ⇒ Object
Hot-plug capable NIC (no reboot required).
-
#nic_hot_unplug ⇒ Object
Hot-unplug capable NIC (no reboot required).
-
#pci_slot ⇒ Object
The PCI slot number of the storage volume.
-
#ram_hot_plug ⇒ Object
Hot-plug capable RAM (no reboot required).
-
#size ⇒ Object
The size of the volume in GB.
-
#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.
-
#type ⇒ Object
Hardware type of the volume.
-
#user_data ⇒ Object
The cloud-init configuration for the volume as base64 encoded string.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ VolumeProperties
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ VolumeProperties
Initializes the object
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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 262 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') && (value = attributes[:'ssh_keys']).is_a?(Array) self.ssh_keys = value 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?(:'pci_slot') self.pci_slot = attributes[:'pci_slot'] 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 if attributes.key?(:'boot_server') self.boot_server = attributes[:'boot_server'] end if attributes.key?(:'boot_order') self.boot_order = attributes[:'boot_order'] else self.boot_order = 'AUTO' end end |
Instance Attribute Details
#availability_zone ⇒ Object
The availability zone in which the volume should be provisioned. The storage volume will be provisioned on as few physical storage devices as possible, but this cannot be guaranteed upfront. This is uavailable for DAS (Direct Attached Storage), and subject to availability for SSD.
32 33 34 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 32 def availability_zone @availability_zone end |
#backupunit_id ⇒ Object
The ID of the backup unit that the user has access to. The property is immutable and is only allowed to be set on creation of a new a volume. It is mandatory to provide either ‘public image’ or ‘imageAlias’ in conjunction with this property.
91 92 93 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 91 def backupunit_id @backupunit_id end |
#boot_order ⇒ Object
Determines whether the volume will be used as a boot volume. Set to ‘NONE`, the volume will not be used as boot volume. Set to `PRIMARY`, the volume will be used as boot volume and all other volumes must be set to `NONE`. Set to `AUTO` or `null` requires all volumes to be set to `AUTO` or `null`; this will use the legacy behavior, which is to use the volume as a boot volume only if there are no other volumes or cdrom devices.
103 104 105 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 103 def boot_order @boot_order end |
#boot_server ⇒ Object
The UUID of the attached server.
99 100 101 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 99 def boot_server @boot_server end |
#bus ⇒ Object
The bus type for this volume; default is VIRTIO.
51 52 53 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 51 def bus @bus end |
#cpu_hot_plug ⇒ Object
Hot-plug capable CPU (no reboot required).
59 60 61 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 59 def cpu_hot_plug @cpu_hot_plug end |
#device_number ⇒ Object
The Logical Unit Number of the storage volume. Null for volumes, not mounted to a VM.
83 84 85 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 83 def device_number @device_number end |
#disc_virtio_hot_plug ⇒ Object
Hot-plug capable Virt-IO drive (no reboot required).
75 76 77 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 75 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.
79 80 81 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 79 def disc_virtio_hot_unplug @disc_virtio_hot_unplug end |
#image ⇒ Object
Image or snapshot ID to be used as template for this volume.
36 37 38 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 36 def image @image end |
#image_alias ⇒ Object
Returns the value of attribute image_alias.
43 44 45 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 43 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.
40 41 42 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 40 def image_password @image_password end |
#licence_type ⇒ Object
OS type for this volume.
55 56 57 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 55 def licence_type @licence_type end |
#name ⇒ Object
The name of the resource.
20 21 22 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 20 def name @name end |
#nic_hot_plug ⇒ Object
Hot-plug capable NIC (no reboot required).
67 68 69 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 67 def nic_hot_plug @nic_hot_plug end |
#nic_hot_unplug ⇒ Object
Hot-unplug capable NIC (no reboot required).
71 72 73 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 71 def nic_hot_unplug @nic_hot_unplug end |
#pci_slot ⇒ Object
The PCI slot number of the storage volume. Null for volumes, not mounted to a VM.
87 88 89 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 87 def pci_slot @pci_slot end |
#ram_hot_plug ⇒ Object
Hot-plug capable RAM (no reboot required).
63 64 65 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 63 def ram_hot_plug @ram_hot_plug end |
#size ⇒ Object
The size of the volume in GB.
28 29 30 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 28 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.
47 48 49 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 47 def ssh_keys @ssh_keys end |
#type ⇒ Object
Hardware type of the volume. DAS (Direct Attached Storage) could be used only in a composite call with a Cube server.
24 25 26 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 24 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 creation of a new a volume. It is mandatory to provide either ‘public image’ or ‘imageAlias’ that has cloud-init compatibility in conjunction with this property.
95 96 97 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 95 def user_data @user_data end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
178 179 180 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 178 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 170 171 172 173 174 175 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 128 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', :'pci_slot' => :'pciSlot', :'backupunit_id' => :'backupunitId', :'user_data' => :'userData', :'boot_server' => :'bootServer', :'boot_order' => :'bootOrder' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
576 577 578 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 576 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
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 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 233 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 183 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', :'pci_slot' => :'Integer', :'backupunit_id' => :'String', :'user_data' => :'String', :'boot_server' => :'String', :'boot_order' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 534 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 && pci_slot == o.pci_slot && backupunit_id == o.backupunit_id && user_data == o.user_data && boot_server == o.boot_server && boot_order == o.boot_order end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 606 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
677 678 679 680 681 682 683 684 685 686 687 688 689 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 677 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
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 583 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
563 564 565 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 563 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
569 570 571 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 569 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, pci_slot, backupunit_id, user_data, boot_server, boot_order].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 390 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)
653 654 655 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 653 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
659 660 661 662 663 664 665 666 667 668 669 670 671 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 659 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
647 648 649 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 647 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 |
# File 'lib/ionoscloud/models/volume_properties.rb', line 423 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", "WINDOWS2022", "LINUX", "OTHER"]) return false unless licence_type_validator.valid?(@licence_type) boot_order_validator = EnumAttributeValidator.new('String', ["AUTO", "NONE", "PRIMARY"]) return false unless boot_order_validator.valid?(@boot_order) true end |