Class: OCI::Core::Models::Subnet

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

Overview

A logical subdivision of a VCN. Each subnet consists of a contiguous range of IP addresses that do not overlap with other subnets in the VCN. Example: 172.16.1.0/24. For more information, see Overview of the Networking Service and VCNs and Subnets.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

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_UPDATING = 'UPDATING'.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 = {}) ⇒ Subnet

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :cidr_block (String) —

    The value to assign to the #cidr_block property

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

  • :dhcp_options_id (String) —

    The value to assign to the #dhcp_options_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :dns_label (String) —

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

  • :ipv6_cidr_block (String) —

    The value to assign to the #ipv6_cidr_block property

  • :ipv6_cidr_blocks (Array<String>) —

    The value to assign to the #ipv6_cidr_blocks property

  • :ipv6_virtual_router_ip (String) —

    The value to assign to the #ipv6_virtual_router_ip property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :prohibit_internet_ingress (BOOLEAN) —

    The value to assign to the #prohibit_internet_ingress property

  • :prohibit_public_ip_on_vnic (BOOLEAN) —

    The value to assign to the #prohibit_public_ip_on_vnic property

  • :route_table_id (String) —

    The value to assign to the #route_table_id property

  • :security_list_ids (Array<String>) —

    The value to assign to the #security_list_ids property

  • :subnet_domain_name (String) —

    The value to assign to the #subnet_domain_name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :vcn_id (String) —

    The value to assign to the #vcn_id property

  • :virtual_router_ip (String) —

    The value to assign to the #virtual_router_ip property

  • :virtual_router_mac (String) —

    The value to assign to the #virtual_router_mac property



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/oci/core/models/subnet.rb', line 288

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

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

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

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

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

  self.dhcp_options_id = attributes[:'dhcp_options_id'] if attributes[:'dhcp_options_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.dns_label = attributes[:'dnsLabel'] if attributes[:'dnsLabel']

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

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

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

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

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

  self.ipv6_cidr_blocks = attributes[:'ipv6CidrBlocks'] if attributes[:'ipv6CidrBlocks']

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

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

  self.ipv6_virtual_router_ip = attributes[:'ipv6VirtualRouterIp'] if attributes[:'ipv6VirtualRouterIp']

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

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

  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.prohibit_internet_ingress = attributes[:'prohibitInternetIngress'] unless attributes[:'prohibitInternetIngress'].nil?

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

  self.prohibit_internet_ingress = attributes[:'prohibit_internet_ingress'] unless attributes[:'prohibit_internet_ingress'].nil?

  self.prohibit_public_ip_on_vnic = attributes[:'prohibitPublicIpOnVnic'] unless attributes[:'prohibitPublicIpOnVnic'].nil?

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

  self.prohibit_public_ip_on_vnic = attributes[:'prohibit_public_ip_on_vnic'] unless attributes[:'prohibit_public_ip_on_vnic'].nil?

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

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

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

  self.subnet_domain_name = attributes[:'subnetDomainName'] if attributes[:'subnetDomainName']

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

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

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

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

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

  self.virtual_router_ip = attributes[:'virtualRouterIp'] if attributes[:'virtualRouterIp']

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

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

  self.virtual_router_mac = attributes[:'virtualRouterMac'] if attributes[:'virtualRouterMac']

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

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

Instance Attribute Details

#availability_domain ⇒ String

The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


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

def availability_domain
  @availability_domain
end

#cidr_block ⇒ String

[Required] The subnet's CIDR block.

Example: 10.0.1.0/24

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/core/models/subnet.rb', line 43

def cidr_block
  @cidr_block
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the subnet.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/core/models/subnet.rb', line 47

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


55
56
57
 
# File 'lib/oci/core/models/subnet.rb', line 55

def defined_tags
  @defined_tags
end

#dhcp_options_id ⇒ String

The OCID of the set of DHCP options that the subnet uses.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/core/models/subnet.rb', line 60

def dhcp_options_id
  @dhcp_options_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#dns_label ⇒ String

A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed.

The absence of this parameter means the Internet and VCN Resolver will not resolve hostnames of instances in this subnet.

For more information, see DNS in Your Virtual Cloud Network.

Example: subnet123

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/core/models/subnet.rb', line 83

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


91
92
93
 
# File 'lib/oci/core/models/subnet.rb', line 91

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The subnet's Oracle ID (OCID).

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/core/models/subnet.rb', line 95

def id
  @id
end

#ipv6_cidr_block ⇒ String

For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses.

Example: 2001:0db8:0123:1111::/64

Returns:

  • (String) 


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

def ipv6_cidr_block
  @ipv6_cidr_block
end

#ipv6_cidr_blocks ⇒ Array<String>

The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.

Returns:

  • (Array<String>) 


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

def ipv6_cidr_blocks
  @ipv6_cidr_blocks
end

#ipv6_virtual_router_ip ⇒ String

For an IPv6-enabled subnet, this is the IPv6 address of the virtual router.

Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678

Returns:

  • (String) 


115
116
117
 
# File 'lib/oci/core/models/subnet.rb', line 115

def ipv6_virtual_router_ip
  @ipv6_virtual_router_ip
end

#lifecycle_state ⇒ String

[Required] The subnet's current state.

Returns:

  • (String) 


119
120
121
 
# File 'lib/oci/core/models/subnet.rb', line 119

def lifecycle_state
  @lifecycle_state
end

#prohibit_internet_ingress ⇒ BOOLEAN

Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.

For IPV4, prohibitInternetIngress behaves similarly to prohibitPublicIpOnVnic. If it is set to false, VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitInternetIngress is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a privatesubnet).

