Class: OCI::Database::Models::CreateCloudVmClusterDetails

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

Overview

Details for the create cloud VM cluster operation. Applies to Exadata Cloud Service instances only.

Constant Summary collapse

LICENSE_MODEL_ENUM = 
[
  LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'.freeze,
  LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'.freeze
].freeze
VM_CLUSTER_TYPE_ENUM = 
[
  VM_CLUSTER_TYPE_REGULAR = 'REGULAR'.freeze,
  VM_CLUSTER_TYPE_DEVELOPER = 'DEVELOPER'.freeze
].freeze
VM_FILE_SYSTEM_STORAGE_TYPE_ENUM = 
[
  VM_FILE_SYSTEM_STORAGE_TYPE_LOCAL = 'LOCAL'.freeze,
  VM_FILE_SYSTEM_STORAGE_TYPE_EXASCALE = 'EXASCALE'.freeze
].freeze
VM_BACKUP_STORAGE_TYPE_ENUM = 
[
  VM_BACKUP_STORAGE_TYPE_LOCAL = 'LOCAL'.freeze,
  VM_BACKUP_STORAGE_TYPE_EXASCALE = 'EXASCALE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCloudVmClusterDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 386

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.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.subscription_id = attributes[:'subscriptionId'] if attributes[:'subscriptionId']

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

  self.subscription_id = attributes[:'subscription_id'] if attributes[:'subscription_id']

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

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

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

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

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

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

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

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

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

  self.ocpu_count = attributes[:'ocpuCount'] if attributes[:'ocpuCount']

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

  self.ocpu_count = attributes[:'ocpu_count'] if attributes[:'ocpu_count']

  self.memory_size_in_gbs = attributes[:'memorySizeInGBs'] if attributes[:'memorySizeInGBs']

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

  self.memory_size_in_gbs = attributes[:'memory_size_in_gbs'] if attributes[:'memory_size_in_gbs']

  self.db_node_storage_size_in_gbs = attributes[:'dbNodeStorageSizeInGBs'] if attributes[:'dbNodeStorageSizeInGBs']

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

  self.db_node_storage_size_in_gbs = attributes[:'db_node_storage_size_in_gbs'] if attributes[:'db_node_storage_size_in_gbs']

  self.data_storage_size_in_tbs = attributes[:'dataStorageSizeInTBs'] if attributes[:'dataStorageSizeInTBs']

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

  self.data_storage_size_in_tbs = attributes[:'data_storage_size_in_tbs'] if attributes[:'data_storage_size_in_tbs']

  self.db_servers = attributes[:'dbServers'] if attributes[:'dbServers']

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

  self.db_servers = attributes[:'db_servers'] if attributes[:'db_servers']

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

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

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

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

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

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

  self.reco_storage_percentage = attributes[:'recoStoragePercentage'] if attributes[:'recoStoragePercentage']

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

  self.reco_storage_percentage = attributes[:'reco_storage_percentage'] if attributes[:'reco_storage_percentage']

  self.sparse_storage_percentage = attributes[:'sparseStoragePercentage'] if attributes[:'sparseStoragePercentage']

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

  self.sparse_storage_percentage = attributes[:'sparse_storage_percentage'] if attributes[:'sparse_storage_percentage']

  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.cloud_exadata_infrastructure_id = attributes[:'cloudExadataInfrastructureId'] if attributes[:'cloudExadataInfrastructureId']

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

  self.cloud_exadata_infrastructure_id = attributes[:'cloud_exadata_infrastructure_id'] if attributes[:'cloud_exadata_infrastructure_id']

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

  self.domain = attributes[:'domain'] if attributes[:'domain']

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

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

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

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

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

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

  self.is_sparse_diskgroup_enabled = attributes[:'isSparseDiskgroupEnabled'] unless attributes[:'isSparseDiskgroupEnabled'].nil?

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

  self.is_sparse_diskgroup_enabled = attributes[:'is_sparse_diskgroup_enabled'] unless attributes[:'is_sparse_diskgroup_enabled'].nil?

  self.is_local_backup_enabled = attributes[:'isLocalBackupEnabled'] unless attributes[:'isLocalBackupEnabled'].nil?

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

  self.is_local_backup_enabled = attributes[:'is_local_backup_enabled'] unless attributes[:'is_local_backup_enabled'].nil?

  self.time_zone = attributes[:'timeZone'] if attributes[:'timeZone']

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

  self.time_zone = attributes[:'time_zone'] if attributes[:'time_zone']

  self.scan_listener_port_tcp = attributes[:'scanListenerPortTcp'] if attributes[:'scanListenerPortTcp']

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

  self.scan_listener_port_tcp = attributes[:'scan_listener_port_tcp'] if attributes[:'scan_listener_port_tcp']

  self.scan_listener_port_tcp_ssl = attributes[:'scanListenerPortTcpSsl'] if attributes[:'scanListenerPortTcpSsl']

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

  self.scan_listener_port_tcp_ssl = attributes[:'scan_listener_port_tcp_ssl'] if attributes[:'scan_listener_port_tcp_ssl']

  self.private_zone_id = attributes[:'privateZoneId'] if attributes[:'privateZoneId']

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

  self.private_zone_id = attributes[:'private_zone_id'] if attributes[:'private_zone_id']

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

  self.nsg_ids = attributes[:'nsg_ids'] if attributes[:'nsg_ids']

  self.backup_network_nsg_ids = attributes[:'backupNetworkNsgIds'] if attributes[:'backupNetworkNsgIds']

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

  self.backup_network_nsg_ids = attributes[:'backup_network_nsg_ids'] if attributes[:'backup_network_nsg_ids']

  self.gi_version = attributes[:'giVersion'] if attributes[:'giVersion']

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

  self.gi_version = attributes[:'gi_version'] if attributes[:'gi_version']

  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.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.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

  self.security_attributes = attributes[:'security_attributes'] if attributes[:'security_attributes']

  self.data_collection_options = attributes[:'dataCollectionOptions'] if attributes[:'dataCollectionOptions']

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

  self.data_collection_options = attributes[:'data_collection_options'] if attributes[:'data_collection_options']

  self.system_version = attributes[:'systemVersion'] if attributes[:'systemVersion']

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

  self.system_version = attributes[:'system_version'] if attributes[:'system_version']

  self.file_system_configuration_details = attributes[:'fileSystemConfigurationDetails'] if attributes[:'fileSystemConfigurationDetails']

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

  self.file_system_configuration_details = attributes[:'file_system_configuration_details'] if attributes[:'file_system_configuration_details']

  self.cloud_automation_update_details = attributes[:'cloudAutomationUpdateDetails'] if attributes[:'cloudAutomationUpdateDetails']

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

  self.cloud_automation_update_details = attributes[:'cloud_automation_update_details'] if attributes[:'cloud_automation_update_details']

  self.exascale_db_storage_vault_id = attributes[:'exascaleDbStorageVaultId'] if attributes[:'exascaleDbStorageVaultId']

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

  self.exascale_db_storage_vault_id = attributes[:'exascale_db_storage_vault_id'] if attributes[:'exascale_db_storage_vault_id']

  self.vm_cluster_type = attributes[:'vmClusterType'] if attributes[:'vmClusterType']
  self.vm_cluster_type = "" if vm_cluster_type.nil? && !attributes.key?(:'vmClusterType') # rubocop:disable Style/StringLiterals

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

  self.vm_cluster_type = attributes[:'vm_cluster_type'] if attributes[:'vm_cluster_type']
  self.vm_cluster_type = "" if vm_cluster_type.nil? && !attributes.key?(:'vmClusterType') && !attributes.key?(:'vm_cluster_type') # rubocop:disable Style/StringLiterals

  self.vm_file_system_storage_type = attributes[:'vmFileSystemStorageType'] if attributes[:'vmFileSystemStorageType']
  self.vm_file_system_storage_type = "" if vm_file_system_storage_type.nil? && !attributes.key?(:'vmFileSystemStorageType') # rubocop:disable Style/StringLiterals

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

  self.vm_file_system_storage_type = attributes[:'vm_file_system_storage_type'] if attributes[:'vm_file_system_storage_type']
  self.vm_file_system_storage_type = "" if vm_file_system_storage_type.nil? && !attributes.key?(:'vmFileSystemStorageType') && !attributes.key?(:'vm_file_system_storage_type') # rubocop:disable Style/StringLiterals

  self.vm_backup_storage_type = attributes[:'vmBackupStorageType'] if attributes[:'vmBackupStorageType']
  self.vm_backup_storage_type = "" if vm_backup_storage_type.nil? && !attributes.key?(:'vmBackupStorageType') # rubocop:disable Style/StringLiterals

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

  self.vm_backup_storage_type = attributes[:'vm_backup_storage_type'] if attributes[:'vm_backup_storage_type']
  self.vm_backup_storage_type = "" if vm_backup_storage_type.nil? && !attributes.key?(:'vmBackupStorageType') && !attributes.key?(:'vm_backup_storage_type') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#backup_network_nsg_ids ⇒ Array<String>

A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

Returns:

  • (Array<String>) 


187
188
189
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 187

def backup_network_nsg_ids
  @backup_network_nsg_ids
end

#backup_subnet_id ⇒ String

[Required] The OCID of the backup network subnet associated with the cloud VM cluster.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 48

def backup_subnet_id
  @backup_subnet_id
end

#cloud_automation_update_details ⇒ OCI::Database::Models::CloudAutomationUpdateDetails

Returns:



226
227
228
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 226

def cloud_automation_update_details
  @cloud_automation_update_details
end

#cloud_exadata_infrastructure_id ⇒ String

[Required] The OCID of the cloud Exadata infrastructure resource.

Returns:

  • (String) 


120
121
122
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 120

def cloud_exadata_infrastructure_id
  @cloud_exadata_infrastructure_id
end

#cluster_name ⇒ String

The cluster name for cloud VM cluster. The cluster name must begin with 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) 


