Class: OCI::Core::Models::Ipv6
- Inherits:
-
Object
- Object
- OCI::Core::Models::Ipv6
- Defined in:
- lib/oci/core/models/ipv6.rb
Overview
An IPv6 is a conceptual term that refers to an IPv6 address and related properties. The ‘IPv6` object is the API representation of an IPv6.
You can create and assign an IPv6 to any VNIC that is in an IPv6-enabled subnet in an IPv6-enabled VCN.
For important details about IPv6 addressing in a VCN, see [IPv6 Addresses](docs.cloud.oracle.com/Content/Network/Concepts/ipv6.htm).
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze, LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze, LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze, LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the IPv6.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the IPv6.
-
#ip_address ⇒ String
[Required] The IPv6 address of the ‘IPv6` object.
-
#is_internet_access_allowed ⇒ BOOLEAN
Whether the IPv6 can be used for internet communication.
-
#lifecycle_state ⇒ String
[Required] The IPv6’s current state.
-
#public_ip_address ⇒ String
The IPv6 address to be used for internet communication.
-
#subnet_id ⇒ String
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in.
-
#time_created ⇒ DateTime
[Required] The date and time the IPv6 was created, in the format defined by RFC3339.
-
#vnic_id ⇒ String
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VNIC the IPv6 is assigned to.
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 = {}) ⇒ Ipv6
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 = {}) ⇒ Ipv6
Initializes the object
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 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/oci/core/models/ipv6.rb', line 174 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.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. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] 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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self.id = attributes[:'id'] if attributes[:'id'] self.ip_address = attributes[:'ipAddress'] if attributes[:'ipAddress'] raise 'You cannot provide both :ipAddress and :ip_address' if attributes.key?(:'ipAddress') && attributes.key?(:'ip_address') self.ip_address = attributes[:'ip_address'] if attributes[:'ip_address'] self.is_internet_access_allowed = attributes[:'isInternetAccessAllowed'] unless attributes[:'isInternetAccessAllowed'].nil? raise 'You cannot provide both :isInternetAccessAllowed and :is_internet_access_allowed' if attributes.key?(:'isInternetAccessAllowed') && attributes.key?(:'is_internet_access_allowed') self.is_internet_access_allowed = attributes[:'is_internet_access_allowed'] unless attributes[:'is_internet_access_allowed'].nil? 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.public_ip_address = attributes[:'publicIpAddress'] if attributes[:'publicIpAddress'] raise 'You cannot provide both :publicIpAddress and :public_ip_address' if attributes.key?(:'publicIpAddress') && attributes.key?(:'public_ip_address') self.public_ip_address = attributes[:'public_ip_address'] if attributes[:'public_ip_address'] 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.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
#compartment_id ⇒ String
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the IPv6. This is the same as the VNIC’s compartment.
29 30 31 |
# File 'lib/oci/core/models/ipv6.rb', line 29 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘{"CostCenter": "42"}`
37 38 39 |
# File 'lib/oci/core/models/ipv6.rb', line 37 def @defined_tags end |
#display_name ⇒ String
[Required] A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
43 44 45 |
# File 'lib/oci/core/models/ipv6.rb', line 43 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘"Finance"`
51 52 53 |
# File 'lib/oci/core/models/ipv6.rb', line 51 def @freeform_tags end |
#id ⇒ String
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the IPv6.
55 56 57 |
# File 'lib/oci/core/models/ipv6.rb', line 55 def id @id end |
#ip_address ⇒ String
[Required] The IPv6 address of the ‘IPv6` object. The address is within the private IPv6 CIDR block of the VNIC’s subnet (see the ‘ipv6CidrBlock` attribute for the Subnet object).
Example: ‘2001:0db8:0123:1111:abcd:ef01:2345:6789`
64 65 66 |
# File 'lib/oci/core/models/ipv6.rb', line 64 def ip_address @ip_address end |
#is_internet_access_allowed ⇒ BOOLEAN
Whether the IPv6 can be used for internet communication. Allowed by default for an IPv6 in a public subnet. Never allowed for an IPv6 in a private subnet. If the value is ‘true`, the IPv6 uses its public IP address for internet communication.
Example: ‘true`
73 74 75 |
# File 'lib/oci/core/models/ipv6.rb', line 73 def is_internet_access_allowed @is_internet_access_allowed end |
#lifecycle_state ⇒ String
[Required] The IPv6’s current state.
77 78 79 |
# File 'lib/oci/core/models/ipv6.rb', line 77 def lifecycle_state @lifecycle_state end |
#public_ip_address ⇒ String
The IPv6 address to be used for internet communication. The address is within the public IPv6 CIDR block of the VNIC’s subnet (see the ‘ipv6PublicCidrBlock` attribute for the Subnet object).
If your organization did NOT assign a custom IPv6 CIDR to the VCN for the private address space, Oracle provides the IPv6 CIDR and uses that same CIDR for the private and public address space. Therefore the ‘publicIpAddress` would be the same as the `ipAddress`.
If your organization assigned a custom IPv6 CIDR to the VCN for the private address space, the right 80 bits of the IPv6 public IP (the subnet and address bits) are the same as for the ‘ipAddress`. But the left 48 bits are from the public IPv6 CIDR that Oracle assigned to the VCN.
This is null if the IPv6 is created with ‘isInternetAccessAllowed` set to `false`.
Example: ‘2001:0db8:0123:1111:abcd:ef01:2345:6789`
97 98 99 |
# File 'lib/oci/core/models/ipv6.rb', line 97 def public_ip_address @public_ip_address end |
#subnet_id ⇒ String
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in.
101 102 103 |
# File 'lib/oci/core/models/ipv6.rb', line 101 def subnet_id @subnet_id end |
#time_created ⇒ DateTime
[Required] The date and time the IPv6 was created, in the format defined by RFC3339.
Example: ‘2016-08-25T21:10:29.600Z`
108 109 110 |
# File 'lib/oci/core/models/ipv6.rb', line 108 def time_created @time_created end |
#vnic_id ⇒ String
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the VNIC the IPv6 is assigned to. The VNIC and IPv6 must be in the same subnet.
114 115 116 |
# File 'lib/oci/core/models/ipv6.rb', line 114 def vnic_id @vnic_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/oci/core/models/ipv6.rb', line 117 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'freeform_tags': :'freeformTags', 'id': :'id', 'ip_address': :'ipAddress', 'is_internet_access_allowed': :'isInternetAccessAllowed', 'lifecycle_state': :'lifecycleState', 'public_ip_address': :'publicIpAddress', 'subnet_id': :'subnetId', 'time_created': :'timeCreated', 'vnic_id': :'vnicId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/oci/core/models/ipv6.rb', line 137 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'freeform_tags': :'Hash<String, String>', 'id': :'String', 'ip_address': :'String', 'is_internet_access_allowed': :'BOOLEAN', 'lifecycle_state': :'String', 'public_ip_address': :'String', 'subnet_id': :'String', 'time_created': :'DateTime', 'vnic_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/oci/core/models/ipv6.rb', line 269 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && == other. && display_name == other.display_name && == other. && id == other.id && ip_address == other.ip_address && is_internet_access_allowed == other.is_internet_access_allowed && lifecycle_state == other.lifecycle_state && public_ip_address == other.public_ip_address && subnet_id == other.subnet_id && time_created == other.time_created && vnic_id == other.vnic_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
# File 'lib/oci/core/models/ipv6.rb', line 310 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
290 291 292 |
# File 'lib/oci/core/models/ipv6.rb', line 290 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
299 300 301 |
# File 'lib/oci/core/models/ipv6.rb', line 299 def hash [compartment_id, , display_name, , id, ip_address, is_internet_access_allowed, lifecycle_state, public_ip_address, subnet_id, time_created, vnic_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
343 344 345 346 347 348 349 350 351 352 |
# File 'lib/oci/core/models/ipv6.rb', line 343 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
337 338 339 |
# File 'lib/oci/core/models/ipv6.rb', line 337 def to_s to_hash.to_s end |