Class: OCI::Core::Models::CreateVcnDetails
- Inherits:
-
Object
- Object
- OCI::Core::Models::CreateVcnDetails
- Defined in:
- lib/oci/core/models/create_vcn_details.rb
Overview
CreateVcnDetails model.
Instance Attribute Summary collapse
-
#byoipv6_cidr_details ⇒ Array<OCI::Core::Models::Byoipv6CidrDetails>
The list of BYOIPv6 OCIDs and BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 address ranges.
-
#cidr_block ⇒ String
Deprecated. Do not set this value.
-
#cidr_blocks ⇒ Array<String>
The list of one or more IPv4 CIDR blocks for the VCN that meet the following criteria: - The CIDR blocks must be valid.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment to contain the VCN.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
A user-friendly name.
-
#dns_label ⇒ String
A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example,
bminstance1.subnet123.vcn1.oraclevcn.com
). -
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#ipv6_private_cidr_blocks ⇒ Array<String>
The list of one or more ULA or Private IPv6 prefixes for the VCN that meets the following criteria: - The CIDR blocks must be valid.
-
#is_ipv6_enabled ⇒ BOOLEAN
Whether IPv6 is enabled for the VCN.
-
#is_oracle_gua_allocation_enabled ⇒ BOOLEAN
Specifies whether to skip Oracle allocated IPv6 GUA.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateVcnDetails
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 = {}) ⇒ CreateVcnDetails
Initializes the object
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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 158 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.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.cidr_blocks = attributes[:'cidrBlocks'] if attributes[:'cidrBlocks'] raise 'You cannot provide both :cidrBlocks and :cidr_blocks' if attributes.key?(:'cidrBlocks') && attributes.key?(:'cidr_blocks') self.cidr_blocks = attributes[:'cidr_blocks'] if attributes[:'cidr_blocks'] 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.ipv6_private_cidr_blocks = attributes[:'ipv6PrivateCidrBlocks'] if attributes[:'ipv6PrivateCidrBlocks'] raise 'You cannot provide both :ipv6PrivateCidrBlocks and :ipv6_private_cidr_blocks' if attributes.key?(:'ipv6PrivateCidrBlocks') && attributes.key?(:'ipv6_private_cidr_blocks') self.ipv6_private_cidr_blocks = attributes[:'ipv6_private_cidr_blocks'] if attributes[:'ipv6_private_cidr_blocks'] self.is_oracle_gua_allocation_enabled = attributes[:'isOracleGuaAllocationEnabled'] unless attributes[:'isOracleGuaAllocationEnabled'].nil? self.is_oracle_gua_allocation_enabled = true if is_oracle_gua_allocation_enabled.nil? && !attributes.key?(:'isOracleGuaAllocationEnabled') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isOracleGuaAllocationEnabled and :is_oracle_gua_allocation_enabled' if attributes.key?(:'isOracleGuaAllocationEnabled') && attributes.key?(:'is_oracle_gua_allocation_enabled') self.is_oracle_gua_allocation_enabled = attributes[:'is_oracle_gua_allocation_enabled'] unless attributes[:'is_oracle_gua_allocation_enabled'].nil? self.is_oracle_gua_allocation_enabled = true if is_oracle_gua_allocation_enabled.nil? && !attributes.key?(:'isOracleGuaAllocationEnabled') && !attributes.key?(:'is_oracle_gua_allocation_enabled') # rubocop:disable Style/StringLiterals self.byoipv6_cidr_details = attributes[:'byoipv6CidrDetails'] if attributes[:'byoipv6CidrDetails'] raise 'You cannot provide both :byoipv6CidrDetails and :byoipv6_cidr_details' if attributes.key?(:'byoipv6CidrDetails') && attributes.key?(:'byoipv6_cidr_details') self.byoipv6_cidr_details = attributes[:'byoipv6_cidr_details'] if attributes[:'byoipv6_cidr_details'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = 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.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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self.is_ipv6_enabled = attributes[:'isIpv6Enabled'] unless attributes[:'isIpv6Enabled'].nil? raise 'You cannot provide both :isIpv6Enabled and :is_ipv6_enabled' if attributes.key?(:'isIpv6Enabled') && attributes.key?(:'is_ipv6_enabled') self.is_ipv6_enabled = attributes[:'is_ipv6_enabled'] unless attributes[:'is_ipv6_enabled'].nil? end |
Instance Attribute Details
#byoipv6_cidr_details ⇒ Array<OCI::Core::Models::Byoipv6CidrDetails>
The list of BYOIPv6 OCIDs and BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 address ranges.
50 51 52 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 50 def byoipv6_cidr_details @byoipv6_cidr_details end |
#cidr_block ⇒ String
Deprecated. Do not set this value. Use cidrBlocks
instead. Example: 10.0.0.0/16
15 16 17 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 15 def cidr_block @cidr_block end |
#cidr_blocks ⇒ Array<String>
The list of one or more IPv4 CIDR blocks for the VCN that meet the following criteria: - The CIDR blocks must be valid. - They must not overlap with each other or with the on-premises network CIDR block. - The number of CIDR blocks must not exceed the limit of CIDR blocks allowed per VCN.
Important: Do not specify a value for cidrBlock
. Use this parameter instead.
25 26 27 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 25 def cidr_blocks @cidr_blocks end |
#compartment_id ⇒ String
[Required] The OCID of the compartment to contain the VCN.
29 30 31 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 29 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\"}}
58 59 60 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 58 def @defined_tags end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
64 65 66 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 64 def display_name @display_name end |
#dns_label ⇒ String
A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com
). Not required to be unique, but it's a best practice to set unique DNS labels for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter. The value cannot be changed.
You must set this value if you want instances to be able to use hostnames to resolve other instances in the VCN. Otherwise the Internet and VCN Resolver will not work.
For more information, see DNS in Your Virtual Cloud Network.
Example: vcn1
83 84 85 |
# File 'lib/oci/core/models/create_vcn_details.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\"}
91 92 93 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 91 def @freeform_tags end |
#ipv6_private_cidr_blocks ⇒ Array<String>
The list of one or more ULA or Private IPv6 prefixes for the VCN that meets the following criteria: - The CIDR blocks must be valid. - Multiple CIDR blocks must not overlap each other or the on-premises network prefix. - The number of CIDR blocks must not exceed the limit of IPv6 prefixes allowed to a VCN.
Important: Do not specify a value for ipv6CidrBlock
. Use this parameter instead.
39 40 41 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 39 def ipv6_private_cidr_blocks @ipv6_private_cidr_blocks end |
#is_ipv6_enabled ⇒ BOOLEAN
Whether IPv6 is enabled for the VCN. Default is false
. If enabled, Oracle will assign the VCN a IPv6 /56 CIDR block. You may skip having Oracle allocate the VCN a IPv6 /56 CIDR block by setting isOracleGuaAllocationEnabled to false
. For important details about IPv6 addressing in a VCN, see IPv6 Addresses.
Example: true
101 102 103 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 101 def is_ipv6_enabled @is_ipv6_enabled end |
#is_oracle_gua_allocation_enabled ⇒ BOOLEAN
Specifies whether to skip Oracle allocated IPv6 GUA. By default, Oracle will allocate one GUA of /56 size for an IPv6 enabled VCN.
45 46 47 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 45 def is_oracle_gua_allocation_enabled @is_oracle_gua_allocation_enabled end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 104 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'cidr_block': :'cidrBlock', 'cidr_blocks': :'cidrBlocks', 'compartment_id': :'compartmentId', 'ipv6_private_cidr_blocks': :'ipv6PrivateCidrBlocks', 'is_oracle_gua_allocation_enabled': :'isOracleGuaAllocationEnabled', 'byoipv6_cidr_details': :'byoipv6CidrDetails', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'dns_label': :'dnsLabel', 'freeform_tags': :'freeformTags', 'is_ipv6_enabled': :'isIpv6Enabled' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 123 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'cidr_block': :'String', 'cidr_blocks': :'Array<String>', 'compartment_id': :'String', 'ipv6_private_cidr_blocks': :'Array<String>', 'is_oracle_gua_allocation_enabled': :'BOOLEAN', 'byoipv6_cidr_details': :'Array<OCI::Core::Models::Byoipv6CidrDetails>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'dns_label': :'String', 'freeform_tags': :'Hash<String, String>', 'is_ipv6_enabled': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 240 def ==(other) return true if equal?(other) self.class == other.class && cidr_block == other.cidr_block && cidr_blocks == other.cidr_blocks && compartment_id == other.compartment_id && ipv6_private_cidr_blocks == other.ipv6_private_cidr_blocks && is_oracle_gua_allocation_enabled == other.is_oracle_gua_allocation_enabled && byoipv6_cidr_details == other.byoipv6_cidr_details && == other. && display_name == other.display_name && dns_label == other.dns_label && == other. && is_ipv6_enabled == other.is_ipv6_enabled end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 280 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
260 261 262 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 260 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
269 270 271 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 269 def hash [cidr_block, cidr_blocks, compartment_id, ipv6_private_cidr_blocks, is_oracle_gua_allocation_enabled, byoipv6_cidr_details, , display_name, dns_label, , is_ipv6_enabled].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
313 314 315 316 317 318 319 320 321 322 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 313 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
307 308 309 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 307 def to_s to_hash.to_s end |