Class: OCI::Core::Models::Subnet
- Inherits:
-
Object
- Object
- OCI::Core::Models::Subnet
- 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 =
[LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING', LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE', LIFECYCLE_STATE_TERMINATING = 'TERMINATING', LIFECYCLE_STATE_TERMINATED = 'TERMINATED', LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
Instance Attribute Summary collapse
-
#availability_domain ⇒ String
[Required] The subnet’s Availability Domain.
-
#cidr_block ⇒ String
[Required] The subnet’s CIDR block.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the subnet.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#dhcp_options_id ⇒ String
The OCID of the set of DHCP options associated with the subnet.
-
#display_name ⇒ String
A user-friendly name.
-
#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`).
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The subnet’s Oracle ID (OCID).
-
#lifecycle_state ⇒ String
[Required] The subnet’s current state.
-
#prohibit_public_ip_on_vnic ⇒ BOOLEAN
Whether VNICs within this subnet can have public IP addresses.
-
#route_table_id ⇒ String
[Required] The OCID of the route table the subnet is using.
-
#security_list_ids ⇒ Array<String>
OCIDs for the security lists to use for VNICs in this subnet.
-
#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.
-
#time_created ⇒ DateTime
The date and time the subnet was created, in the format defined by RFC3339.
-
#vcn_id ⇒ String
[Required] The OCID of the VCN the subnet is in.
-
#virtual_router_ip ⇒ String
[Required] The IP address of the virtual router.
-
#virtual_router_mac ⇒ String
[Required] The MAC address of the virtual router.
Instance Method Summary collapse
-
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other_object) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Subnet
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Subnet
Initializes the object
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 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 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 343 344 345 346 347 348 349 350 351 352 353 354 355 |
# File 'lib/oci/core/models/subnet.rb', line 175 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} if attributes[:'availabilityDomain'] self.availability_domain = attributes[:'availabilityDomain'] end raise 'You cannot provide both :availabilityDomain and :availability_domain' if attributes.key?(:'availabilityDomain') && attributes.key?(:'availability_domain') if attributes[:'availability_domain'] self.availability_domain = attributes[:'availability_domain'] end if attributes[:'cidrBlock'] self.cidr_block = attributes[:'cidrBlock'] end raise 'You cannot provide both :cidrBlock and :cidr_block' if attributes.key?(:'cidrBlock') && attributes.key?(:'cidr_block') if attributes[:'cidr_block'] self.cidr_block = attributes[:'cidr_block'] end if attributes[:'compartmentId'] self.compartment_id = attributes[:'compartmentId'] end raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') if attributes[:'compartment_id'] self.compartment_id = attributes[:'compartment_id'] end if attributes[:'definedTags'] self. = attributes[:'definedTags'] end raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') if attributes[:'defined_tags'] self. = attributes[:'defined_tags'] end if attributes[:'dhcpOptionsId'] self. = attributes[:'dhcpOptionsId'] end raise 'You cannot provide both :dhcpOptionsId and :dhcp_options_id' if attributes.key?(:'dhcpOptionsId') && attributes.key?(:'dhcp_options_id') if attributes[:'dhcp_options_id'] self. = attributes[:'dhcp_options_id'] end if attributes[:'displayName'] self.display_name = attributes[:'displayName'] end raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') if attributes[:'display_name'] self.display_name = attributes[:'display_name'] end if attributes[:'dnsLabel'] self.dns_label = attributes[:'dnsLabel'] end raise 'You cannot provide both :dnsLabel and :dns_label' if attributes.key?(:'dnsLabel') && attributes.key?(:'dns_label') if attributes[:'dns_label'] self.dns_label = attributes[:'dns_label'] end if attributes[:'freeformTags'] self. = attributes[:'freeformTags'] end raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') if attributes[:'freeform_tags'] self. = attributes[:'freeform_tags'] end if attributes[:'id'] self.id = attributes[:'id'] end if attributes[:'lifecycleState'] self.lifecycle_state = attributes[:'lifecycleState'] end raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') if attributes[:'lifecycle_state'] self.lifecycle_state = attributes[:'lifecycle_state'] end unless attributes[:'prohibitPublicIpOnVnic'].nil? self.prohibit_public_ip_on_vnic = attributes[:'prohibitPublicIpOnVnic'] end raise 'You cannot provide both :prohibitPublicIpOnVnic and :prohibit_public_ip_on_vnic' if attributes.key?(:'prohibitPublicIpOnVnic') && attributes.key?(:'prohibit_public_ip_on_vnic') unless attributes[:'prohibit_public_ip_on_vnic'].nil? self.prohibit_public_ip_on_vnic = attributes[:'prohibit_public_ip_on_vnic'] end if attributes[:'routeTableId'] self.route_table_id = attributes[:'routeTableId'] end raise 'You cannot provide both :routeTableId and :route_table_id' if attributes.key?(:'routeTableId') && attributes.key?(:'route_table_id') if attributes[:'route_table_id'] self.route_table_id = attributes[:'route_table_id'] end if attributes[:'securityListIds'] self.security_list_ids = attributes[:'securityListIds'] end raise 'You cannot provide both :securityListIds and :security_list_ids' if attributes.key?(:'securityListIds') && attributes.key?(:'security_list_ids') if attributes[:'security_list_ids'] self.security_list_ids = attributes[:'security_list_ids'] end if attributes[:'subnetDomainName'] self.subnet_domain_name = attributes[:'subnetDomainName'] end raise 'You cannot provide both :subnetDomainName and :subnet_domain_name' if attributes.key?(:'subnetDomainName') && attributes.key?(:'subnet_domain_name') if attributes[:'subnet_domain_name'] self.subnet_domain_name = attributes[:'subnet_domain_name'] end if attributes[:'timeCreated'] self.time_created = attributes[:'timeCreated'] end raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') if attributes[:'time_created'] self.time_created = attributes[:'time_created'] end if attributes[:'vcnId'] self.vcn_id = attributes[:'vcnId'] end raise 'You cannot provide both :vcnId and :vcn_id' if attributes.key?(:'vcnId') && attributes.key?(:'vcn_id') if attributes[:'vcn_id'] self.vcn_id = attributes[:'vcn_id'] end if attributes[:'virtualRouterIp'] self.virtual_router_ip = attributes[:'virtualRouterIp'] end raise 'You cannot provide both :virtualRouterIp and :virtual_router_ip' if attributes.key?(:'virtualRouterIp') && attributes.key?(:'virtual_router_ip') if attributes[:'virtual_router_ip'] self.virtual_router_ip = attributes[:'virtual_router_ip'] end if attributes[:'virtualRouterMac'] self.virtual_router_mac = attributes[:'virtualRouterMac'] end raise 'You cannot provide both :virtualRouterMac and :virtual_router_mac' if attributes.key?(:'virtualRouterMac') && attributes.key?(:'virtual_router_mac') if attributes[:'virtual_router_mac'] self.virtual_router_mac = attributes[:'virtual_router_mac'] end end |
Instance Attribute Details
#availability_domain ⇒ String
[Required] The subnet’s Availability Domain.
Example: ‘Uocm:PHX-AD-1`
29 30 31 |
# File 'lib/oci/core/models/subnet.rb', line 29 def availability_domain @availability_domain end |
#cidr_block ⇒ String
[Required] The subnet’s CIDR block.
Example: ‘172.16.1.0/24`
36 37 38 |
# File 'lib/oci/core/models/subnet.rb', line 36 def cidr_block @cidr_block end |
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the subnet.
40 41 42 |
# File 'lib/oci/core/models/subnet.rb', line 40 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"}`
48 49 50 |
# File 'lib/oci/core/models/subnet.rb', line 48 def @defined_tags end |
#dhcp_options_id ⇒ String
The OCID of the set of DHCP options associated with the subnet.
53 54 55 |
# File 'lib/oci/core/models/subnet.rb', line 53 def @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.
59 60 61 |
# File 'lib/oci/core/models/subnet.rb', line 59 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`
76 77 78 |
# File 'lib/oci/core/models/subnet.rb', line 76 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"`
85 86 87 |
# File 'lib/oci/core/models/subnet.rb', line 85 def @freeform_tags end |
#id ⇒ String
[Required] The subnet’s Oracle ID (OCID).
89 90 91 |
# File 'lib/oci/core/models/subnet.rb', line 89 def id @id end |
#lifecycle_state ⇒ String
[Required] The subnet’s current state.
93 94 95 |
# File 'lib/oci/core/models/subnet.rb', line 93 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`
108 109 110 |
# File 'lib/oci/core/models/subnet.rb', line 108 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.
112 113 114 |
# File 'lib/oci/core/models/subnet.rb', line 112 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.
116 117 118 |
# File 'lib/oci/core/models/subnet.rb', line 116 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`
127 128 129 |
# File 'lib/oci/core/models/subnet.rb', line 127 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`
134 135 136 |
# File 'lib/oci/core/models/subnet.rb', line 134 def time_created @time_created end |
#vcn_id ⇒ String
[Required] The OCID of the VCN the subnet is in.
138 139 140 |
# File 'lib/oci/core/models/subnet.rb', line 138 def vcn_id @vcn_id end |
#virtual_router_ip ⇒ String
[Required] The IP address of the virtual router.
Example: ‘10.0.14.1`
145 146 147 |
# File 'lib/oci/core/models/subnet.rb', line 145 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`
152 153 154 |
# File 'lib/oci/core/models/subnet.rb', line 152 def virtual_router_mac @virtual_router_mac end |
Instance Method Details
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 |
# File 'lib/oci/core/models/subnet.rb', line 369 def ==(other_object) return true if self.equal?(other_object) self.class == other_object.class && availability_domain == other_object.availability_domain && cidr_block == other_object.cidr_block && compartment_id == other_object.compartment_id && == other_object. && == other_object. && display_name == other_object.display_name && dns_label == other_object.dns_label && == other_object. && id == other_object.id && lifecycle_state == other_object.lifecycle_state && prohibit_public_ip_on_vnic == other_object.prohibit_public_ip_on_vnic && route_table_id == other_object.route_table_id && security_list_ids == other_object.security_list_ids && subnet_domain_name == other_object.subnet_domain_name && time_created == other_object.time_created && vcn_id == other_object.vcn_id && virtual_router_ip == other_object.virtual_router_ip && virtual_router_mac == other_object.virtual_router_mac end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 |
# File 'lib/oci/core/models/subnet.rb', line 407 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) self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.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_object) ⇒ Boolean
394 395 396 |
# File 'lib/oci/core/models/subnet.rb', line 394 def eql?(other_object) self == other_object end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
400 401 402 |
# File 'lib/oci/core/models/subnet.rb', line 400 def hash [availability_domain, cidr_block, compartment_id, , , display_name, dns_label, , 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
432 433 434 435 436 437 438 439 440 |
# File 'lib/oci/core/models/subnet.rb', line 432 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
426 427 428 |
# File 'lib/oci/core/models/subnet.rb', line 426 def to_s to_hash.to_s end |