For IPv6, if prohibitInternetIngress is set to true, internet access is not allowed for any IPv6s assigned to VNICs in the subnet. Otherwise, ingress internet traffic is allowed by default.

Example: true

Returns:

  • (BOOLEAN) 


136
137
138
 
# File 'lib/oci/core/models/subnet.rb', line 136

def prohibit_internet_ingress
  @prohibit_internet_ingress
end

#prohibit_public_ip_on_vnic ⇒ BOOLEAN

Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet).

Example: true

Returns:

  • (BOOLEAN) 


151
152
153
 
# File 'lib/oci/core/models/subnet.rb', line 151

def prohibit_public_ip_on_vnic
  @prohibit_public_ip_on_vnic
end

#route_table_id ⇒ String

[Required] The OCID of the route table that the subnet uses.

Returns:

  • (String) 


155
156
157
 
# File 'lib/oci/core/models/subnet.rb', line 155

def route_table_id
  @route_table_id
end

#security_list_ids ⇒ Array<String>

The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.

Returns:

  • (Array<String>) 


162
163
164
 
# File 'lib/oci/core/models/subnet.rb', line 162

def security_list_ids
  @security_list_ids
end

#subnet_domain_name ⇒ String

The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the oraclevcn.com domain.

For more information, see DNS in Your Virtual Cloud Network.

Example: subnet123.vcn1.oraclevcn.com

Returns:

  • (String) 


173
174
175
 
# File 'lib/oci/core/models/subnet.rb', line 173

def subnet_domain_name
  @subnet_domain_name
end

#time_created ⇒ DateTime

The date and time the subnet was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


180
181
182
 
# File 'lib/oci/core/models/subnet.rb', line 180

def time_created
  @time_created
end

#vcn_id ⇒ String

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

Returns:

  • (String) 


184
185
186
 
# File 'lib/oci/core/models/subnet.rb', line 184

def vcn_id
  @vcn_id
end

#virtual_router_ip ⇒ String

[Required] The IP address of the virtual router.

Example: 10.0.14.1

Returns:

  • (String) 


191
192
193
 
# File 'lib/oci/core/models/subnet.rb', line 191

def virtual_router_ip
  @virtual_router_ip
