Class: OCI::Core::Models::Ipv6

Inherits:
Object
  • Object
show all
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.

Note: IPv6 addressing is currently supported only in certain regions. For important details about IPv6 addressing in a VCN, see IPv6 Addresses.

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ipv6

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :id (String) —

    The value to assign to the #id property

  • :ip_address (String) —

    The value to assign to the #ip_address property

  • :is_internet_access_allowed (BOOLEAN) —

    The value to assign to the #is_internet_access_allowed property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :public_ip_address (String) —

    The value to assign to the #public_ip_address property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :vnic_id (String) —

    The value to assign to the #vnic_id property



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
248
249
 
# File 'lib/oci/core/models/ipv6.rb', line 176

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.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

  self.defined_tags = 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.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

  self.freeform_tags = 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 of the compartment containing the IPv6. This is the same as the VNIC's compartment.

Returns:

  • (String) 


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

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.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def defined_tags
  @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.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/core/models/ipv6.rb', line 45

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.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


53
54
55
 
# File 'lib/oci/core/models/ipv6.rb', line 53

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the IPv6.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/core/models/ipv6.rb', line 57

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

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/core/models/ipv6.rb', line 66

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

Returns:

  • (BOOLEAN) 


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

def is_internet_access_allowed
  @is_internet_access_allowed
end

#lifecycle_state ⇒ String

[Required] The IPv6's current state.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/core/models/ipv6.rb', line 79

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

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/core/models/ipv6.rb', line 99

def public_ip_address
  @public_ip_address
end

#subnet_id ⇒ String

[Required] The OCID of the subnet the VNIC is in.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/core/models/ipv6.rb', line 103

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

Returns:

  • (DateTime) 


110
111
112
 
# File 'lib/oci/core/models/ipv6.rb', line 110

def time_created
  @time_created
end

#vnic_id ⇒ String

[Required] The OCID of the VNIC the IPv6 is assigned to. The VNIC and IPv6 must be in the same subnet.

Returns:

  • (String) 


116
117
118
 
# File 'lib/oci/core/models/ipv6.rb', line 116

def vnic_id
  @vnic_id
end

Class Method Details

.attribute_map ⇒ Object

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/core/models/ipv6.rb', line 119

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.



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

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.

Parameters:

  • other (Object) —

    the other object to be compared



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/core/models/ipv6.rb', line 271

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/oci/core/models/ipv6.rb', line 312

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


292
293
294
 
# File 'lib/oci/core/models/ipv6.rb', line 292

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



301
302
303
 
# File 'lib/oci/core/models/ipv6.rb', line 301

def hash
  [compartment_id, defined_tags, display_name, freeform_tags, 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

Returns:

  • (Hash) —

    Returns the object in the form of hash



345
346
347
348
349
350
351
352
353
354
 
# File 'lib/oci/core/models/ipv6.rb', line 345

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



339
340
341
 
# File 'lib/oci/core/models/ipv6.rb', line 339

def to_s
  to_hash.to_s
end