Class: OCI::Core::Models::CreateSubnetDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/create_subnet_details.rb

Overview

CreateSubnetDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSubnetDetails

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

  • :ipv6_cidr_block (String)

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

  • :vcn_id (String)

    The value to assign to the #vcn_id property



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
# File 'lib/oci/core/models/create_subnet_details.rb', line 189

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.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.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.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']
end

Instance Attribute Details

#availability_domainString

Controls whether the subnet is regional or specific to an availability domain. Oracle recommends creating regional subnets because they're more flexible and make it easier to implement failover across availability domains. Originally, AD-specific subnets were the only kind available to use.

To create a regional subnet, omit this attribute. Then any resources later created in this subnet (such as a Compute instance) can be created in any availability domain in the region.

To instead create an AD-specific subnet, set this attribute to the availability domain you want this subnet to be in. Then any resources later created in this subnet can only be created in that availability domain.

Example: Uocm:PHX-AD-1

Returns:

  • (String)


25
26
27
# File 'lib/oci/core/models/create_subnet_details.rb', line 25

def availability_domain
  @availability_domain
end

#cidr_blockString

[Required] The CIDR IP address range of the subnet.

Example: 172.16.1.0/24

Returns:

  • (String)


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

def cidr_block
  @cidr_block
end

#compartment_idString

[Required] The OCID of the compartment to contain the subnet.

Returns:

  • (String)


36
37
38
# File 'lib/oci/core/models/create_subnet_details.rb', line 36

def compartment_id
  @compartment_id
end

#defined_tagsHash<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\"}}

Returns:

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


44
45
46
# File 'lib/oci/core/models/create_subnet_details.rb', line 44

def defined_tags
  @defined_tags
end

#dhcp_options_idString

The OCID of the set of DHCP options the subnet will use. If you don't provide a value, the subnet uses the VCN's default set of DHCP options.

Returns:

  • (String)


50
51
52
# File 'lib/oci/core/models/create_subnet_details.rb', line 50

def dhcp_options_id
  @dhcp_options_id
end

#display_nameString

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String)


54
55
56
# File 'lib/oci/core/models/create_subnet_details.rb', line 54

def display_name
  @display_name
end

#dns_labelString

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.

Example: subnet123

Returns:

  • (String)


72
73
74
# File 'lib/oci/core/models/create_subnet_details.rb', line 72

def dns_label
  @dns_label
end

#freeform_tagsHash<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\"}

Returns:

  • (Hash<String, String>)


80
81
82
# File 'lib/oci/core/models/create_subnet_details.rb', line 80

def freeform_tags
  @freeform_tags
end

#ipv6_cidr_blockString

Use this to enable IPv6 addressing for this subnet. The VCN must be enabled for IPv6. You can't change this subnet characteristic later. All subnets are /64 in size. The subnet portion of the IPv6 address is the fourth hextet from the left (1111 in the following example).

For important details about IPv6 addressing in a VCN, see IPv6 Addresses.

Example: 2001:0db8:0123:1111::/64

Returns:

  • (String)


91
92
93
# File 'lib/oci/core/models/create_subnet_details.rb', line 91

def ipv6_cidr_block
  @ipv6_cidr_block
end

#prohibit_public_ip_on_vnicBOOLEAN

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

For IPv6, if prohibitPublicIpOnVnic is set to true, internet access is not allowed for any IPv6s assigned to VNICs in the subnet.

Example: true

Returns:

  • (BOOLEAN)


108
109
110
# File 'lib/oci/core/models/create_subnet_details.rb', line 108

def prohibit_public_ip_on_vnic
  @prohibit_public_ip_on_vnic
end

#route_table_idString

The OCID of the route table the subnet will use. If you don't provide a value, the subnet uses the VCN's default route table.

Returns:

  • (String)


114
115
116
# File 'lib/oci/core/models/create_subnet_details.rb', line 114

def route_table_id
  @route_table_id
end

#security_list_idsArray<String>

The OCIDs of the security list or lists the subnet will use. If you don't provide a value, the subnet uses the VCN's default security list. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.

Returns:

  • (Array<String>)


122
123
124
# File 'lib/oci/core/models/create_subnet_details.rb', line 122

def security_list_ids
  @security_list_ids
end

#vcn_idString

[Required] The OCID of the VCN to contain the subnet.

Returns:

  • (String)


126
127
128
# File 'lib/oci/core/models/create_subnet_details.rb', line 126

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_mapObject

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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/oci/core/models/create_subnet_details.rb', line 129

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',
    'ipv6_cidr_block': :'ipv6CidrBlock',
    'prohibit_public_ip_on_vnic': :'prohibitPublicIpOnVnic',
    'route_table_id': :'routeTableId',
    'security_list_ids': :'securityListIds',
    'vcn_id': :'vcnId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/oci/core/models/create_subnet_details.rb', line 150

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>',
    'ipv6_cidr_block': :'String',
    'prohibit_public_ip_on_vnic': :'BOOLEAN',
    'route_table_id': :'String',
    'security_list_ids': :'Array<String>',
    'vcn_id': :'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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/oci/core/models/create_subnet_details.rb', line 281

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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'lib/oci/core/models/create_subnet_details.rb', line 323

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


303
304
305
# File 'lib/oci/core/models/create_subnet_details.rb', line 303

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



312
313
314
# File 'lib/oci/core/models/create_subnet_details.rb', line 312

def hash
  [availability_domain, cidr_block, compartment_id, defined_tags, dhcp_options_id, display_name, dns_label, freeform_tags, ipv6_cidr_block, prohibit_public_ip_on_vnic, route_table_id, security_list_ids, vcn_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



356
357
358
359
360
361
362
363
364
365
# File 'lib/oci/core/models/create_subnet_details.rb', line 356

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



350
351
352
# File 'lib/oci/core/models/create_subnet_details.rb', line 350

def to_s
  to_hash.to_s
end