Class: Ionoscloud::ImageProperties

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImageProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
# 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

Instance Attribute Details

#cloud_initObject

Cloud init compatibility



73
74
75
# File 'lib/ionoscloud/models/image_properties.rb', line 73

def cloud_init
  @cloud_init
end

#cpu_hot_plugObject

Is capable of CPU hot plug (no reboot required)



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

def cpu_hot_plug
  @cpu_hot_plug
end

#cpu_hot_unplugObject

Is capable of CPU hot unplug (no reboot required)



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

def cpu_hot_unplug
  @cpu_hot_unplug
end

#descriptionObject

Human readable description



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

def description
  @description
end

#disc_scsi_hot_plugObject

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



55
56
57
# File 'lib/ionoscloud/models/image_properties.rb', line 55

def disc_scsi_hot_plug
  @disc_scsi_hot_plug
end

#disc_scsi_hot_unplugObject

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



58
59
60
# File 'lib/ionoscloud/models/image_properties.rb', line 58

def disc_scsi_hot_unplug
  @disc_scsi_hot_unplug
end

#disc_virtio_hot_plugObject

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



49
50
51
# File 'lib/ionoscloud/models/image_properties.rb', line 49

def disc_virtio_hot_plug
  @disc_virtio_hot_plug
end

#disc_virtio_hot_unplugObject

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



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

def disc_virtio_hot_unplug
  @disc_virtio_hot_unplug
end

#image_aliasesObject

List of image aliases mapped for this Image



70
71
72
# File 'lib/ionoscloud/models/image_properties.rb', line 70

def image_aliases
  @image_aliases
end

#image_typeObject

This indicates the type of image



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

def image_type
  @image_type
end

#licence_typeObject

OS type of this Image



61
62
63
# File 'lib/ionoscloud/models/image_properties.rb', line 61

def licence_type
  @licence_type
end

#locationObject

Location of that image/snapshot.



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

def location
  @location
end

#nameObject

A name of that resource



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

def name
  @name
end

#nic_hot_plugObject

Is capable of nic hot plug (no reboot required)



43
44
45
# File 'lib/ionoscloud/models/image_properties.rb', line 43

def nic_hot_plug
  @nic_hot_plug
end

#nic_hot_unplugObject

Is capable of nic hot unplug (no reboot required)



46
47
48
# File 'lib/ionoscloud/models/image_properties.rb', line 46

def nic_hot_unplug
  @nic_hot_unplug
end

#publicObject

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



67
68
69
# File 'lib/ionoscloud/models/image_properties.rb', line 67

def public
  @public
end

#ram_hot_plugObject

Is capable of memory hot plug (no reboot required)



37
38
39
# File 'lib/ionoscloud/models/image_properties.rb', line 37

def ram_hot_plug
  @ram_hot_plug
end

#ram_hot_unplugObject

Is capable of memory hot unplug (no reboot required)



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

def ram_hot_unplug
  @ram_hot_unplug
end

#sizeObject

The size of the image in GB



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

def size
  @size
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



123
124
125
# File 'lib/ionoscloud/models/image_properties.rb', line 123

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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/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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



347
348
349
# File 'lib/ionoscloud/models/image_properties.rb', line 347

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

.openapi_nullableObject

List of attributes with nullable: true



153
154
155
156
# File 'lib/ionoscloud/models/image_properties.rb', line 153

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

.openapi_typesObject

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



377
378
379
380
381
382
383
384
385
386
387
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
# 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) ⇒ 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



448
449
450
451
452
453
454
455
456
457
458
459
460
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


334
335
336
# File 'lib/ionoscloud/models/image_properties.rb', line 334

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



340
341
342
# 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

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



254
255
256
257
258
259
260
261
# 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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



424
425
426
# File 'lib/ionoscloud/models/image_properties.rb', line 424

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



430
431
432
433
434
435
436
437
438
439
440
441
442
# 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



418
419
420
# File 'lib/ionoscloud/models/image_properties.rb', line 418

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



265
266
267
268
269
270
271
272
273
274
# 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", "UNKNOWN"])
  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