Class: OCI::Database::Models::LaunchDbSystemDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/launch_db_system_details.rb

Constant Summary collapse

DATABASE_EDITION_ENUM = 
[DATABASE_EDITION_STANDARD_EDITION = 'STANDARD_EDITION',
DATABASE_EDITION_ENTERPRISE_EDITION = 'ENTERPRISE_EDITION',
DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE',
DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = 'ENTERPRISE_EDITION_HIGH_PERFORMANCE']
DISK_REDUNDANCY_ENUM = 
[DISK_REDUNDANCY_HIGH = 'HIGH',
DISK_REDUNDANCY_NORMAL = 'NORMAL']
LICENSE_MODEL_ENUM = 
[LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED',
LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LaunchDbSystemDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 158

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

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

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

  if attributes[:'backupSubnetId']
    self.backup_subnet_id = attributes[:'backupSubnetId']
  end

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

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

  if attributes[:'clusterName']
    self.cluster_name = attributes[:'clusterName']
  end

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

  if attributes[:'cluster_name']
    self.cluster_name = attributes[:'cluster_name']
  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[:'cpuCoreCount']
    self.cpu_core_count = attributes[:'cpuCoreCount']
  end

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

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

  if attributes[:'dataStoragePercentage']
    self.data_storage_percentage = attributes[:'dataStoragePercentage']
  end

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

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

  if attributes[:'databaseEdition']
    self.database_edition = attributes[:'databaseEdition']
  end

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

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

  if attributes[:'dbHome']
    self.db_home = attributes[:'dbHome']
  end

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

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

  if attributes[:'diskRedundancy']
    self.disk_redundancy = attributes[:'diskRedundancy']
  end

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

  if attributes[:'disk_redundancy']
    self.disk_redundancy = attributes[:'disk_redundancy']
  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[:'domain']
    self.domain = attributes[:'domain']
  end

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

  if attributes[:'initialDataStorageSizeInGB']
    self.initial_data_storage_size_in_gb = attributes[:'initialDataStorageSizeInGB']
  end

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

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

  if attributes[:'licenseModel']
    self.license_model = attributes[:'licenseModel']
  end

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

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

  if attributes[:'nodeCount']
    self.node_count = attributes[:'nodeCount']
  end

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

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

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

  if attributes[:'sshPublicKeys']
    self.ssh_public_keys = attributes[:'sshPublicKeys']
  end

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

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

  if attributes[:'subnetId']
    self.subnet_id = attributes[:'subnetId']
  end

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

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

end

Instance Attribute Details

#availability_domain ⇒ String

[Required] The Availability Domain where the DB System is located.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 23

def availability_domain
  @availability_domain
end

#backup_subnet_id ⇒ String

The OCID of the backup network subnet the DB System is associated with. Applicable only to Exadata.

**Subnet Restrictions:** See above subnetId’s **Subnet Restriction**.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 30

def backup_subnet_id
  @backup_subnet_id
end

#cluster_name ⇒ String

Cluster name for Exadata and 2-node RAC DB Systems. The cluster name must begin with an an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 35

def cluster_name
  @cluster_name
end

#compartment_id ⇒ String

[Required] The Oracle Cloud ID (OCID) of the compartment the DB System belongs in.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 39

def compartment_id
  @compartment_id
end

#cpu_core_count ⇒ Integer

[Required] The number of CPU cores to enable. The valid values depend on the specified shape:

  • BM.DenseIO1.36 and BM.HighIO1.36 - Specify a multiple of 2, from 2 to 36.

  • BM.RACLocalStorage1.72 - Specify a multiple of 4, from 4 to 72.

  • Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.

  • Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.

  • Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.

For VM DB systems, the core count is inferred from the specific VM shape chosen, so this parameter is not used.

Returns:

  • (Integer) 


52
53
54
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 52

def cpu_core_count
  @cpu_core_count
end

#data_storage_percentage ⇒ Integer

The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. This is not applicable for VM based DB systems.

Returns:

  • (Integer) 


59
60
61
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 59

def data_storage_percentage
  @data_storage_percentage
end

#database_edition ⇒ String

[Required] The Oracle Database Edition that applies to all the databases on the DB System.

Exadata DB Systems and 2-node RAC DB Systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 66

def database_edition
  @database_edition
end

#db_home ⇒ OCI::Database::Models::CreateDbHomeDetails

This attribute is required.

Returns:



70
71
72
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 70

def db_home
  @db_home
end

#disk_redundancy ⇒ String

The type of redundancy configured for the DB System. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 77

def disk_redundancy
  @disk_redundancy
end

#display_name ⇒ String

The user-friendly name for the DB System. It does not have to be unique.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 81

def display_name
  @display_name
end

#domain ⇒ String

A domain name used for the DB System. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (don’t provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 88

def domain
  @domain
end

#hostname ⇒ String

[Required] The host name for the DB System. The host name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters, including hyphens (-).

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB System will fail to provision.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 99

def hostname
  @hostname
end

#initial_data_storage_size_in_gb ⇒ Integer

Size, in GBs, of the initial data volume that will be created and attached to VM-shape based DB system. This storage can later be scaled up if needed. Note that the total storage size attached will be more than what is requested, to account for REDO/RECO space and software volume.

Returns:

  • (Integer) 


104
105
106
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 104

def initial_data_storage_size_in_gb
  @initial_data_storage_size_in_gb
end

#license_model ⇒ String

The Oracle license model that applies to all the databases on the DB System. The default is LICENSE_INCLUDED.

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 109

def license_model
  @license_model
end

#node_count ⇒ Integer

Number of nodes to launch for a VM-shape based RAC DB system.

Returns:

  • (Integer) 


114
115
116
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 114

def node_count
  @node_count
end

#shape ⇒ String

[Required] The shape of the DB System. The shape determines resources allocated to the DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use the list_db_system_shapes operation.

Returns:

  • (String) 


118
119
120
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 118

def shape
  @shape
end

#ssh_public_keys ⇒ Array<String>

[Required] The public key portion of the key pair to use for SSH access to the DB System. Multiple public keys can be provided. The length of the combined keys cannot exceed 10,000 characters.

Returns:

  • (Array<String>) 


122
123
124
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 122

def ssh_public_keys
  @ssh_public_keys
end

#subnet_id ⇒ String

[Required] The OCID of the subnet the DB System is associated with.

**Subnet Restrictions:**

  • For single node and 2-node (RAC) DB Systems, do not use a subnet that overlaps with 192.168.16.16/28

  • For Exadata and VM-based RAC DB Systems, do not use a subnet that overlaps with 192.168.128.0/20

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

Returns:

  • (String) 


135
136
137
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 135

def subnet_id
  @subnet_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 360

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      availability_domain == other_object.availability_domain &&
      backup_subnet_id == other_object.backup_subnet_id &&
      cluster_name == other_object.cluster_name &&
      compartment_id == other_object.compartment_id &&
      cpu_core_count == other_object.cpu_core_count &&
      data_storage_percentage == other_object.data_storage_percentage &&
      database_edition == other_object.database_edition &&
      db_home == other_object.db_home &&
      disk_redundancy == other_object.disk_redundancy &&
      display_name == other_object.display_name &&
      domain == other_object.domain &&
      hostname == other_object.hostname &&
      initial_data_storage_size_in_gb == other_object.initial_data_storage_size_in_gb &&
      license_model == other_object.license_model &&
      node_count == other_object.node_count &&
      shape == other_object.shape &&
      ssh_public_keys == other_object.ssh_public_keys &&
      subnet_id == other_object.subnet_id
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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 398

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


385
386
387
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 385

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



391
392
393
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 391

def hash
  [availability_domain, backup_subnet_id, cluster_name, compartment_id, cpu_core_count, data_storage_percentage, database_edition, db_home, disk_redundancy, display_name, domain, hostname, initial_data_storage_size_in_gb, license_model, node_count, shape, ssh_public_keys, subnet_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



423
424
425
426
427
428
429
430
431
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 423

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



417
418
419
 
# File 'lib/oci/database/models/launch_db_system_details.rb', line 417

def to_s
  to_hash.to_s
end