Class: IntersightClient::VirtualizationBaseVirtualNetworkInterfaceCard

Inherits:
VirtualizationBaseSourceDevice show all
Defined in:
lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb

Overview

Common attributes of any virtual network interface card managed by a hypervisor. Serves as a base class for all concrete virtual network interface card types.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

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 = {}) ⇒ VirtualizationBaseVirtualNetworkInterfaceCard

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 109

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

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

  if attributes.key?(:'adapter_type')
    self.adapter_type = attributes[:'adapter_type']
  else
    self.adapter_type = 'Unknown'
  end

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

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

Instance Attribute Details

#adapter_type ⇒ Object

Type or model of the virtual network interface card. * ‘Unknown` - The type of the network adaptor type is unknown. * `E1000` - Emulated version of the Intel 82545EM Gigabit Ethernet NIC. * `SRIOV` - Representation of a virtual function (VF) on a physical NIC with SR-IOV support. * `VMXNET2` - VMXNET 2 (Enhanced) is available only for some guest operating systems on ESX/ESXi 3.5 and later. * `VMXNET3` - VMXNET 3 offers all the features available in VMXNET 2 and adds several new features. * `E1000E` - E1000E – emulates a newer real network adapter, the 1 Gbit Intel 82574, and is available for Windows 2012 and later. The E1000E needs virtual machine hardware version 8 or later. * `NE2K_PCI` - The Ne2000 network card uses two ring buffers for packet handling. These are circular buffers made of 256-byte pages that the chip’s DMA logic will use to store received packets or to get received packets. * ‘PCnet` - The PCnet-PCI II is a PCI network adapter. It has built-in support for CRC checks and can automatically pad short packets to the minimum Ethernet length. * `RTL8139` - The RTL8139 is a fast Ethernet card that operates at 10/100 Mbps. It is compliant with PCI version 2.0/2.1 and it is known for reliability and superior performance. * `VirtIO` - VirtIO is a standardized interface which allows virtual machines access to simplified "virtual" devices, such as block devices, network adapters and consoles. Accessing devices through VirtIO on a guest VM improves performance over more traditional "emulated" devices, as VirtIO devices require only the bare minimum setup and configuration needed to send and receive data, while the host machine handles the majority of the setup and maintenance of the actual physical hardware. * “ - Default network adaptor type supported by the hypervisor.



26
27
28
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 26

def adapter_type
  @adapter_type
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/virtualization_base_virtual_network_interface_card.rb', line 20

def class_id
  @class_id
end

#mac_address ⇒ Object

MAC address assigned to the virtual network interface card.



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

def mac_address
  @mac_address
end

#name ⇒ Object

Name of the virtual network interface card.



32
33
34
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 32

def name
  @name
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/virtualization_base_virtual_network_interface_card.rb', line 23

def object_type
  @object_type
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)



73
74
75
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 73

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)



68
69
70
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 68

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.



57
58
59
60
61
62
63
64
65
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 57

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'adapter_type' => :'AdapterType',
    :'mac_address' => :'MacAddress',
    :'name' => :'Name'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



251
252
253
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 251

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



95
96
97
98
99
100
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 95

def self.openapi_all_of
  [
  :'VirtualizationBaseSourceDevice',
  :'VirtualizationBaseVirtualNetworkInterfaceCardAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



103
104
105
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 103

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 89

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 78

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'adapter_type' => :'String',
    :'mac_address' => :'String',
    :'name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



226
227
228
229
230
231
232
233
234
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 226

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      adapter_type == o.adapter_type &&
      mac_address == o.mac_address &&
      name == o.name && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



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

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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 353

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 258

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


238
239
240
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



244
245
246
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 244

def hash
  [class_id, object_type, adapter_type, mac_address, name].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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 150

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

  pattern = Regexp.new(/^$|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/)
  if !@mac_address.nil? && @mac_address !~ pattern
    invalid_properties.push("invalid value for \"mac_address\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



329
330
331
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 329

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 335

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



323
324
325
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 323

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/intersight_client/models/virtualization_base_virtual_network_interface_card.rb', line 170

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["cloud.AwsNetworkInterface", "hyperflex.HxapVirtualMachineNetworkInterface"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["cloud.AwsNetworkInterface", "hyperflex.HxapVirtualMachineNetworkInterface"])
  return false unless object_type_validator.valid?(@object_type)
  adapter_type_validator = EnumAttributeValidator.new('String', ["Unknown", "E1000", "SRIOV", "VMXNET2", "VMXNET3", "E1000E", "NE2K_PCI", "PCnet", "RTL8139", "VirtIO", ""])
  return false unless adapter_type_validator.valid?(@adapter_type)
  return false if !@mac_address.nil? && @mac_address !~ Regexp.new(/^$|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/)
  true && super
end