97
98
99
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 97

def cluster_name
  @cluster_name
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 34

def compartment_id
  @compartment_id
end

#cpu_core_count ⇒ Integer

[Required] For fixed shapes, this is the total number of OCPUs to enable across the VM cluster.

  • Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.

  • Exadata.Quarter3.100 - Specify a multiple of 2, from 0 to 100.

  • Exadata.Half3.200 - Specify a multiple of 4, from 0 to 200.

  • Exadata.Full3.400 - Specify a multiple of 8, from 0 to 400.

The API specification for fixed shape values is docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary

For flexible shapes X8M and X9M, this is the total number of OCPUs to enable across the VM cluster. The number available for the VM cluster will be based on the number of database servers selected for provisioning the VM cluster on the Exadata Infrastructure.

  • Exadata.X8M - Specify a multiple of 2, from 2 to 50 per X8M database server.

  • Exadata.X9M - Specify a multiple of 2, from 2 to 126 per X9M database server.

For flexible shapes X11M and higher, this is the total number of ECPUs to enable across the VM cluster. The number available for the VM cluster will be based on the number of database servers selected for provisioning the VM cluster on the Exadata Infrastructure.

  • Exadata.X11M - Specify a multiple of 8, from 8 to 760 per X11M database server.

The API specification for flexible shape values is docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/FlexComponentSummary

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 72

