class Ionoscloud::ImageProperties

Attributes

cloud_init[RW]

Cloud init compatibility

cpu_hot_plug[RW]

Is capable of CPU hot plug (no reboot required)

cpu_hot_unplug[RW]

Is capable of CPU hot unplug (no reboot required)

description[RW]

Human readable description

disc_scsi_hot_plug[RW]

Is capable of SCSI drive hot plug (no reboot required)

disc_scsi_hot_unplug[RW]

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

disc_virtio_hot_plug[RW]

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

disc_virtio_hot_unplug[RW]

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

image_aliases[RW]

List of image aliases mapped for this Image

image_type[RW]

This indicates the type of image

licence_type[RW]

OS type of this Image

location[RW]

Location of that image/snapshot.

name[RW]

A name of that resource

nic_hot_plug[RW]

Is capable of nic hot plug (no reboot required)

nic_hot_unplug[RW]

Is capable of nic hot unplug (no reboot required)

public[RW]

Indicates if the image is part of the public repository or not

ram_hot_plug[RW]

Is capable of memory hot plug (no reboot required)

ram_hot_unplug[RW]

Is capable of memory hot unplug (no reboot required)

size[RW]

The size of the image in GB

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/ionoscloud/models/image_properties.rb, line 123
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/ionoscloud/models/image_properties.rb, line 98
def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'location' => :'location',
    :'size' => :'size',
    :'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',
    :'image_type' => :'imageType',
    :'public' => :'public',
    :'image_aliases' => :'imageAliases',
    :'cloud_init' => :'cloudInit'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ionoscloud/models/image_properties.rb, line 347
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/ionoscloud/models/image_properties.rb, line 160
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Ionoscloud::ImageProperties` 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::ImageProperties`. 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?(:'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

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

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

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

  if attributes.key?(:'cloud_init')
    self.cloud_init = attributes[:'cloud_init']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/ionoscloud/models/image_properties.rb, line 153
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/ionoscloud/models/image_properties.rb, line 128
def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'location' => :'String',
    :'size' => :'Float',
    :'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',
    :'image_type' => :'String',
    :'public' => :'Boolean',
    :'image_aliases' => :'Array<String>',
    :'cloud_init' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/ionoscloud/models/image_properties.rb, line 308
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      location == o.location &&
      size == o.size &&
      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 &&
      image_type == o.image_type &&
      public == o.public &&
      image_aliases == o.image_aliases &&
      cloud_init == o.cloud_init
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/ionoscloud/models/image_properties.rb, line 377
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/ionoscloud/models/image_properties.rb, line 448
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ionoscloud/models/image_properties.rb, line 354
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
cloud_init=(cloud_init) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] cloud_init Object to be assigned

# File lib/ionoscloud/models/image_properties.rb, line 298
def cloud_init=(cloud_init)
  validator = EnumAttributeValidator.new('String', ["NONE", "V1"])
  unless validator.valid?(cloud_init)
    fail ArgumentError, "invalid value for \"cloud_init\", must be one of #{validator.allowable_values}."
  end
  @cloud_init = cloud_init
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/ionoscloud/models/image_properties.rb, line 334
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/ionoscloud/models/image_properties.rb, line 340
def hash
  [name, description, location, size, 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, image_type, public, image_aliases, cloud_init].hash
end
image_type=(image_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] image_type Object to be assigned

# File lib/ionoscloud/models/image_properties.rb, line 288
def image_type=(image_type)
  validator = EnumAttributeValidator.new('String', ["HDD", "CDROM"])
  unless validator.valid?(image_type)
    fail ArgumentError, "invalid value for \"image_type\", must be one of #{validator.allowable_values}."
  end
  @image_type = image_type
end
licence_type=(licence_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] licence_type Object to be assigned

# File lib/ionoscloud/models/image_properties.rb, line 278
def licence_type=(licence_type)
  validator = EnumAttributeValidator.new('String', ["UNKNOWN", "WINDOWS", "WINDOWS2016", "LINUX", "OTHER"])
  unless validator.valid?(licence_type)
    fail ArgumentError, "invalid value for \"licence_type\", must be one of #{validator.allowable_values}."
  end
  @licence_type = licence_type
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/ionoscloud/models/image_properties.rb, line 254
def list_invalid_properties
  invalid_properties = Array.new
  if @licence_type.nil?
    invalid_properties.push('invalid value for "licence_type", licence_type cannot be nil.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/ionoscloud/models/image_properties.rb, line 424
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/ionoscloud/models/image_properties.rb, line 430
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/ionoscloud/models/image_properties.rb, line 418
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/ionoscloud/models/image_properties.rb, line 265
def valid?
  return false if @licence_type.nil?
  licence_type_validator = EnumAttributeValidator.new('String', ["UNKNOWN", "WINDOWS", "WINDOWS2016", "LINUX", "OTHER"])
  return false unless licence_type_validator.valid?(@licence_type)
  image_type_validator = EnumAttributeValidator.new('String', ["HDD", "CDROM"])
  return false unless image_type_validator.valid?(@image_type)
  cloud_init_validator = EnumAttributeValidator.new('String', ["NONE", "V1"])
  return false unless cloud_init_validator.valid?(@cloud_init)
  true
end