Class: OCI::Core::Models::CreateIpv6Details

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

Overview

CreateIpv6Details model.

Constant Summary collapse

LIFETIME_ENUM = 
[
  LIFETIME_EPHEMERAL = 'EPHEMERAL'.freeze,
  LIFETIME_RESERVED = 'RESERVED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateIpv6Details

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :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

  • :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

  • :vnic_id (String) —

    The value to assign to the #vnic_id property

  • :subnet_id (String) —

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

  • :ipv6_subnet_cidr (String) —

    The value to assign to the #ipv6_subnet_cidr property

  • :hostname (String) —

    The value to assign to the #hostname property



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
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 143

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.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.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.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.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.lifetime = attributes[:'lifetime'] if attributes[:'lifetime']
  self.lifetime = "EPHEMERAL" if lifetime.nil? && !attributes.key?(:'lifetime') # rubocop:disable Style/StringLiterals

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

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

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

  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) 


50
51
52
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 50

def cidr_prefix_length
  @cidr_prefix_length
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>>) 


22
23
24
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 22

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 28

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


36
37
38
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 36

def freeform_tags
  @freeform_tags
end

#hostname ⇒ String

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

Returns:

  • (String) 


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

def hostname
  @hostname
end

#ip_address ⇒ String

An IPv6 address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns an IPv6 address from the subnet. The subnet is the one that contains the VNIC you specify in vnicId.

Example: 2001:DB8::

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 46

def ip_address
  @ip_address
end

#ipv6_subnet_cidr ⇒ String

The IPv6 prefix allocated to the subnet. This is required if more than one IPv6 prefix exists on the subnet.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 81

def ipv6_subnet_cidr
  @ipv6_subnet_cidr
end

#lifetime ⇒ String

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

Returns:

  • (String) 


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

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) 


76
77
78
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 76

def route_table_id
  @route_table_id
end

#subnet_id ⇒ String

The OCID of the subnet from which the IPv6 is to be drawn. The IP address, if supplied, must be valid for the given subnet, only valid for reserved IPs currently.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 62

def subnet_id
  @subnet_id
end

#vnic_id ⇒ String

The OCID of the VNIC to assign the IPv6 to. The IPv6 will be in the VNIC's subnet.

Returns:

  • (String) 


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

def vnic_id
  @vnic_id
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 89

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'ip_address': :'ipAddress',
    'cidr_prefix_length': :'cidrPrefixLength',
    'vnic_id': :'vnicId',
    'subnet_id': :'subnetId',
    'lifetime': :'lifetime',
    'route_table_id': :'routeTableId',
    'ipv6_subnet_cidr': :'ipv6SubnetCidr',
    'hostname': :'hostname'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 108

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'ip_address': :'String',
    'cidr_prefix_length': :'Integer',
    'vnic_id': :'String',
    'subnet_id': :'String',
    'lifetime': :'String',
    'route_table_id': :'String',
    'ipv6_subnet_cidr': :'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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 224

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

  self.class == other.class &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    ip_address == other.ip_address &&
    cidr_prefix_length == other.cidr_prefix_length &&
    vnic_id == other.vnic_id &&
    subnet_id == other.subnet_id &&
    lifetime == other.lifetime &&
    route_table_id == other.route_table_id &&
    ipv6_subnet_cidr == other.ipv6_subnet_cidr &&
    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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 264

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


244
245
246
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 244

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 253

def hash
  [defined_tags, display_name, freeform_tags, ip_address, cidr_prefix_length, vnic_id, subnet_id, lifetime, route_table_id, ipv6_subnet_cidr, hostname].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 297

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



291
292
293
 
# File 'lib/oci/core/models/create_ipv6_details.rb', line 291

def to_s
  to_hash.to_s
end