end

#virtual_router_mac ⇒ String

[Required] The MAC address of the virtual router.

Example: 00:00:00:00:00:01

Returns:

  • (String) 


198
199
200
 
# File 'lib/oci/core/models/subnet.rb', line 198

def virtual_router_mac
  @virtual_router_mac
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'cidr_block': :'cidrBlock',
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'dhcp_options_id': :'dhcpOptionsId',
    'display_name': :'displayName',
    'dns_label': :'dnsLabel',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'ipv6_cidr_block': :'ipv6CidrBlock',
    'ipv6_cidr_blocks': :'ipv6CidrBlocks',
    'ipv6_virtual_router_ip': :'ipv6VirtualRouterIp',
    'lifecycle_state': :'lifecycleState',
    'prohibit_internet_ingress': :'prohibitInternetIngress',
    'prohibit_public_ip_on_vnic': :'prohibitPublicIpOnVnic',
    'route_table_id': :'routeTableId',
    'security_list_ids': :'securityListIds',
    'subnet_domain_name': :'subnetDomainName',
    'time_created': :'timeCreated',
    'vcn_id': :'vcnId',
    'virtual_router_ip': :'virtualRouterIp',
    'virtual_router_mac': :'virtualRouterMac'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'cidr_block': :'String',
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'dhcp_options_id': :'String',
    'display_name': :'String',
    'dns_label': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'ipv6_cidr_block': :'String',
    'ipv6_cidr_blocks': :'Array<String>',
    'ipv6_virtual_router_ip': :'String',
    'lifecycle_state': :'String',
    'prohibit_internet_ingress': :'BOOLEAN',
    'prohibit_public_ip_on_vnic': :'BOOLEAN',
    'route_table_id': :'String',
    'security_list_ids': :'Array<String>',
    'subnet_domain_name': :'String',
    'time_created': :'DateTime',
    'vcn_id': :'String',
    'virtual_router_ip': :'String',
    'virtual_router_mac': :'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



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/oci/core/models/subnet.rb', line 443

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    cidr_block == other.cidr_block &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    dhcp_options_id == other.dhcp_options_id &&
    display_name == other.display_name &&
    dns_label == other.dns_label &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    ipv6_cidr_block == other.ipv6_cidr_block &&
    ipv6_cidr_blocks == other.ipv6_cidr_blocks &&
    ipv6_virtual_router_ip == other.ipv6_virtual_router_ip &&
    lifecycle_state == other.lifecycle_state &&
    prohibit_internet_ingress == other.prohibit_internet_ingress &&
    prohibit_public_ip_on_vnic == other.prohibit_public_ip_on_vnic &&
    route_table_id == other.route_table_id &&
    security_list_ids == other.security_list_ids &&
    subnet_domain_name == other.subnet_domain_name &&
    time_created == other.time_created &&
    vcn_id == other.vcn_id &&
    virtual_router_ip == other.virtual_router_ip &&
    virtual_router_mac == other.virtual_router_mac
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



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/oci/core/models/subnet.rb', line 494

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


474
475
476
 
# File 'lib/oci/core/models/subnet.rb', line 474

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



483
484
485
 
# File 'lib/oci/core/models/subnet.rb', line 483

def hash
  [availability_domain, cidr_block, compartment_id, defined_tags, dhcp_options_id, display_name, dns_label, freeform_tags, id, ipv6_cidr_block, ipv6_cidr_blocks, ipv6_virtual_router_ip, lifecycle_state, prohibit_internet_ingress, prohibit_public_ip_on_vnic, route_table_id, security_list_ids, subnet_domain_name, time_created, vcn_id, virtual_router_ip, virtual_router_mac].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



527
528
529
530
531
532
533
534
535
536
 
# File 'lib/oci/core/models/subnet.rb', line 527

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



521
522
523
 
# File 'lib/oci/core/models/subnet.rb', line 521

def to_s
  to_hash.to_s
end