Class: OCI::Core::Models::Vcn

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

Overview

A virtual cloud network (VCN). For more information, see Overview of the Networking Service.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Vcn

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :byoipv6_cidr_blocks (Array<String>) —

    The value to assign to the #byoipv6_cidr_blocks property

  • :ipv6_private_cidr_blocks (Array<String>) —

    The value to assign to the #ipv6_private_cidr_blocks property

  • :cidr_block (String) —

    The value to assign to the #cidr_block property

  • :cidr_blocks (Array<String>) —

    The value to assign to the #cidr_blocks property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :default_dhcp_options_id (String) —

    The value to assign to the #default_dhcp_options_id property

  • :default_route_table_id (String) —

    The value to assign to the #default_route_table_id property

  • :default_security_list_id (String) —

    The value to assign to the #default_security_list_id property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

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

  • :id (String) —

    The value to assign to the #id property

  • :ipv6_cidr_blocks (Array<String>) —

    The value to assign to the #ipv6_cidr_blocks property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :vcn_domain_name (String) —

    The value to assign to the #vcn_domain_name property



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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/oci/core/models/vcn.rb', line 209

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.byoipv6_cidr_blocks = attributes[:'byoipv6CidrBlocks'] if attributes[:'byoipv6CidrBlocks']

  raise 'You cannot provide both :byoipv6CidrBlocks and :byoipv6_cidr_blocks' if attributes.key?(:'byoipv6CidrBlocks') && attributes.key?(:'byoipv6_cidr_blocks')

  self.byoipv6_cidr_blocks = attributes[:'byoipv6_cidr_blocks'] if attributes[:'byoipv6_cidr_blocks']

  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.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.default_dhcp_options_id = attributes[:'defaultDhcpOptionsId'] if attributes[:'defaultDhcpOptionsId']

  raise 'You cannot provide both :defaultDhcpOptionsId and :default_dhcp_options_id' if attributes.key?(:'defaultDhcpOptionsId') && attributes.key?(:'default_dhcp_options_id')

  self.default_dhcp_options_id = attributes[:'default_dhcp_options_id'] if attributes[:'default_dhcp_options_id']

  self.default_route_table_id = attributes[:'defaultRouteTableId'] if attributes[:'defaultRouteTableId']

  raise 'You cannot provide both :defaultRouteTableId and :default_route_table_id' if attributes.key?(:'defaultRouteTableId') && attributes.key?(:'default_route_table_id')

  self.default_route_table_id = attributes[:'default_route_table_id'] if attributes[:'default_route_table_id']

  self.default_security_list_id = attributes[:'defaultSecurityListId'] if attributes[:'defaultSecurityListId']

  raise 'You cannot provide both :defaultSecurityListId and :default_security_list_id' if attributes.key?(:'defaultSecurityListId') && attributes.key?(:'default_security_list_id')

  self.default_security_list_id = attributes[:'default_security_list_id'] if attributes[:'default_security_list_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.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.id = attributes[:'id'] if attributes[:'id']

  self.ipv6_cidr_blocks = attributes[:'ipv6CidrBlocks'] if attributes[:'ipv6CidrBlocks']

  raise 'You cannot provide both :ipv6CidrBlocks and :ipv6_cidr_blocks' if attributes.key?(:'ipv6CidrBlocks') && attributes.key?(:'ipv6_cidr_blocks')

  self.ipv6_cidr_blocks = attributes[:'ipv6_cidr_blocks'] if attributes[:'ipv6_cidr_blocks']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.vcn_domain_name = attributes[:'vcnDomainName'] if attributes[:'vcnDomainName']

  raise 'You cannot provide both :vcnDomainName and :vcn_domain_name' if attributes.key?(:'vcnDomainName') && attributes.key?(:'vcn_domain_name')

  self.vcn_domain_name = attributes[:'vcn_domain_name'] if attributes[:'vcn_domain_name']
end

Instance Attribute Details

#byoipv6_cidr_blocks ⇒ Array<String>

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

Returns:

  • (Array<String>) 


29
30
31
 
# File 'lib/oci/core/models/vcn.rb', line 29

def byoipv6_cidr_blocks
  @byoipv6_cidr_blocks
end

#cidr_block ⇒ String

[Required] Deprecated. The first CIDR IP address from cidrBlocks.

Example: 172.16.0.0/16

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/core/models/vcn.rb', line 41

def cidr_block
  @cidr_block
end

#cidr_blocks ⇒ Array<String>

[Required] The list of IPv4 CIDR blocks the VCN will use.

Returns:

  • (Array<String>) 


46
47
48
 
# File 'lib/oci/core/models/vcn.rb', line 46

def cidr_blocks
  @cidr_blocks
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the VCN.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#default_dhcp_options_id ⇒ String

The OCID for the VCN's default set of DHCP options.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/core/models/vcn.rb', line 55

def default_dhcp_options_id
  @default_dhcp_options_id
end

#default_route_table_id ⇒ String

The OCID for the VCN's default route table.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/core/models/vcn.rb', line 59

def default_route_table_id
  @default_route_table_id
end

#default_security_list_id ⇒ String

The OCID for the VCN's default security list.

Returns:

  • (String) 


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

def default_security_list_id
  @default_security_list_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\"}}

Returns:

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


71
72
73
 
# File 'lib/oci/core/models/vcn.rb', line 71

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/core/models/vcn.rb', line 77

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). Must be an alphanumeric string that begins with a letter. The value cannot be changed.

