Class: OCI::Core::Models::CreateVcnDetails

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

Overview

CreateVcnDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateVcnDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):



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

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.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.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.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_detailsArray<OCI::Core::Models::Byoipv6CidrDetails>

The list of BYOIPv6 OCIDs and BYOIPv6 CIDR blocks required to create a VCN that uses BYOIPv6 ranges.



49
50
51
# File 'lib/oci/core/models/create_vcn_details.rb', line 49

def byoipv6_cidr_details
  @byoipv6_cidr_details
end

#cidr_blockString

Deprecated. Do not set this value. Use cidrBlocks instead. Example: 10.0.0.0/16

Returns:

  • (String)


14
15
16
# File 'lib/oci/core/models/create_vcn_details.rb', line 14

def cidr_block
  @cidr_block
end

#cidr_blocksArray<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.

Returns:

  • (Array<String>)


24
25
26
# File 'lib/oci/core/models/create_vcn_details.rb', line 24

def cidr_blocks
  @cidr_blocks
end

#compartment_idString

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

Returns:

  • (String)


28
29
30
# File 'lib/oci/core/models/create_vcn_details.rb', line 28

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


57
58
59
# File 'lib/oci/core/models/create_vcn_details.rb', line 57

def defined_tags
  @defined_tags
end

#display_nameString

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

Returns:

  • (String)


63
64
65
# File 'lib/oci/core/models/create_vcn_details.rb', line 63

def display_name
  @display_name
end

#dns_labelString

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.

Example: vcn1

Returns:

  • (String)


82
83
84
# File 'lib/oci/core/models/create_vcn_details.rb', line 82

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


90
91
92
# File 'lib/oci/core/models/create_vcn_details.rb', line 90

def freeform_tags
  @freeform_tags
end

#ipv6_private_cidr_blocksArray<String>

The list of one or more ULA or Private IPv6 CIDR blocks 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 CIDR block. - The number of CIDR blocks must not exceed the limit of IPv6 CIDR blocks allowed to a vcn.

Important: Do not specify a value for ipv6CidrBlock. Use this parameter instead.

Returns:

  • (Array<String>)


38
39
40
# File 'lib/oci/core/models/create_vcn_details.rb', line 38

def ipv6_private_cidr_blocks
  @ipv6_private_cidr_blocks
end

#is_ipv6_enabledBOOLEAN

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

Returns:

  • (BOOLEAN)


100
101
102
# File 'lib/oci/core/models/create_vcn_details.rb', line 100

def is_ipv6_enabled
  @is_ipv6_enabled
end

#is_oracle_gua_allocation_enabledBOOLEAN

Specifies whether to skip Oracle allocated IPv6 GUA. By default, Oracle will allocate one GUA of /56 size for an IPv6 enabled VCN.

Returns:

  • (BOOLEAN)


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

def is_oracle_gua_allocation_enabled
  @is_oracle_gua_allocation_enabled
end

Class Method Details

.attribute_mapObject

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/oci/core/models/create_vcn_details.rb', line 103

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_typesObject

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/oci/core/models/create_vcn_details.rb', line 122

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.

Parameters:

  • other (Object)

    the other object to be compared



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/oci/core/models/create_vcn_details.rb', line 239

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 &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    dns_label == other.dns_label &&
    freeform_tags == other.freeform_tags &&
    is_ipv6_enabled == other.is_ipv6_enabled
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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/oci/core/models/create_vcn_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)
        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


259
260
261
# File 'lib/oci/core/models/create_vcn_details.rb', line 259

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



268
269
270
# File 'lib/oci/core/models/create_vcn_details.rb', line 268

def hash
  [cidr_block, cidr_blocks, compartment_id, ipv6_private_cidr_blocks, is_oracle_gua_allocation_enabled, byoipv6_cidr_details, defined_tags, display_name, dns_label, freeform_tags, is_ipv6_enabled].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



312
313
314
315
316
317
318
319
320
321
# File 'lib/oci/core/models/create_vcn_details.rb', line 312

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



306
307
308
# File 'lib/oci/core/models/create_vcn_details.rb', line 306

def to_s
  to_hash.to_s
end