Class: OCI::Core::Models::VnicAttachment

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

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_ATTACHING = 'ATTACHING',
LIFECYCLE_STATE_ATTACHED = 'ATTACHED',
LIFECYCLE_STATE_DETACHING = 'DETACHING',
LIFECYCLE_STATE_DETACHED = 'DETACHED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VnicAttachment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 80

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}

  if attributes[:'availabilityDomain']
    self.availability_domain = attributes[:'availabilityDomain']
  end

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

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

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

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

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

  if attributes[:'subnetId']
    self.subnet_id = attributes[:'subnetId']
  end

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

  if attributes[:'vlanTag']
    self.vlan_tag = attributes[:'vlanTag']
  end

  if attributes[:'vnicId']
    self.vnic_id = attributes[:'vnicId']
  end

end

Instance Attribute Details

#availability_domain ⇒ String

The Availability Domain of the instance.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 19

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

The OCID of the compartment the VNIC attachment is in, which is the same compartment the instance is in.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 25

def compartment_id
  @compartment_id
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique. Avoid entering confidential information.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#id ⇒ String

The OCID of the VNIC attachment.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 35

def id
  @id
end

#instance_id ⇒ String

The OCID of the instance.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 39

def instance_id
  @instance_id
end

#lifecycle_state ⇒ String

The current state of the VNIC attachment.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 43

def lifecycle_state
  @lifecycle_state
end

#nic_index ⇒ Integer

Which physical network interface card (NIC) the VNIC uses. 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.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm).

Returns:

  • (Integer) 


52
53
54
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 52

def nic_index
  @nic_index
end

#subnet_id ⇒ String

The OCID of the VNIC’s subnet.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 56

def subnet_id
  @subnet_id
end

#time_created ⇒ DateTime

The date and time the VNIC attachment was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


63
64
65
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 63

def time_created
  @time_created
end

#vlan_tag ⇒ Integer

The Oracle-assigned VLAN tag of the attached VNIC. Available after the attachment process is complete.

Example: ‘0`

Returns:

  • (Integer) 


71
72
73
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 71

def vlan_tag
  @vlan_tag
end

#vnic_id ⇒ String

The OCID of the VNIC. Available after the attachment process is complete.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 75

def vnic_id
  @vnic_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 144

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      availability_domain == other_object.availability_domain &&
      compartment_id == other_object.compartment_id &&
      display_name == other_object.display_name &&
      id == other_object.id &&
      instance_id == other_object.instance_id &&
      lifecycle_state == other_object.lifecycle_state &&
      nic_index == other_object.nic_index &&
      subnet_id == other_object.subnet_id &&
      time_created == other_object.time_created &&
      vlan_tag == other_object.vlan_tag &&
      vnic_id == other_object.vnic_id
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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 175

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


162
163
164
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 162

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 168

def hash
  [availability_domain, compartment_id, display_name, id, instance_id, lifecycle_state, nic_index, subnet_id, time_created, vlan_tag, vnic_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



200
201
202
203
204
205
206
207
208
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 200

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



194
195
196
 
# File 'lib/oci/core/models/vnic_attachment.rb', line 194

def to_s
  to_hash.to_s
end