The absence of this parameter means the Internet and VCN Resolver will not work for this VCN.

For more information, see DNS in Your Virtual Cloud Network.

Example: vcn1

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/core/models/vcn.rb', line 94

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

Returns:

  • (Hash<String, String>) 


102
103
104
 
# File 'lib/oci/core/models/vcn.rb', line 102

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The VCN's Oracle ID (OCID).

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/core/models/vcn.rb', line 106

def id
  @id
end

#ipv6_cidr_blocks ⇒ Array<String>

For an IPv6-enabled VCN, this is the list of IPv6 CIDR blocks for the VCN's IP address space. The CIDRs are provided by Oracle and the sizes are always /56.

Returns:

  • (Array<String>) 


112
113
114
 
# File 'lib/oci/core/models/vcn.rb', line 112

def ipv6_cidr_blocks
  @ipv6_cidr_blocks
end

#ipv6_private_cidr_blocks ⇒ Array<String>

For an IPv6-enabled VCN, this is the list of Private IPv6 CIDR blocks for the VCN's IP address space.

Returns:

  • (Array<String>) 


34
35
36
 
# File 'lib/oci/core/models/vcn.rb', line 34

def ipv6_private_cidr_blocks
  @ipv6_private_cidr_blocks
end

#lifecycle_state ⇒ String

[Required] The VCN's current state.

Returns:

  • (String) 


116
117
118
 
# File 'lib/oci/core/models/vcn.rb', line 116

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

The date and time the VCN was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


123
124
125
 
# File 'lib/oci/core/models/vcn.rb', line 123

def time_created
  @time_created
end

#vcn_domain_name ⇒ String

The VCN's domain name, which consists of the VCN's DNS label, and the oraclevcn.com domain.

For more information, see DNS in Your Virtual Cloud Network.

Example: vcn1.oraclevcn.com

Returns:

  • (String) 


134
135
136
 
# File 'lib/oci/core/models/vcn.rb', line 134

def vcn_domain_name
  @vcn_domain_name
end

Class Method Details

.attribute_map ⇒ Object

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/core/models/vcn.rb', line 137

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'byoipv6_cidr_blocks': :'byoipv6CidrBlocks',
    'ipv6_private_cidr_blocks': :'ipv6PrivateCidrBlocks',
    'cidr_block': :'cidrBlock',
    'cidr_blocks': :'cidrBlocks',
    'compartment_id': :'compartmentId',
    'default_dhcp_options_id': :'defaultDhcpOptionsId',
    'default_route_table_id': :'defaultRouteTableId',
    'default_security_list_id': :'defaultSecurityListId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'dns_label': :'dnsLabel',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'ipv6_cidr_blocks': :'ipv6CidrBlocks',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'vcn_domain_name': :'vcnDomainName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/core/models/vcn.rb', line 162

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'byoipv6_cidr_blocks': :'Array<String>',
    'ipv6_private_cidr_blocks': :'Array<String>',
    'cidr_block': :'String',
    'cidr_blocks': :'Array<String>',
    'compartment_id': :'String',
    'default_dhcp_options_id': :'String',
    'default_route_table_id': :'String',
    'default_security_list_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'dns_label': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'ipv6_cidr_blocks': :'Array<String>',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'vcn_domain_name': :'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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/oci/core/models/vcn.rb', line 334

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    byoipv6_cidr_blocks == other.byoipv6_cidr_blocks &&
    ipv6_private_cidr_blocks == other.ipv6_private_cidr_blocks &&
    cidr_block == other.cidr_block &&
    cidr_blocks == other.cidr_blocks &&
    compartment_id == other.compartment_id &&
    default_dhcp_options_id == other.default_dhcp_options_id &&
    default_route_table_id == other.default_route_table_id &&
    default_security_list_id == other.default_security_list_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    dns_label == other.dns_label &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    ipv6_cidr_blocks == other.ipv6_cidr_blocks &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    vcn_domain_name == other.vcn_domain_name
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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/oci/core/models/vcn.rb', line 380

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


360
361
362
 
# File 'lib/oci/core/models/vcn.rb', line 360

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



369
370
371
 
# File 'lib/oci/core/models/vcn.rb', line 369

def hash
  [byoipv6_cidr_blocks, ipv6_private_cidr_blocks, cidr_block, cidr_blocks, compartment_id, default_dhcp_options_id, default_route_table_id, default_security_list_id, defined_tags, display_name, dns_label, freeform_tags, id, ipv6_cidr_blocks, lifecycle_state, time_created, vcn_domain_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



413
414
415
416
417
418
419
420
421
422
 
# File 'lib/oci/core/models/vcn.rb', line 413

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

Returns:

  • (String) —

    String presentation of the object



407
408
409
 
# File 'lib/oci/core/models/vcn.rb', line 407

def to_s
  to_hash.to_s
end