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

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

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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
 
# File 'lib/oci/core/models/vcn.rb', line 107

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

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

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

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

  if attributes[:'definedTags']
    self.defined_tags = attributes[:'definedTags']
  end

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

  if attributes[:'dnsLabel']
    self.dns_label = attributes[:'dnsLabel']
  end

  if attributes[:'freeformTags']
    self.freeform_tags = attributes[:'freeformTags']
  end

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

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

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

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

end

Instance Attribute Details

#cidr_block ⇒ String

The CIDR IP address block of the VCN.

Example: ‘172.16.0.0/16`

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/core/models/vcn.rb', line 19

def cidr_block
  @cidr_block
end

#compartment_id ⇒ String

The OCID of the compartment containing the VCN.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/core/models/vcn.rb', line 23

def compartment_id
  @compartment_id
end

#default_dhcp_options_id ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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


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

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) 


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

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) 


67
68
69
 
# File 'lib/oci/core/models/vcn.rb', line 67

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The VCN’s Oracle ID (OCID).

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

The VCN’s current state.

Returns:

  • (String) 


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

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) 


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

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) 


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

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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/core/models/vcn.rb', line 179

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/core/models/vcn.rb', line 212

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


199
200
201
 
# File 'lib/oci/core/models/vcn.rb', line 199

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



205
206
207
 
# File 'lib/oci/core/models/vcn.rb', line 205

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



237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/core/models/vcn.rb', line 237

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



231
232
233
 
# File 'lib/oci/core/models/vcn.rb', line 231

def to_s
  to_hash.to_s
end