Class: IntersightClient::CloudNetworkInterfaceAttachment

Inherits:
MoBaseComplexType show all
Defined in:
lib/intersight_client/models/cloud_network_interface_attachment.rb

Overview

Network interface details.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CloudNetworkInterfaceAttachment

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_network_interface_attachment.rb', line 154

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_config ⇒ Object

Returns the value of attribute access_config.



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

def access_config
  @access_config
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.



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

def class_id
  @class_id
end

#identity ⇒ Object

The internally generated identity of this network interface attachment.



28
29
30
 
# File 'lib/intersight_client/models/cloud_network_interface_attachment.rb', line 28

def identity
  @identity
end

#ip_forwarding_enabled ⇒ Object

Set to true, if IP forwarding is enabled on this interface.



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

def ip_forwarding_enabled
  @ip_forwarding_enabled
end

#mac_address ⇒ Object

The MAC (Media Access Control) address of the network interface.



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

def mac_address
  @mac_address
end

#network_id ⇒ Object

The identity of the network to which this network interface attachment belongs.



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

def network_id
  @network_id
end

#network_name ⇒ Object

User friendly name of the network to which this network interface attachment belongs.



40
41
42
 
# File 'lib/intersight_client/models/cloud_network_interface_attachment.rb', line 40

def network_name
  @network_name
end

#nic_index ⇒ Object

The device index of the network interface attachment in the virtual machine.



43
44
45
 
# File 'lib/intersight_client/models/cloud_network_interface_attachment.rb', line 43

def nic_index
  @nic_index
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



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

def object_type
  @object_type
end

#private_address ⇒ Object

Returns the value of attribute private_address.



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

def private_address
  @private_address
end

#public_address ⇒ Object

Returns the value of attribute public_address.



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

def public_address
  @public_address
end

#security_groups ⇒ Object

Returns the value of attribute security_groups.



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

def security_groups
  @security_groups
end

#sub_network_id ⇒ Object

The identity of this network interface attachment’s subnet.



52
53
54
 
# File 'lib/intersight_client/models/cloud_network_interface_attachment.rb', line 52

def sub_network_id
  @sub_network_id
end

#sub_network_name ⇒ Object

User friendly name of this network interface attachment’s subnet.



55
56
57
 
# File 'lib/intersight_client/models/cloud_network_interface_attachment.rb', line 55

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



105
106
107
 
# File 'lib/intersight_client/models/cloud_network_interface_attachment.rb', line 105

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)



100
101
102
 
# File 'lib/intersight_client/models/cloud_network_interface_attachment.rb', line 100

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.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/intersight_client/models/cloud_network_interface_attachment.rb', line 80

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'access_config' => :'AccessConfig',
    :'identity' => :'Identity',
    :'ip_forwarding_enabled' => :'IpForwardingEnabled',
    :'mac_address' => :'MacAddress',
    :'network_id' => :'NetworkId',
    :'network_name' => :'NetworkName',
    :'nic_index' => :'NicIndex',
    :'private_address' => :'PrivateAddress',
    :'public_address' => :'PublicAddress',
    :'security_groups' => :'SecurityGroups',
    :'sub_network_id' => :'SubNetworkId',
    :'sub_network_name' => :'SubNetworkName'
  }
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_network_interface_attachment.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_network_interface_attachment.rb', line 140

def self.openapi_all_of
  [
  :'CloudNetworkInterfaceAttachmentAllOf',
  :'MoBaseComplexType'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



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

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



130
131
132
133
134
135
136
137
 
# File 'lib/intersight_client/models/cloud_network_interface_attachment.rb', line 130

def self.openapi_nullable
  Set.new([
    :'access_config',
    :'private_address',
    :'public_address',
    :'security_groups',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/intersight_client/models/cloud_network_interface_attachment.rb', line 110

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'access_config' => :'CloudNetworkAccessConfig',
    :'identity' => :'String',
    :'ip_forwarding_enabled' => :'Boolean',
    :'mac_address' => :'String',
    :'network_id' => :'String',
    :'network_name' => :'String',
    :'nic_index' => :'Integer',
    :'private_address' => :'Array<CloudNetworkAddress>',
    :'public_address' => :'Array<CloudNetworkAddress>',
    :'security_groups' => :'Array<String>',
    :'sub_network_id' => :'String',
    :'sub_network_name' => :'String'
  }
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_network_interface_attachment.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 &&
      access_config == o.access_config &&
      identity == o.identity &&
      ip_forwarding_enabled == o.ip_forwarding_enabled &&
      mac_address == o.mac_address &&
      network_id == o.network_id &&
      network_name == o.network_name &&
      nic_index == o.nic_index &&
      private_address == o.private_address &&
      public_address == o.public_address &&
      security_groups == o.security_groups &&
      sub_network_id == o.sub_network_id &&
      sub_network_name == o.sub_network_name && 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_network_interface_attachment.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_network_interface_attachment.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_network_interface_attachment.rb', line 327

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

def hash
  [class_id, object_type, access_config, identity, ip_forwarding_enabled, mac_address, network_id, network_name, nic_index, private_address, public_address, security_groups, sub_network_id, sub_network_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



239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/intersight_client/models/cloud_network_interface_attachment.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_network_interface_attachment.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_network_interface_attachment.rb', line 404

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

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