Class: OCI::Core::Models::CreateSubnetDetails
- Inherits:
-
Object
- Object
- OCI::Core::Models::CreateSubnetDetails
- Defined in:
- lib/oci/core/models/create_subnet_details.rb
Instance Attribute Summary collapse
-
#availability_domain ⇒ String
[Required] The Availability Domain to contain the subnet.
-
#cidr_block ⇒ String
[Required] The CIDR IP address range of the subnet.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment to contain 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 the subnet will use.
-
#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.
-
#prohibit_public_ip_on_vnic ⇒ BOOLEAN
Whether VNICs within this subnet can have public IP addresses.
-
#route_table_id ⇒ String
The OCID of the route table the subnet will use.
-
#security_list_ids ⇒ Array<String>
OCIDs for the security lists to associate with the subnet.
-
#vcn_id ⇒ String
[Required] The OCID of the VCN to contain the subnet.
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 = {}) ⇒ CreateSubnetDetails
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 = {}) ⇒ CreateSubnetDetails
Initializes the object
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 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 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 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 117 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 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[:'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 end |
Instance Attribute Details
#availability_domain ⇒ String
[Required] The Availability Domain to contain the subnet.
Example: ‘Uocm:PHX-AD-1`
12 13 14 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 12 def availability_domain @availability_domain end |
#cidr_block ⇒ String
[Required] The CIDR IP address range of the subnet.
Example: ‘172.16.1.0/24`
19 20 21 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 19 def cidr_block @cidr_block end |
#compartment_id ⇒ String
[Required] The OCID of the compartment to contain the subnet.
23 24 25 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 23 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"}`
31 32 33 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 31 def @defined_tags end |
#dhcp_options_id ⇒ String
The OCID of the set of DHCP options the subnet will use. If you don’t provide a value, the subnet will use the VCN’s default set of DHCP options.
37 38 39 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 37 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.
41 42 43 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 41 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.
This value must be set if you want to use the Internet and VCN Resolver to resolve the hostnames of instances in the subnet. It can only be set if the VCN itself was created with a DNS label.
For more information, see [DNS in Your Virtual Cloud Network](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
Example: ‘subnet123`
59 60 61 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 59 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"`
68 69 70 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 68 def @freeform_tags 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 OCI::Core::Models::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`
82 83 84 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 82 def prohibit_public_ip_on_vnic @prohibit_public_ip_on_vnic end |
#route_table_id ⇒ String
The OCID of the route table the subnet will use. If you don’t provide a value, the subnet will use the VCN’s default route table.
88 89 90 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 88 def route_table_id @route_table_id end |
#security_list_ids ⇒ Array<String>
OCIDs for the security lists to associate with the subnet. If you don’t provide a value, the VCN’s default security list will be associated with the subnet. Remember that security lists are associated at the subnet level, but the rules are applied to the individual VNICs in the subnet.
96 97 98 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 96 def security_list_ids @security_list_ids end |
#vcn_id ⇒ String
[Required] The OCID of the VCN to contain the subnet.
100 101 102 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 100 def vcn_id @vcn_id end |
Instance Method Details
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 247 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. && 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 && vcn_id == other_object.vcn_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 279 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
266 267 268 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 266 def eql?(other_object) self == other_object end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
272 273 274 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 272 def hash [availability_domain, cidr_block, compartment_id, , , display_name, dns_label, , prohibit_public_ip_on_vnic, route_table_id, security_list_ids, vcn_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
304 305 306 307 308 309 310 311 312 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 304 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
298 299 300 |
# File 'lib/oci/core/models/create_subnet_details.rb', line 298 def to_s to_hash.to_s end |