Class: IntersightClient::CloudAwsNetworkInterface

Inherits:
CloudBaseNetworkInterface show all
Defined in:
lib/intersight_client/models/cloud_aws_network_interface.rb

Overview

AWS Network Interface object is represented here.It is Virtual interface that can be attached to an instance in a Virtual Private Cloud (VPC).

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from CloudBaseNetworkInterface

#billing_unit, #cidr, #description, #identity, #region_info, #zone_info

Attributes inherited from VirtualizationBaseVirtualNetworkInterfaceCard

#adapter_type, #mac_address, #name

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
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
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 138

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

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

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

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

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

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

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

  if attributes.key?(:'public_ip_address')
    if (value = attributes[:'public_ip_address']).is_a?(Array)
      self.public_ip_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?(:'status')
    self.status = attributes[:'status']
  end

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

Instance Attribute Details

#aws_subnet ⇒ Object

Returns the value of attribute aws_subnet.



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

def aws_subnet
  @aws_subnet
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_aws_network_interface.rb', line 20

def class_id
  @class_id
end

#instance_attachment ⇒ Object

Returns the value of attribute instance_attachment.



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

def instance_attachment
  @instance_attachment
end

#nic_create_time ⇒ Object

Time when this network interface is created.



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

def nic_create_time
  @nic_create_time
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_aws_network_interface.rb', line 23

def object_type
  @object_type
end

#private_dns_name ⇒ Object

The private DNS hostname name assigned to the network interface.



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

def private_dns_name
  @private_dns_name
end

#private_ip_address ⇒ Object

Returns the value of attribute private_ip_address.



33
34
35
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 33

def private_ip_address
  @private_ip_address
end

#public_dns_name ⇒ Object

The public DNS hostname name assigned to the network interface.



36
37
38
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 36

def public_dns_name
  @public_dns_name
end

#public_ip_address ⇒ Object

Returns the value of attribute public_ip_address.



38
39
40
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 38

def public_ip_address
  @public_ip_address
end

#security_groups ⇒ Object

Returns the value of attribute security_groups.



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

def security_groups
  @security_groups
end

#status ⇒ Object

The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.



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

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



92
93
94
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 92

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)



87
88
89
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 87

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.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 70

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'instance_attachment' => :'InstanceAttachment',
    :'nic_create_time' => :'NicCreateTime',
    :'private_dns_name' => :'PrivateDnsName',
    :'private_ip_address' => :'PrivateIpAddress',
    :'public_dns_name' => :'PublicDnsName',
    :'public_ip_address' => :'PublicIpAddress',
    :'security_groups' => :'SecurityGroups',
    :'status' => :'Status',
    :'aws_subnet' => :'AwsSubnet'
  }
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



289
290
291
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 289

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



124
125
126
127
128
129
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 124

def self.openapi_all_of
  [
  :'CloudAwsNetworkInterfaceAllOf',
  :'CloudBaseNetworkInterface'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



132
133
134
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 132

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
118
119
120
121
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 114

def self.openapi_nullable
  Set.new([
    :'instance_attachment',
    :'private_ip_address',
    :'public_ip_address',
    :'security_groups',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 97

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'instance_attachment' => :'CloudNetworkInstanceAttachment',
    :'nic_create_time' => :'Time',
    :'private_dns_name' => :'String',
    :'private_ip_address' => :'Array<String>',
    :'public_dns_name' => :'String',
    :'public_ip_address' => :'Array<String>',
    :'security_groups' => :'Array<String>',
    :'status' => :'String',
    :'aws_subnet' => :'CloudAwsSubnetRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      instance_attachment == o.instance_attachment &&
      nic_create_time == o.nic_create_time &&
      private_dns_name == o.private_dns_name &&
      private_ip_address == o.private_ip_address &&
      public_dns_name == o.public_dns_name &&
      public_ip_address == o.public_ip_address &&
      security_groups == o.security_groups &&
      status == o.status &&
      aws_subnet == o.aws_subnet && 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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 320

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 391

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 296

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


276
277
278
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 276

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



282
283
284
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 282

def hash
  [class_id, object_type, instance_attachment, nic_create_time, private_dns_name, private_ip_address, public_dns_name, public_ip_address, security_groups, status, aws_subnet].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



211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 211

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



367
368
369
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 367

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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 373

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



361
362
363
 
# File 'lib/intersight_client/models/cloud_aws_network_interface.rb', line 361

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



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

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