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](docs.cloud.oracle.com/Content/Network/Concepts/overview.htm).

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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =

rubocop:disable Metrics/LineLength

[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.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):

  • :cidr_block (String) —

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

  • :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



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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/core/models/vcn.rb', line 178

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

#cidr_block ⇒ String

[Required] The CIDR IP address block of the VCN.

Example: ‘172.16.0.0/16`

Returns:

  • (String) 


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

def cidr_block
  @cidr_block
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#default_dhcp_options_id ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`

Returns:

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


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

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) 


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

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](docs.cloud.oracle.com/Content/Network/Concepts/dns.htm).

Example: ‘vcn1`

Returns:

  • (String) 


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

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"`

Returns:

  • (Hash<String, String>) 


89
90
91
 
# File 'lib/oci/core/models/vcn.rb', line 89

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The VCN’s current state.

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/core/models/vcn.rb', line 97

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) 


104
105
106
 
# File 'lib/oci/core/models/vcn.rb', line 104

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](docs.cloud.oracle.com/Content/Network/Concepts/dns.htm).

Example: ‘vcn1.oraclevcn.com`

Returns:

  • (String) 


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

def vcn_domain_name
  @vcn_domain_name
end

Class Method Details

.attribute_map ⇒ Object

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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/core/models/vcn.rb', line 118

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'cidr_block': :'cidrBlock',
    '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',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'vcn_domain_name': :'vcnDomainName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'cidr_block': :'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',
    '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



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

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

  self.class == other.class &&
    cidr_block == other.cidr_block &&
    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 &&
    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



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/vcn.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/vcn.rb', line 303

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [cidr_block, compartment_id, default_dhcp_options_id, default_route_table_id, default_security_list_id, defined_tags, display_name, dns_label, freeform_tags, id, 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



356
357
358
359
360
361
362
363
364
365
 
# File 'lib/oci/core/models/vcn.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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



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

def to_s
  to_hash.to_s
end