Class: OCI::Core::Models::AttachVnicDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/attach_vnic_details.rb

Overview

AttachVnicDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AttachVnicDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 67

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.create_vnic_details = attributes[:'createVnicDetails'] if attributes[:'createVnicDetails']

  raise 'You cannot provide both :createVnicDetails and :create_vnic_details' if attributes.key?(:'createVnicDetails') && attributes.key?(:'create_vnic_details')

  self.create_vnic_details = attributes[:'create_vnic_details'] if attributes[:'create_vnic_details']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.instance_id = attributes[:'instanceId'] if attributes[:'instanceId']

  raise 'You cannot provide both :instanceId and :instance_id' if attributes.key?(:'instanceId') && attributes.key?(:'instance_id')

  self.instance_id = attributes[:'instance_id'] if attributes[:'instance_id']

  self.nic_index = attributes[:'nicIndex'] if attributes[:'nicIndex']

  raise 'You cannot provide both :nicIndex and :nic_index' if attributes.key?(:'nicIndex') && attributes.key?(:'nic_index')

  self.nic_index = attributes[:'nic_index'] if attributes[:'nic_index']
end

Instance Attribute Details

#create_vnic_details ⇒ OCI::Core::Models::CreateVnicDetails

[Required] Details for creating a new VNIC.

Returns:



12
13
14
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 12

def create_vnic_details
  @create_vnic_details
end

#display_name ⇒ String

A user-friendly name for the attachment. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 18

def display_name
  @display_name
end

#instance_id ⇒ String

[Required] The OCID of the instance.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 22

def instance_id
  @instance_id
end

#nic_index ⇒ Integer

Which physical network interface card (NIC) the VNIC will use. Defaults to 0. Certain bare metal instance shapes have two active physical NICs (0 and 1). If you add a secondary VNIC to one of these instances, you can specify which NIC the VNIC will use. For more information, see [Virtual Network Interface Cards (VNICs)](docs.cloud.oracle.com/Content/Network/Tasks/managingVNICs.htm).

Returns:

  • (Integer) 


31
32
33
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 31

def nic_index
  @nic_index
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'create_vnic_details': :'createVnicDetails',
    'display_name': :'displayName',
    'instance_id': :'instanceId',
    'nic_index': :'nicIndex'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'create_vnic_details': :'OCI::Core::Models::CreateVnicDetails',
    'display_name': :'String',
    'instance_id': :'String',
    'nic_index': :'Integer'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 105

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    create_vnic_details == other.create_vnic_details &&
    display_name == other.display_name &&
    instance_id == other.instance_id &&
    nic_index == other.nic_index
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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 138

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


118
119
120
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 118

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



127
128
129
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 127

def hash
  [create_vnic_details, display_name, instance_id, nic_index].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 171

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



165
166
167
 
# File 'lib/oci/core/models/attach_vnic_details.rb', line 165

def to_s
  to_hash.to_s
end