def cpu_core_count
  @cpu_core_count
end

#data_collection_options ⇒ OCI::Database::Models::DataCollectionOptions

Returns:



215
216
217
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 215

def data_collection_options
  @data_collection_options
end

#data_storage_percentage ⇒ Integer

The percentage assigned to DATA storage (user data and database files). See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

Returns:

  • (Integer) 


102
103
104
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 102

def data_storage_percentage
  @data_storage_percentage
end

#data_storage_size_in_tbs ⇒ Float

The data disk group size to be allocated in TBs.

Returns:

  • (Float) 


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

def data_storage_size_in_tbs
  @data_storage_size_in_tbs
end

#db_node_storage_size_in_gbs ⇒ Integer

The local node storage to be allocated in GBs.

Returns:

  • (Integer) 


84
85
86
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 84

def db_node_storage_size_in_gbs
  @db_node_storage_size_in_gbs
end

#db_servers ⇒ Array<String>

The list of DB servers.

Returns:

  • (Array<String>) 


92
93
94
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 92

def db_servers
  @db_servers
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.

Returns:

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


205
206
207
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 205

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-friendly name for the cloud VM cluster. The name does not need to be unique.

Returns:

  • (String) 


116
117
118
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 116

def display_name
  @display_name
end

#domain ⇒ String

