Class: OCI::Core::Models::VnicAttachment
- Inherits:
-
Object
- Object
- OCI::Core::Models::VnicAttachment
- Defined in:
- lib/oci/core/models/vnic_attachment.rb
Overview
Represents an attachment between a VNIC and an instance. For more information, see [Virtual Network Interface Cards (VNICs)](docs.cloud.oracle.com/Content/Network/Tasks/managingVNICs.htm).
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_ATTACHING = 'ATTACHING'.freeze, LIFECYCLE_STATE_ATTACHED = 'ATTACHED'.freeze, LIFECYCLE_STATE_DETACHING = 'DETACHING'.freeze, LIFECYCLE_STATE_DETACHED = 'DETACHED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#availability_domain ⇒ String
[Required] The availability domain of the instance.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment the VNIC attachment is in, which is the same compartment the instance is in.
-
#display_name ⇒ String
A user-friendly name.
-
#id ⇒ String
[Required] The OCID of the VNIC attachment.
-
#instance_id ⇒ String
[Required] The OCID of the instance.
-
#lifecycle_state ⇒ String
[Required] The current state of the VNIC attachment.
-
#nic_index ⇒ Integer
Which physical network interface card (NIC) the VNIC uses.
-
#subnet_id ⇒ String
[Required] The OCID of the VNIC’s subnet.
-
#time_created ⇒ DateTime
[Required] The date and time the VNIC attachment was created, in the format defined by RFC3339.
-
#vlan_tag ⇒ Integer
The Oracle-assigned VLAN tag of the attached VNIC.
-
#vnic_id ⇒ String
The OCID of the VNIC.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ VnicAttachment
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ VnicAttachment
Initializes the object
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 208 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 141 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.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain'] raise 'You cannot provide both :availabilityDomain and :availability_domain' if attributes.key?(:'availabilityDomain') && attributes.key?(:'availability_domain') self.availability_domain = attributes[:'availability_domain'] if attributes[:'availability_domain'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] 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.id = attributes[:'id'] if attributes[:'id'] 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.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] 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'] self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId'] raise 'You cannot provide both :subnetId and :subnet_id' if attributes.key?(:'subnetId') && attributes.key?(:'subnet_id') self.subnet_id = attributes[:'subnet_id'] if attributes[:'subnet_id'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.vlan_tag = attributes[:'vlanTag'] if attributes[:'vlanTag'] raise 'You cannot provide both :vlanTag and :vlan_tag' if attributes.key?(:'vlanTag') && attributes.key?(:'vlan_tag') self.vlan_tag = attributes[:'vlan_tag'] if attributes[:'vlan_tag'] self.vnic_id = attributes[:'vnicId'] if attributes[:'vnicId'] raise 'You cannot provide both :vnicId and :vnic_id' if attributes.key?(:'vnicId') && attributes.key?(:'vnic_id') self.vnic_id = attributes[:'vnic_id'] if attributes[:'vnic_id'] end |
Instance Attribute Details
#availability_domain ⇒ String
[Required] The availability domain of the instance.
Example: ‘Uocm:PHX-AD-1`
28 29 30 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 28 def availability_domain @availability_domain end |
#compartment_id ⇒ String
[Required] The OCID of the compartment the VNIC attachment is in, which is the same compartment the instance is in.
34 35 36 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 34 def compartment_id @compartment_id end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique. Avoid entering confidential information.
40 41 42 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 40 def display_name @display_name end |
#id ⇒ String
[Required] The OCID of the VNIC attachment.
44 45 46 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 44 def id @id end |
#instance_id ⇒ String
[Required] The OCID of the instance.
48 49 50 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 48 def instance_id @instance_id end |
#lifecycle_state ⇒ String
[Required] The current state of the VNIC attachment.
52 53 54 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 52 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.cloud.oracle.com/Content/Network/Tasks/managingVNICs.htm).
61 62 63 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 61 def nic_index @nic_index end |
#subnet_id ⇒ String
[Required] The OCID of the VNIC’s subnet.
65 66 67 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 65 def subnet_id @subnet_id end |
#time_created ⇒ DateTime
[Required] The date and time the VNIC attachment was created, in the format defined by RFC3339.
Example: ‘2016-08-25T21:10:29.600Z`
72 73 74 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 72 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`
80 81 82 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 80 def vlan_tag @vlan_tag end |
#vnic_id ⇒ String
The OCID of the VNIC. Available after the attachment process is complete.
84 85 86 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 84 def vnic_id @vnic_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 87 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'availability_domain': :'availabilityDomain', 'compartment_id': :'compartmentId', 'display_name': :'displayName', 'id': :'id', 'instance_id': :'instanceId', 'lifecycle_state': :'lifecycleState', 'nic_index': :'nicIndex', 'subnet_id': :'subnetId', 'time_created': :'timeCreated', 'vlan_tag': :'vlanTag', 'vnic_id': :'vnicId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 106 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'availability_domain': :'String', 'compartment_id': :'String', 'display_name': :'String', 'id': :'String', 'instance_id': :'String', 'lifecycle_state': :'String', 'nic_index': :'Integer', 'subnet_id': :'String', 'time_created': :'DateTime', 'vlan_tag': :'Integer', 'vnic_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 230 def ==(other) return true if equal?(other) self.class == other.class && availability_domain == other.availability_domain && compartment_id == other.compartment_id && display_name == other.display_name && id == other.id && instance_id == other.instance_id && lifecycle_state == other.lifecycle_state && nic_index == other.nic_index && subnet_id == other.subnet_id && time_created == other.time_created && vlan_tag == other.vlan_tag && vnic_id == other.vnic_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 270 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
250 251 252 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 250 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
259 260 261 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 259 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
303 304 305 306 307 308 309 310 311 312 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 303 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
297 298 299 |
# File 'lib/oci/core/models/vnic_attachment.rb', line 297 def to_s to_hash.to_s end |