Class: IntersightClient::CloudBaseVirtualMachine

Inherits:
VirtualizationBaseVirtualMachine show all
Defined in:
lib/intersight_client/models/cloud_base_virtual_machine.rb

Overview

BaseVirtualMachine is an abstract base type for all cloud virtual machines.

Direct Known Subclasses

CloudAwsVirtualMachine

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from VirtualizationBaseVirtualMachine

#boot_time, #capacity, #cpu_utilization, #guest_info, #hypervisor_type, #identity, #ip_address, #memory_capacity, #memory_utilization, #name, #power_state, #processor_capacity, #provider, #state, #uuid, #vm_creation_time

Attributes inherited from VirtualizationBaseSourceDevice

#registered_device

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CloudBaseVirtualMachine

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 154

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::CloudBaseVirtualMachine` 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.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'cloud.AwsVirtualMachine'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'cloud.AwsVirtualMachine'
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billing_unit ⇒ Object

Returns the value of attribute billing_unit.



25
26
27
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 25

def billing_unit
  @billing_unit
end

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data. The enum values provides the list of concrete types that can be instantiated from this abstract type.



20
21
22
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 20

def class_id
  @class_id
end

#image_info ⇒ Object

Returns the value of attribute image_info.



27
28
29
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 27

def image_info
  @image_info
end

#instance_type ⇒ Object

Returns the value of attribute instance_type.



29
30
31
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 29

def instance_type
  @instance_type
end

#network_interface_attachments ⇒ Object

Returns the value of attribute network_interface_attachments.



31
32
33
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 31

def network_interface_attachments
  @network_interface_attachments
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property. The enum values provides the list of concrete types that can be instantiated from this abstract type.



23
24
25
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 23

def object_type
  @object_type
end

#private_dns ⇒ Object

The private DNS hostname name assigned to the instance.



34
35
36
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 34

def private_dns
  @private_dns
end

#public_dns ⇒ Object

The public DNS name assigned to the instance.



37
38
39
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 37

def public_dns
  @public_dns
end

#region ⇒ Object

Returns the value of attribute region.



39
40
41
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 39

def region
  @region
end

#tenancy ⇒ Object

How virtual machines are distributed across physical hardware and affects pricing.



42
43
44
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 42

def tenancy
  @tenancy
end

#termination_time ⇒ Object

Time when this virtualmachine is terminated.



45
46
47
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 45

def termination_time
  @termination_time
end

#virtual_machine_tags ⇒ Object

Returns the value of attribute virtual_machine_tags.



47
48
49
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 47

def virtual_machine_tags
  @virtual_machine_tags
end

#volume_attachments ⇒ Object

Returns the value of attribute volume_attachments.



49
50
51
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 49

def volume_attachments
  @volume_attachments
end

#zone ⇒ Object

Returns the value of attribute zone.



51
52
53
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 51

def zone
  @zone
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



101
102
103
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 101

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



96
97
98
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 96

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 76

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'billing_unit' => :'BillingUnit',
    :'image_info' => :'ImageInfo',
    :'instance_type' => :'InstanceType',
    :'network_interface_attachments' => :'NetworkInterfaceAttachments',
    :'private_dns' => :'PrivateDns',
    :'public_dns' => :'PublicDns',
    :'region' => :'Region',
    :'tenancy' => :'Tenancy',
    :'termination_time' => :'TerminationTime',
    :'virtual_machine_tags' => :'VirtualMachineTags',
    :'volume_attachments' => :'VolumeAttachments',
    :'zone' => :'Zone'
  }
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



320
321
322
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 320

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



140
141
142
143
144
145
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 140

def self.openapi_all_of
  [
  :'CloudBaseVirtualMachineAllOf',
  :'VirtualizationBaseVirtualMachine'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



148
149
150
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 148

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 126

def self.openapi_nullable
  Set.new([
    :'billing_unit',
    :'image_info',
    :'instance_type',
    :'network_interface_attachments',
    :'region',
    :'virtual_machine_tags',
    :'volume_attachments',
    :'zone'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 106

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'billing_unit' => :'CloudBillingUnit',
    :'image_info' => :'CloudImageReference',
    :'instance_type' => :'CloudInstanceType',
    :'network_interface_attachments' => :'Array<CloudNetworkInterfaceAttachment>',
    :'private_dns' => :'String',
    :'public_dns' => :'String',
    :'region' => :'CloudCloudRegion',
    :'tenancy' => :'String',
    :'termination_time' => :'Time',
    :'virtual_machine_tags' => :'Array<CloudCloudTag>',
    :'volume_attachments' => :'Array<CloudVolumeAttachment>',
    :'zone' => :'CloudAvailabilityZone'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 286

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      billing_unit == o.billing_unit &&
      image_info == o.image_info &&
      instance_type == o.instance_type &&
      network_interface_attachments == o.network_interface_attachments &&
      private_dns == o.private_dns &&
      public_dns == o.public_dns &&
      region == o.region &&
      tenancy == o.tenancy &&
      termination_time == o.termination_time &&
      virtual_machine_tags == o.virtual_machine_tags &&
      volume_attachments == o.volume_attachments &&
      zone == o.zone && super(o)
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



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
387
388
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 351

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



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 422

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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 327

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  CloudBaseVirtualMachine.openapi_types.each_pair do |key, type|
    if attributes[CloudBaseVirtualMachine.attribute_map[key]].nil? && CloudBaseVirtualMachine.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[CloudBaseVirtualMachine.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[CloudBaseVirtualMachine.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[CloudBaseVirtualMachine.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[CloudBaseVirtualMachine.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


307
308
309
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 307

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



313
314
315
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 313

def hash
  [class_id, object_type, billing_unit, image_info, instance_type, network_interface_attachments, private_dns, public_dns, region, tenancy, termination_time, virtual_machine_tags, volume_attachments, zone].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



239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 239

def list_invalid_properties
  invalid_properties = super
  if @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id cannot be nil.')
  end

  if @object_type.nil?
    invalid_properties.push('invalid value for "object_type", object_type 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



398
399
400
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 398

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



404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 404

def to_hash
  hash = super
  CloudBaseVirtualMachine.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = CloudBaseVirtualMachine.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



392
393
394
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 392

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



254
255
256
257
258
259
260
261
262
 
# File 'lib/intersight_client/models/cloud_base_virtual_machine.rb', line 254

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["cloud.AwsVirtualMachine"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["cloud.AwsVirtualMachine"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end