A domain name used for the cloud VM cluster. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Cloud Service instances only.

Returns:

  • (String) 


139
140
141
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 139

def domain
  @domain
end

#exascale_db_storage_vault_id ⇒ String

The OCID of the Exadata Database Storage Vault.

Returns:

  • (String) 


230
231
232
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 230

def exascale_db_storage_vault_id
  @exascale_db_storage_vault_id
end

#file_system_configuration_details ⇒ Array<OCI::Database::Models::FileSystemConfigurationDetail>

Details of the file system configuration of the VM cluster.

Returns:



223
224
225
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 223

def file_system_configuration_details
  @file_system_configuration_details
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.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


199
200
201
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 199

def freeform_tags
  @freeform_tags
end

#gi_version ⇒ String

[Required] A valid Oracle Grid Infrastructure (GI) software version.

Returns:

  • (String) 


191
192
193
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 191

def gi_version
  @gi_version
end

#hostname ⇒ String

[Required] The hostname for the cloud VM cluster. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata systems.

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 cloud VM Cluster will fail to provision.

Returns:

  • (String) 


131
132
133
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 131

def hostname
  @hostname
end

#is_local_backup_enabled ⇒ BOOLEAN

If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

Returns:

  • (BOOLEAN) 


158
159
160
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 158

def is_local_backup_enabled
  @is_local_backup_enabled
end

#is_sparse_diskgroup_enabled ⇒ BOOLEAN

If true, the sparse disk group is configured for the cloud VM cluster. If false, the sparse disk group is not created.

Returns:

  • (BOOLEAN) 


153
154
155
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 153

def is_sparse_diskgroup_enabled
  @is_sparse_diskgroup_enabled
end

#license_model ⇒ String

The Oracle license model that applies to the cloud VM cluster. The default is BRING_YOUR_OWN_LICENSE.

Returns:

  • (String) 


148
149
150
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 148

def license_model
  @license_model
end

#memory_size_in_gbs ⇒ Integer

The memory to be allocated in GBs.

Returns:

  • (Integer) 


80
81
82
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 80

def memory_size_in_gbs
  @memory_size_in_gbs
end

#nsg_ids ⇒ Array<String>

The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions: - A network security group (NSG) is optional for Autonomous AI Databases with private access. The nsgIds list can be empty.

Returns:

  • (Array<String>) 


182
183
184
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 182

def nsg_ids
  @nsg_ids
end

#ocpu_count ⇒ Float

The number of OCPU cores to enable for a cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

Returns:

  • (Float) 


76
77
78
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 76

def ocpu_count
  @ocpu_count
end

#private_zone_id ⇒ String

The private zone id in which DNS records need to be created.

Returns:

  • (String) 


175
176
177
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 175

def private_zone_id
  @private_zone_id
end

#reco_storage_percentage ⇒ Integer

The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

Returns:

  • (Integer) 


107
108
109
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 107

def reco_storage_percentage
  @reco_storage_percentage
end

#scan_listener_port_tcp ⇒ Integer

The TCP Single Client Access Name (SCAN) port. The default port is 1521.

Returns:

  • (Integer) 


167
168
169
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 167

def scan_listener_port_tcp
  @scan_listener_port_tcp
end

#scan_listener_port_tcp_ssl ⇒ Integer

The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

Returns:

  • (Integer) 


171
172
173
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 171

def scan_listener_port_tcp_ssl
  @scan_listener_port_tcp_ssl
end

#security_attributes ⇒ Hash<String, Hash<String, Object>>

Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"audit\"}}}

Returns:

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


212
213
214
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 212

def security_attributes
  @security_attributes
end

#sparse_storage_percentage ⇒ Integer

The percentage assigned to SPARSE storage (Exadata snapshots). See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

Returns:

  • (Integer) 


112
113
114
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 112

def sparse_storage_percentage
  @sparse_storage_percentage
end

#ssh_public_keys ⇒ Array<String>

[Required] The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.

Returns:

  • (Array<String>) 


143
144
145
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 143

def ssh_public_keys
  @ssh_public_keys
end

