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 exists in a single Availability Domain and 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](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm) and [VCNs and Subnets](docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVCNs.htm).

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](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

Constant Summary collapse

LIFECYCLE_STATE_ENUM =

rubocop:disable Metrics/LineLength

[
  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 = {}) ⇒ 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

  • :lifecycle_state (String) —

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



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
280
281
282
283
284
285
286
287
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
 
# File 'lib/oci/core/models/subnet.rb', line 233

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.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_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

[Required] The subnet’s Availability Domain.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/core/models/subnet.rb', line 32

def availability_domain
  @availability_domain
end

#cidr_block ⇒ String

[Required] The subnet’s CIDR block.

Example: ‘172.16.1.0/24`

Returns:

  • (String) 


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

def cidr_block
  @cidr_block
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`

Returns:

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


51
52
53
 
# File 'lib/oci/core/models/subnet.rb', line 51

def defined_tags
  @defined_tags
end

#dhcp_options_id ⇒ String

The OCID of the set of DHCP options associated with the subnet.

Returns:

  • (String) 


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

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) 


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

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, ‘bminstance-1.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](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).

Example: ‘subnet123`

Returns:

  • (String) 


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

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](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


88
89
90
 
# File 'lib/oci/core/models/subnet.rb', line 88

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The subnet’s current state.

Returns:

  • (String) 


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

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


111
112
113
 
# File 'lib/oci/core/models/subnet.rb', line 111

def prohibit_public_ip_on_vnic
  @prohibit_public_ip_on_vnic
end

#route_table_id ⇒ String

[Required] The OCID of the route table the subnet is using.

Returns:

  • (String) 


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

def route_table_id
  @route_table_id
end

#security_list_ids ⇒ Array<String>

OCIDs for the security lists to use for VNICs in this subnet.

Returns:

  • (Array<String>) 


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

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](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).

Example: ‘subnet123.vcn1.oraclevcn.com`

Returns:

  • (String) 


130
131
132
 
# File 'lib/oci/core/models/subnet.rb', line 130

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) 


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

def time_created
  @time_created
end

#vcn_id ⇒ String

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

Returns:

  • (String) 


141
142
143
 
# File 'lib/oci/core/models/subnet.rb', line 141

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) 


148
149
150
 
# File 'lib/oci/core/models/subnet.rb', line 148

def virtual_router_ip
  @virtual_router_ip
end

#virtual_router_mac ⇒ String

[Required] The MAC address of the virtual router.

Example: ‘00:00:17:B6:4D:DD`

Returns:

  • (String) 


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

def virtual_router_mac
  @virtual_router_mac
end

Class Method Details

.attribute_map ⇒ Object

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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/core/models/subnet.rb', line 158

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',
    'lifecycle_state': :'lifecycleState',
    '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.



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/subnet.rb', line 184

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',
    'lifecycle_state': :'String',
    '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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/oci/core/models/subnet.rb', line 366

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 &&
    lifecycle_state == other.lifecycle_state &&
    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



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/oci/core/models/subnet.rb', line 412

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


392
393
394
 
# File 'lib/oci/core/models/subnet.rb', line 392

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



401
402
403
 
# File 'lib/oci/core/models/subnet.rb', line 401

def hash
  [availability_domain, cidr_block, compartment_id, defined_tags, dhcp_options_id, display_name, dns_label, freeform_tags, id, lifecycle_state, 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



444
445
446
447
448
449
450
451
452
 
# File 'lib/oci/core/models/subnet.rb', line 444

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



438
439
440
 
# File 'lib/oci/core/models/subnet.rb', line 438

def to_s
  to_hash.to_s
end