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
-
#cidr_block ⇒ String
[Required] The CIDR IP address block of the VCN.
-
#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, ‘bminstance-1.subnet123.vcn1.oraclevcn.com`).
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#ipv6_cidr_block ⇒ String
If you enable IPv6 for the VCN (see ‘isIpv6Enabled`), you may optionally provide an IPv6 /48 CIDR block from the supported ranges (see [IPv6 Addresses](docs.cloud.oracle.com/Content/Network/Concepts/ipv6.htm). The addresses in this block will be considered private and cannot be accessed from the internet. The documentation refers to this as a *custom CIDR* for the VCN.
-
#is_ipv6_enabled ⇒ BOOLEAN
Whether IPv6 is enabled for the VCN.
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
138 139 140 141 142 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 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 138 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.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_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. = 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
#cidr_block ⇒ String
[Required] The CIDR IP address block of the VCN.
Example: ‘172.16.0.0/16`
15 16 17 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 15 def cidr_block @cidr_block end |
#compartment_id ⇒ String
[Required] The OCID of the compartment to contain the VCN.
19 20 21 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 19 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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘{"CostCenter": "42"}`
51 52 53 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 51 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.
55 56 57 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 55 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, ‘bminstance-1.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](docs.cloud.oracle.com/Content/Network/Concepts/dns.htm).
Example: ‘vcn1`
74 75 76 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 74 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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘"Finance"`
82 83 84 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 82 def @freeform_tags end |
#ipv6_cidr_block ⇒ String
If you enable IPv6 for the VCN (see ‘isIpv6Enabled`), you may optionally provide an IPv6 /48 CIDR block from the supported ranges (see [IPv6 Addresses](docs.cloud.oracle.com/Content/Network/Concepts/ipv6.htm). The addresses in this block will be considered private and cannot be accessed from the internet. The documentation refers to this as a *custom CIDR* for the VCN.
If you don’t provide a custom CIDR for the VCN, Oracle assigns the VCN’s IPv6 /48 CIDR block.
Regardless of whether you or Oracle assigns the ‘ipv6CidrBlock`, Oracle also assigns the VCN an IPv6 CIDR block for the VCN’s public IP address space (see the ‘ipv6PublicCidrBlock` of the Vcn object). If you do not assign a custom CIDR, Oracle uses the same Oracle-assigned CIDR for both the private IP address space (`ipv6CidrBlock` in the `Vcn` object) and the public IP addreses space (`ipv6PublicCidrBlock` in the `Vcn` object). This means that a given VNIC might use the same IPv6 IP address for both private and public (internet) communication. You control whether an IPv6 address can be used for internet communication by using the `isInternetAccessAllowed` attribute in the Ipv6 object.
For important details about IPv6 addressing in a VCN, see [IPv6 Addresses](docs.cloud.oracle.com/Content/Network/Concepts/ipv6.htm).
Example: ‘2001:0db8:0123::/48`
43 44 45 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 43 def ipv6_cidr_block @ipv6_cidr_block end |
#is_ipv6_enabled ⇒ BOOLEAN
Whether IPv6 is enabled for the VCN. Default is ‘false`. You cannot change this later. For important details about IPv6 addressing in a VCN, see [IPv6 Addresses](docs.cloud.oracle.com/Content/Network/Concepts/ipv6.htm).
Example: ‘true`
90 91 92 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 90 def is_ipv6_enabled @is_ipv6_enabled end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 93 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'cidr_block': :'cidrBlock', 'compartment_id': :'compartmentId', 'ipv6_cidr_block': :'ipv6CidrBlock', '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.
109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 109 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'cidr_block': :'String', 'compartment_id': :'String', 'ipv6_cidr_block': :'String', '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.
200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 200 def ==(other) return true if equal?(other) self.class == other.class && cidr_block == other.cidr_block && compartment_id == other.compartment_id && ipv6_cidr_block == other.ipv6_cidr_block && == 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
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 237 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
217 218 219 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 217 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
226 227 228 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 226 def hash [cidr_block, compartment_id, ipv6_cidr_block, , display_name, dns_label, , is_ipv6_enabled].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
270 271 272 273 274 275 276 277 278 279 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 270 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
264 265 266 |
# File 'lib/oci/core/models/create_vcn_details.rb', line 264 def to_s to_hash.to_s end |