#subnet_id ⇒ String

[Required] The OCID of the subnet associated with the cloud VM cluster.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 43

def subnet_id
  @subnet_id
end

#subscription_id ⇒ String

The OCID of the subscription with which resource needs to be associated with.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 38

def subscription_id
  @subscription_id
end

#system_version ⇒ String

Operating system version of the image.

Returns:

  • (String) 


219
220
221
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 219

def system_version
  @system_version
end

#time_zone ⇒ String

The time zone to use for the cloud VM cluster. For details, see Time Zones.

Returns:

  • (String) 


163
164
165
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 163

def time_zone
  @time_zone
end

#vm_backup_storage_type ⇒ String

Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL

Returns:

  • (String) 


242
243
244
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 242

def vm_backup_storage_type
  @vm_backup_storage_type
end

#vm_cluster_type ⇒ String

The vmcluster type for the VM cluster/Cloud VM cluster.

Returns:

  • (String) 


234
235
236
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 234

def vm_cluster_type
  @vm_cluster_type
end

#vm_file_system_storage_type ⇒ String

Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL

Returns:

  • (String) 


238
239
240
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 238

def vm_file_system_storage_type
  @vm_file_system_storage_type
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 245

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'subscription_id': :'subscriptionId',
    'subnet_id': :'subnetId',
    'backup_subnet_id': :'backupSubnetId',
    'cpu_core_count': :'cpuCoreCount',
    'ocpu_count': :'ocpuCount',
    'memory_size_in_gbs': :'memorySizeInGBs',
    'db_node_storage_size_in_gbs': :'dbNodeStorageSizeInGBs',
    'data_storage_size_in_tbs': :'dataStorageSizeInTBs',
    'db_servers': :'dbServers',
    'cluster_name': :'clusterName',
    'data_storage_percentage': :'dataStoragePercentage',
    'reco_storage_percentage': :'recoStoragePercentage',
    'sparse_storage_percentage': :'sparseStoragePercentage',
    'display_name': :'displayName',
    'cloud_exadata_infrastructure_id': :'cloudExadataInfrastructureId',
    'hostname': :'hostname',
    'domain': :'domain',
    'ssh_public_keys': :'sshPublicKeys',
    'license_model': :'licenseModel',
    'is_sparse_diskgroup_enabled': :'isSparseDiskgroupEnabled',
    'is_local_backup_enabled': :'isLocalBackupEnabled',
    'time_zone': :'timeZone',
    'scan_listener_port_tcp': :'scanListenerPortTcp',
    'scan_listener_port_tcp_ssl': :'scanListenerPortTcpSsl',
    'private_zone_id': :'privateZoneId',
    'nsg_ids': :'nsgIds',
    'backup_network_nsg_ids': :'backupNetworkNsgIds',
    'gi_version': :'giVersion',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'security_attributes': :'securityAttributes',
    'data_collection_options': :'dataCollectionOptions',
    'system_version': :'systemVersion',
    'file_system_configuration_details': :'fileSystemConfigurationDetails',
    'cloud_automation_update_details': :'cloudAutomationUpdateDetails',
    'exascale_db_storage_vault_id': :'exascaleDbStorageVaultId',
    'vm_cluster_type': :'vmClusterType',
    'vm_file_system_storage_type': :'vmFileSystemStorageType',
    'vm_backup_storage_type': :'vmBackupStorageType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 293

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'subscription_id': :'String',
    'subnet_id': :'String',
    'backup_subnet_id': :'String',
    'cpu_core_count': :'Integer',
    'ocpu_count': :'Float',
    'memory_size_in_gbs': :'Integer',
    'db_node_storage_size_in_gbs': :'Integer',
    'data_storage_size_in_tbs': :'Float',
    'db_servers': :'Array<String>',
    'cluster_name': :'String',
    'data_storage_percentage': :'Integer',
    'reco_storage_percentage': :'Integer',
    'sparse_storage_percentage': :'Integer',
    'display_name': :'String',
    'cloud_exadata_infrastructure_id': :'String',
    'hostname': :'String',
    'domain': :'String',
    'ssh_public_keys': :'Array<String>',
    'license_model': :'String',
    'is_sparse_diskgroup_enabled': :'BOOLEAN',
    'is_local_backup_enabled': :'BOOLEAN',
    'time_zone': :'String',
    'scan_listener_port_tcp': :'Integer',
    'scan_listener_port_tcp_ssl': :'Integer',
    'private_zone_id': :'String',
    'nsg_ids': :'Array<String>',
    'backup_network_nsg_ids': :'Array<String>',
    'gi_version': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'data_collection_options': :'OCI::Database::Models::DataCollectionOptions',
    'system_version': :'String',
    'file_system_configuration_details': :'Array<OCI::Database::Models::FileSystemConfigurationDetail>',
    'cloud_automation_update_details': :'OCI::Database::Models::CloudAutomationUpdateDetails',
    'exascale_db_storage_vault_id': :'String',
    'vm_cluster_type': :'String',
    'vm_file_system_storage_type': :'String',
    'vm_backup_storage_type': :'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



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 670

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    subscription_id == other.subscription_id &&
    subnet_id == other.subnet_id &&
    backup_subnet_id == other.backup_subnet_id &&
    cpu_core_count == other.cpu_core_count &&
    ocpu_count == other.ocpu_count &&
    memory_size_in_gbs == other.memory_size_in_gbs &&
    db_node_storage_size_in_gbs == other.db_node_storage_size_in_gbs &&
    data_storage_size_in_tbs == other.data_storage_size_in_tbs &&
    db_servers == other.db_servers &&
    cluster_name == other.cluster_name &&
    data_storage_percentage == other.data_storage_percentage &&
    reco_storage_percentage == other.reco_storage_percentage &&
    sparse_storage_percentage == other.sparse_storage_percentage &&
    display_name == other.display_name &&
    cloud_exadata_infrastructure_id == other.cloud_exadata_infrastructure_id &&
    hostname == other.hostname &&
    domain == other.domain &&
    ssh_public_keys == other.ssh_public_keys &&
    license_model == other.license_model &&
    is_sparse_diskgroup_enabled == other.is_sparse_diskgroup_enabled &&
    is_local_backup_enabled == other.is_local_backup_enabled &&
    time_zone == other.time_zone &&
    scan_listener_port_tcp == other.scan_listener_port_tcp &&
    scan_listener_port_tcp_ssl == other.scan_listener_port_tcp_ssl &&
    private_zone_id == other.private_zone_id &&
    nsg_ids == other.nsg_ids &&
    backup_network_nsg_ids == other.backup_network_nsg_ids &&
    gi_version == other.gi_version &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    security_attributes == other.security_attributes &&
    data_collection_options == other.data_collection_options &&
    system_version == other.system_version &&
    file_system_configuration_details == other.file_system_configuration_details &&
    cloud_automation_update_details == other.cloud_automation_update_details &&
    exascale_db_storage_vault_id == other.exascale_db_storage_vault_id &&
    vm_cluster_type == other.vm_cluster_type &&
    vm_file_system_storage_type == other.vm_file_system_storage_type &&
    vm_backup_storage_type == other.vm_backup_storage_type
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



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 739

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


719
720
721
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 719

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



728
729
730
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 728

def hash
  [compartment_id, subscription_id, subnet_id, backup_subnet_id, cpu_core_count, ocpu_count, memory_size_in_gbs, db_node_storage_size_in_gbs, data_storage_size_in_tbs, db_servers, cluster_name, data_storage_percentage, reco_storage_percentage, sparse_storage_percentage, display_name, cloud_exadata_infrastructure_id, hostname, domain, ssh_public_keys, license_model, is_sparse_diskgroup_enabled, is_local_backup_enabled, time_zone, scan_listener_port_tcp, scan_listener_port_tcp_ssl, private_zone_id, nsg_ids, backup_network_nsg_ids, gi_version, freeform_tags, defined_tags, security_attributes, data_collection_options, system_version, file_system_configuration_details, cloud_automation_update_details, exascale_db_storage_vault_id, vm_cluster_type, vm_file_system_storage_type, vm_backup_storage_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



772
773
774
775
776
777
778
779
780
781
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 772

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



766
767
768
 
# File 'lib/oci/database/models/create_cloud_vm_cluster_details.rb', line 766

def to_s
  to_hash.to_s
end