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 supported for all commercial and government 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
IP_STATE_ENUM = 
[
  IP_STATE_ASSIGNED = 'ASSIGNED'.freeze,
  IP_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  IP_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFETIME_ENUM = 
[
  LIFETIME_EPHEMERAL = 'EPHEMERAL'.freeze,
  LIFETIME_RESERVED = 'RESERVED'.freeze,
  LIFETIME_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

  • :cidr_prefix_length (Integer) —

    The value to assign to the #cidr_prefix_length property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state 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

  • :ip_state (String) —

    The value to assign to the #ip_state property

  • :lifetime (String) —

    The value to assign to the #lifetime property

  • :route_table_id (String) —

    The value to assign to the #route_table_id property

  • :hostname (String) —

    The value to assign to the #hostname property



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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/oci/core/models/ipv6.rb', line 196

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

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

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

  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.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']

  self.ip_state = attributes[:'ipState'] if attributes[:'ipState']

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

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

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

  self.route_table_id = attributes[:'routeTableId'] if attributes[:'routeTableId']

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

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

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

Instance Attribute Details

#cidr_prefix_length ⇒ Integer

Length of cidr range. Optional field to specify flexible cidr.

Returns:

  • (Integer) 


82
83
84
 
# File 'lib/oci/core/models/ipv6.rb', line 82

def cidr_prefix_length
  @cidr_prefix_length
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the IPv6. This is the same as the VNIC's compartment.

Returns:

  • (String) 


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

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>>) 


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

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) 


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

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>) 


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

def freeform_tags
  @freeform_tags
end

#hostname ⇒ String

The hostname associated with the IPv6 address. Only the hostname label, not the FQDN.

Returns:

  • (String) 


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

def hostname
  @hostname
end

#id ⇒ String

[Required] The OCID of the IPv6.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/core/models/ipv6.rb', line 70

def id
  @id
end

#ip_address ⇒ String

[Required] The IPv6 address of the IPv6 object. The address is within the IPv6 prefix of the VNIC's subnet (see the ipv6CidrBlock attribute for the Subnet object.

Example: 2001:0db8:0123:1111:abcd:ef01:2345:6789

Returns:

  • (String) 


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

def ip_address
  @ip_address
end

#ip_state ⇒ String

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE.

Returns:

  • (String) 


108
109
110
 
# File 'lib/oci/core/models/ipv6.rb', line 108

def ip_state
  @ip_state
end

#lifecycle_state ⇒ String

[Required] The IPv6's current state.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/core/models/ipv6.rb', line 86

def lifecycle_state
  @lifecycle_state
end

#lifetime ⇒ String

Lifetime of the IP address. There are two types of IPs: - Ephemeral - Reserved

Returns:

  • (String) 


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

def lifetime
  @lifetime
end

#route_table_id ⇒ String

The OCID of the route table the IP address or VNIC will use. For more information, see Per-resource Routing.

Returns:

  • (String) 


122
123
124
 
# File 'lib/oci/core/models/ipv6.rb', line 122

def route_table_id
  @route_table_id
end

#subnet_id ⇒ String

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

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/core/models/ipv6.rb', line 90

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) 


97
98
99
 
# File 'lib/oci/core/models/ipv6.rb', line 97

def time_created
  @time_created
end

#vnic_id ⇒ String

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

Returns:

  • (String) 


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

def vnic_id
  @vnic_id
end

Class Method Details

.attribute_map ⇒ Object

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/core/models/ipv6.rb', line 130

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',
    'cidr_prefix_length': :'cidrPrefixLength',
    'lifecycle_state': :'lifecycleState',
    'subnet_id': :'subnetId',
    'time_created': :'timeCreated',
    'vnic_id': :'vnicId',
    'ip_state': :'ipState',
    'lifetime': :'lifetime',
    'route_table_id': :'routeTableId',
    'hostname': :'hostname'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/core/models/ipv6.rb', line 153

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',
    'cidr_prefix_length': :'Integer',
    'lifecycle_state': :'String',
    'subnet_id': :'String',
    'time_created': :'DateTime',
    'vnic_id': :'String',
    'ip_state': :'String',
    'lifetime': :'String',
    'route_table_id': :'String',
    'hostname': :'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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/oci/core/models/ipv6.rb', line 327

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 &&
    cidr_prefix_length == other.cidr_prefix_length &&
    lifecycle_state == other.lifecycle_state &&
    subnet_id == other.subnet_id &&
    time_created == other.time_created &&
    vnic_id == other.vnic_id &&
    ip_state == other.ip_state &&
    lifetime == other.lifetime &&
    route_table_id == other.route_table_id &&
    hostname == other.hostname
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



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/oci/core/models/ipv6.rb', line 371

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


351
352
353
 
# File 'lib/oci/core/models/ipv6.rb', line 351

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



360
361
362
 
# File 'lib/oci/core/models/ipv6.rb', line 360

def hash
  [compartment_id, defined_tags, display_name, freeform_tags, id, ip_address, cidr_prefix_length, lifecycle_state, subnet_id, time_created, vnic_id, ip_state, lifetime, route_table_id, hostname].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



404
405
406
407
408
409
410
411
412
413
 
# File 'lib/oci/core/models/ipv6.rb', line 404

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



398
399
400
 
# File 'lib/oci/core/models/ipv6.rb', line 398

def to_s
  to_hash.to_s
end