Class: OracleBMC::Core::Models::Vcn

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/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']

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 87

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[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'dnsLabel']
    self.dns_label = attributes[:'dnsLabel']
  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) 


18
19
20
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 18

def cidr_block
  @cidr_block
end

#compartment_id ⇒ String

The OCID of the compartment containing the VCN.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 22

def compartment_id
  @compartment_id
end

#default_dhcp_options_id ⇒ String

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

Returns:

  • (String) 


27
28
29
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 27

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) 


31
32
33
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 31

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) 


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

def default_security_list_id
  @default_security_list_id
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it’s changeable.

Returns:

  • (String) 


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

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 (e.g., ‘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) 


56
57
58
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 56

def dns_label
  @dns_label
end

#id ⇒ String

The VCN’s Oracle ID (OCID).

Returns:

  • (String) 


60
61
62
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 60

def id
  @id
end

#lifecycle_state ⇒ String

The VCN’s current state.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 64

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) 


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

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) 


82
83
84
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 82

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 151

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 &&
      display_name == other_object.display_name &&
      dns_label == other_object.dns_label &&
      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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 182

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.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| OracleBMC::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", OracleBMC::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


169
170
171
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 169

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



175
176
177
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 175

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



207
208
209
210
211
212
213
214
215
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 207

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



201
202
203
 
# File 'lib/oraclebmc/core/models/vcn.rb', line 201

def to_s
  to_hash.to_s
end