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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

Constant Summary collapse

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

Instance Attribute 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



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

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

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

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

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

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

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

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

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

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

  if attributes[:'definedTags']
    self.defined_tags = 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.defined_tags = attributes[:'defined_tags']
  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.freeform_tags = 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.freeform_tags = attributes[:'freeform_tags']
  end

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#cidr_block ⇒ String

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

Example: ‘172.16.0.0/16`

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/core/models/vcn.rb', line 26

def cidr_block
  @cidr_block
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#default_dhcp_options_id ⇒ String

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

Returns:

  • (String) 


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

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) 


39
40
41
 
# File 'lib/oci/core/models/vcn.rb', line 39

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) 


43
44
45
 
# File 'lib/oci/core/models/vcn.rb', line 43

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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

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

Returns:

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


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

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) 


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

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.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).

Example: ‘vcn1`

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/core/models/vcn.rb', line 74

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

Returns:

  • (Hash<String, String>) 


83
84
85
 
# File 'lib/oci/core/models/vcn.rb', line 83

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/core/models/vcn.rb', line 87

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The VCN’s current state.

Returns:

  • (String) 


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

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) 


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

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.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).

Example: ‘vcn1.oraclevcn.com`

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/core/models/vcn.rb', line 109

def vcn_domain_name
  @vcn_domain_name
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/core/models/vcn.rb', line 271

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      cidr_block == other_object.cidr_block &&
      compartment_id == other_object.compartment_id &&
      default_dhcp_options_id == other_object.default_dhcp_options_id &&
      default_route_table_id == other_object.default_route_table_id &&
      default_security_list_id == other_object.default_security_list_id &&
      defined_tags == other_object.defined_tags &&
      display_name == other_object.display_name &&
      dns_label == other_object.dns_label &&
      freeform_tags == other_object.freeform_tags &&
      id == other_object.id &&
      lifecycle_state == other_object.lifecycle_state &&
      time_created == other_object.time_created &&
      vcn_domain_name == other_object.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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/oci/core/models/vcn.rb', line 304

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

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


291
292
293
 
# File 'lib/oci/core/models/vcn.rb', line 291

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



297
298
299
 
# File 'lib/oci/core/models/vcn.rb', line 297

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



329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/core/models/vcn.rb', line 329

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



323
324
325
 
# File 'lib/oci/core/models/vcn.rb', line 323

def to_s
  to_hash.to_s
end