Class: OCI::Database::Models::LaunchDbSystemBase

Inherits:

Object

Object
OCI::Database::Models::LaunchDbSystemBase

show all

Defined in:: lib/oci/database/models/launch_db_system_base.rb

Overview

Parameters for provisioning a bare metal, virtual machine, or Exadata DB system.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

LaunchDbSystemDetails, LaunchDbSystemFromBackupDetails, LaunchDbSystemFromDatabaseDetails, LaunchDbSystemFromDbSystemDetails, LaunchStandbyDbSystemDetails

Constant Summary collapse

STORAGE_VOLUME_PERFORMANCE_MODE_ENUM =

[
  STORAGE_VOLUME_PERFORMANCE_MODE_BALANCED = 'BALANCED'.freeze,
  STORAGE_VOLUME_PERFORMANCE_MODE_HIGH_PERFORMANCE = 'HIGH_PERFORMANCE'.freeze
].freeze

SOURCE_ENUM =

[
  SOURCE_NONE = 'NONE'.freeze,
  SOURCE_DB_BACKUP = 'DB_BACKUP'.freeze,
  SOURCE_DATABASE = 'DATABASE'.freeze,
  SOURCE_DB_SYSTEM = 'DB_SYSTEM'.freeze,
  SOURCE_DATAGUARD = 'DATAGUARD'.freeze
].freeze

COMPUTE_MODEL_ENUM =

[
  COMPUTE_MODEL_ECPU = 'ECPU'.freeze,
  COMPUTE_MODEL_OCPU = 'OCPU'.freeze
].freeze

Instance Attribute Summary collapse

#availability_domain ⇒ String

[Required] The availability domain where the DB system is located.
#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.
#backup_subnet_id ⇒ String

The OCID of the backup network subnet the DB system is associated with.
#cluster_name ⇒ String

The cluster name for Exadata and 2-node RAC virtual machine DB systems.
#cluster_placement_group_id ⇒ String

The OCID of the cluster placement group of the Exadata Infrastructure or Db System.
#compartment_id ⇒ String

[Required] The OCID of the compartment the DB system belongs in.
#compute_count ⇒ Integer

The number of compute servers for the DB system.
#compute_model ⇒ String

The compute model for Base Database Service.
#cpu_core_count ⇒ Integer

The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems.
#data_collection_options ⇒ OCI::Database::Models::DataCollectionOptions
#data_storage_percentage ⇒ Integer

The percentage assigned to DATA storage (user data and database files).
#db_system_options ⇒ OCI::Database::Models::DbSystemOptions
#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource.
#display_name ⇒ String

The user-friendly name for the DB system.
#domain ⇒ String

A domain name used for the DB system.
#fault_domains ⇒ Array<String>

A Fault Domain is a grouping of hardware and infrastructure within an availability domain.
#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource.
#hostname ⇒ String

[Required] The hostname for the DB system.
#initial_data_storage_size_in_gb ⇒ Integer

Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system.
#kms_key_id ⇒ String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
#kms_key_version_id ⇒ String

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
#node_count ⇒ Integer

The number of nodes to launch for a virtual machine DB system.
#nsg_ids ⇒ Array<String>

The list of OCIDs for the network security groups (NSGs) to which this resource belongs.
#private_ip ⇒ String

A private IP address of your choice.
#private_ip_v6 ⇒ String

A private IPv6 address of your choice.
#security_attributes ⇒ Hash<String, Hash<String, Object>>

Security Attributes for this resource.
#shape ⇒ String

[Required] The shape of the DB system.
#source ⇒ String

The source of the database: Use NONE for creating a new database.
#sparse_diskgroup ⇒ BOOLEAN

If true, Sparse Diskgroup is configured for Exadata dbsystem.
#ssh_public_keys ⇒ Array<String>

[Required] The public key portion of the key pair to use for SSH access to the DB system.
#storage_volume_performance_mode ⇒ String

The block storage volume performance level.
#subnet_id ⇒ String

[Required] The OCID of the subnet the DB system is associated with.
#subscription_id ⇒ String

The OCID of the subscription with which resource needs to be associated with.
#time_zone ⇒ String

The time zone to use for the DB system.

Class Method Summary collapse

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.
.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
.swagger_types ⇒ Object

Attribute type mapping.

Instance Method Summary collapse

#==(other) ⇒ Object

Checks equality by comparing each attribute.
#build_from_hash(attributes) ⇒ Object

Builds the object from hash.
#eql?(other) ⇒ Boolean
#hash ⇒ Fixnum

Calculates hash code according to all attributes.
#initialize(attributes = {}) ⇒ LaunchDbSystemBase constructor

Initializes the object.
#to_hash ⇒ Hash

Returns the object in the form of hash.
#to_s ⇒ String

Returns the string representation of the object.

Constructor Details

#initialize(attributes = {}) ⇒ `LaunchDbSystemBase`

Initializes the object

Parameters:

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

Model attributes in the form of hash

Options Hash (attributes):

:compartment_id (String) —

The value to assign to the #compartment_id property
:fault_domains (Array<String>) —

The value to assign to the #fault_domains property
:display_name (String) —

The value to assign to the #display_name property
:availability_domain (String) —

The value to assign to the #availability_domain property
:subnet_id (String) —

The value to assign to the #subnet_id property
:backup_subnet_id (String) —

The value to assign to the #backup_subnet_id property
:nsg_ids (Array<String>) —

The value to assign to the #nsg_ids property
:backup_network_nsg_ids (Array<String>) —

The value to assign to the #backup_network_nsg_ids property
:shape (String) —

The value to assign to the #shape property
:time_zone (String) —

The value to assign to the #time_zone property
:db_system_options (OCI::Database::Models::DbSystemOptions) —

The value to assign to the #db_system_options property
:storage_volume_performance_mode (String) —

The value to assign to the #storage_volume_performance_mode property
:sparse_diskgroup (BOOLEAN) —

The value to assign to the #sparse_diskgroup property
:ssh_public_keys (Array<String>) —

The value to assign to the #ssh_public_keys property
:hostname (String) —

The value to assign to the #hostname property
:domain (String) —

The value to assign to the #domain property
:cpu_core_count (Integer) —

The value to assign to the #cpu_core_count property
:cluster_name (String) —

The value to assign to the #cluster_name property
:data_storage_percentage (Integer) —

The value to assign to the #data_storage_percentage property
:initial_data_storage_size_in_gb (Integer) —

The value to assign to the #initial_data_storage_size_in_gb property
:kms_key_id (String) —

The value to assign to the #kms_key_id property
:kms_key_version_id (String) —

The value to assign to the #kms_key_version_id property
:node_count (Integer) —

The value to assign to the #node_count property
:freeform_tags (Hash<String, String>) —

The value to assign to the #freeform_tags property
:defined_tags (Hash<String, Hash<String, Object>>) —

The value to assign to the #defined_tags property
:security_attributes (Hash<String, Hash<String, Object>>) —

The value to assign to the #security_attributes property
:source (String) —

The value to assign to the #source property
:private_ip (String) —

The value to assign to the #private_ip property
:private_ip_v6 (String) —

The value to assign to the #private_ip_v6 property
:cluster_placement_group_id (String) —

The value to assign to the #cluster_placement_group_id property
:subscription_id (String) —

The value to assign to the #subscription_id property
:data_collection_options (OCI::Database::Models::DataCollectionOptions) —

The value to assign to the #data_collection_options property
:compute_model (String) —

The value to assign to the #compute_model property
:compute_count (Integer) —

The value to assign to the #compute_count property

# File 'lib/oci/database/models/launch_db_system_base.rb', line 398

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

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

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

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

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

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

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

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

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

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

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

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

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

  self.sparse_diskgroup = attributes[:'sparseDiskgroup'] unless attributes[:'sparseDiskgroup'].nil?

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

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

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

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

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

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

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

  self.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId']

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

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

  self.kms_key_version_id = attributes[:'kmsKeyVersionId'] if attributes[:'kmsKeyVersionId']

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

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

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

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

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

  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.source = attributes[:'source'] if attributes[:'source']
  self.source = "NONE" if source.nil? && !attributes.key?(:'source') # rubocop:disable Style/StringLiterals

  self.private_ip = attributes[:'privateIp'] if attributes[:'privateIp']

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

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

  self.private_ip_v6 = attributes[:'privateIpV6'] if attributes[:'privateIpV6']

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

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

  self.cluster_placement_group_id = attributes[:'clusterPlacementGroupId'] if attributes[:'clusterPlacementGroupId']

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

  self.cluster_placement_group_id = attributes[:'cluster_placement_group_id'] if attributes[:'cluster_placement_group_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.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.compute_model = attributes[:'computeModel'] if attributes[:'computeModel']

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

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

  self.compute_count = attributes[:'computeCount'] if attributes[:'computeCount']

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

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

Instance Attribute Details

#availability_domain ⇒ `String`

[Required] The availability domain where the DB system is located.

Returns:

(String)



64
65
66

# File 'lib/oci/database/models/launch_db_system_base.rb', line 64

def availability_domain
  @availability_domain
end

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



96
97
98

# File 'lib/oci/database/models/launch_db_system_base.rb', line 96

def backup_network_nsg_ids
  @backup_network_nsg_ids
end

#backup_subnet_id ⇒ `String`

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

Subnet Restrictions: See the subnet restrictions information for subnetId.

Returns:

(String)



84
85
86

# File 'lib/oci/database/models/launch_db_system_base.rb', line 84

def backup_subnet_id
  @backup_subnet_id
end

#cluster_name ⇒ `String`

The cluster name for Exadata and 2-node RAC virtual machine DB systems. 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)



168
169
170

# File 'lib/oci/database/models/launch_db_system_base.rb', line 168

def cluster_name
  @cluster_name
end

#cluster_placement_group_id ⇒ `String`

The OCID of the cluster placement group of the Exadata Infrastructure or Db System.

Returns:

(String)



238
239
240

# File 'lib/oci/database/models/launch_db_system_base.rb', line 238

def cluster_placement_group_id
  @cluster_placement_group_id
end

#compartment_id ⇒ `String`

[Required] The OCID of the compartment the DB system belongs in.

Returns:

(String)



35
36
37

# File 'lib/oci/database/models/launch_db_system_base.rb', line 35

def compartment_id
  @compartment_id
end

#compute_count ⇒ `Integer`

The number of compute servers for the DB system.

Returns:

(Integer)



253
254
255

# File 'lib/oci/database/models/launch_db_system_base.rb', line 253

def compute_count
  @compute_count
end

#compute_model ⇒ `String`

The compute model for Base Database Service. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy.

Returns:

(String)



249
250
251

# File 'lib/oci/database/models/launch_db_system_base.rb', line 249

def compute_model
  @compute_model
end

#cpu_core_count ⇒ `Integer`

The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
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.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems

Returns:

(Integer)



163
164
165

# File 'lib/oci/database/models/launch_db_system_base.rb', line 163

def cpu_core_count
  @cpu_core_count
end

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

Returns:

(OCI::Database::Models::DataCollectionOptions)



245
246
247

# File 'lib/oci/database/models/launch_db_system_base.rb', line 245

def data_collection_options
  @data_collection_options
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. Not applicable for virtual machine DB systems.

Returns:

(Integer)



175
176
177

# File 'lib/oci/database/models/launch_db_system_base.rb', line 175

def data_storage_percentage
  @data_storage_percentage
end

#db_system_options ⇒ `OCI::Database::Models::DbSystemOptions`

Returns:

(OCI::Database::Models::DbSystemOptions)



112
113
114

# File 'lib/oci/database/models/launch_db_system_base.rb', line 112

def db_system_options
  @db_system_options
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>>)



208
209
210

# File 'lib/oci/database/models/launch_db_system_base.rb', line 208

def defined_tags
  @defined_tags
end

#display_name ⇒ `String`

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

Returns:

(String)



60
61
62

# File 'lib/oci/database/models/launch_db_system_base.rb', line 60

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 (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.

Returns:

(String)



144
145
146

# File 'lib/oci/database/models/launch_db_system_base.rb', line 144

def domain
  @domain
end

#fault_domains ⇒ `Array<String>`

A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the list_fault_domains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

Returns:

(Array<String>)



56
57
58

# File 'lib/oci/database/models/launch_db_system_base.rb', line 56

def fault_domains
  @fault_domains
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>)



202
203
204

# File 'lib/oci/database/models/launch_db_system_base.rb', line 202

def freeform_tags
  @freeform_tags
end

#hostname ⇒ `String`

[Required] The hostname for the DB system. 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 DB 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 DB system will fail to provision.

Returns:

(String)



137
138
139

# File 'lib/oci/database/models/launch_db_system_base.rb', line 137

def hostname
  @hostname
end

#initial_data_storage_size_in_gb ⇒ `Integer`

Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. By default this will be set to 256.

Returns:

(Integer)



180
181
182

# File 'lib/oci/database/models/launch_db_system_base.rb', line 180

def initial_data_storage_size_in_gb
  @initial_data_storage_size_in_gb
end

#kms_key_id ⇒ `String`

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Returns:

(String)



184
185
186

# File 'lib/oci/database/models/launch_db_system_base.rb', line 184

def kms_key_id
  @kms_key_id
end

#kms_key_version_id ⇒ `String`

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances.

Returns:

(String)



189
190
191

# File 'lib/oci/database/models/launch_db_system_base.rb', line 189

def kms_key_version_id
  @kms_key_version_id
end

#node_count ⇒ `Integer`

The number of nodes to launch for a virtual machine DB system. Specify either 1 or 2. By default this will be set to 1.

Returns:

(Integer)



194
195
196

# File 'lib/oci/database/models/launch_db_system_base.rb', line 194

def node_count
  @node_count
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>)



91
92
93

# File 'lib/oci/database/models/launch_db_system_base.rb', line 91

def nsg_ids
  @nsg_ids
end

#private_ip ⇒ `String`

A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet.

Returns:

(String)



228
229
230

# File 'lib/oci/database/models/launch_db_system_base.rb', line 228

def private_ip
  @private_ip
end

#private_ip_v6 ⇒ `String`

A private IPv6 address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value and the subnet is dual stack, Oracle automatically assigns a private IPv6 address from the subnet.

Returns:

(String)



234
235
236

# File 'lib/oci/database/models/launch_db_system_base.rb', line 234

def private_ip_v6
  @private_ip_v6
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>>)



215
216
217

# File 'lib/oci/database/models/launch_db_system_base.rb', line 215

def security_attributes
  @security_attributes
end

#shape ⇒ `String`

[Required] The shape of the DB system. The shape determines resources allocated to the DB system. - For virtual machine shapes, the number of CPU cores and memory - For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the list_db_system_shapes operation.

Returns:

(String)



105
106
107

# File 'lib/oci/database/models/launch_db_system_base.rb', line 105

def shape
  @shape
end

#source ⇒ `String`

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. Use DATABASE for creating a new database from an existing database, including archive redo log data. The default is NONE.

Returns:

(String)



222
223
224

# File 'lib/oci/database/models/launch_db_system_base.rb', line 222

def source
  @source
end

#sparse_diskgroup ⇒ `BOOLEAN`

If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured.

Returns:

(BOOLEAN)



122
123
124

# File 'lib/oci/database/models/launch_db_system_base.rb', line 122

def sparse_diskgroup
  @sparse_diskgroup
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 40,000 characters.

Returns:

(Array<String>)



126
127
128

# File 'lib/oci/database/models/launch_db_system_base.rb', line 126

def ssh_public_keys
  @ssh_public_keys
end

#storage_volume_performance_mode ⇒ `String`

The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

Returns:

(String)



117
118
119

# File 'lib/oci/database/models/launch_db_system_base.rb', line 117

def storage_volume_performance_mode
  @storage_volume_performance_mode
end

#subnet_id ⇒ `String`

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

Subnet Restrictions: - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node 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 the backup subnet.

Returns:

(String)



77
78
79

# File 'lib/oci/database/models/launch_db_system_base.rb', line 77

def subnet_id
  @subnet_id
end

#subscription_id ⇒ `String`

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

Returns:

(String)



242
243
244

# File 'lib/oci/database/models/launch_db_system_base.rb', line 242

def subscription_id
  @subscription_id
end

#time_zone ⇒ `String`

The time zone to use for the DB system. For details, see DB System Time Zones.

Returns:

(String)



109
110
111

# File 'lib/oci/database/models/launch_db_system_base.rb', line 109

def time_zone
  @time_zone
end

Class Method Details

.attribute_map ⇒ `Object`

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

# File 'lib/oci/database/models/launch_db_system_base.rb', line 256

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'fault_domains': :'faultDomains',
    'display_name': :'displayName',
    'availability_domain': :'availabilityDomain',
    'subnet_id': :'subnetId',
    'backup_subnet_id': :'backupSubnetId',
    'nsg_ids': :'nsgIds',
    'backup_network_nsg_ids': :'backupNetworkNsgIds',
    'shape': :'shape',
    'time_zone': :'timeZone',
    'db_system_options': :'dbSystemOptions',
    'storage_volume_performance_mode': :'storageVolumePerformanceMode',
    'sparse_diskgroup': :'sparseDiskgroup',
    'ssh_public_keys': :'sshPublicKeys',
    'hostname': :'hostname',
    'domain': :'domain',
    'cpu_core_count': :'cpuCoreCount',
    'cluster_name': :'clusterName',
    'data_storage_percentage': :'dataStoragePercentage',
    'initial_data_storage_size_in_gb': :'initialDataStorageSizeInGB',
    'kms_key_id': :'kmsKeyId',
    'kms_key_version_id': :'kmsKeyVersionId',
    'node_count': :'nodeCount',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'security_attributes': :'securityAttributes',
    'source': :'source',
    'private_ip': :'privateIp',
    'private_ip_v6': :'privateIpV6',
    'cluster_placement_group_id': :'clusterPlacementGroupId',
    'subscription_id': :'subscriptionId',
    'data_collection_options': :'dataCollectionOptions',
    'compute_model': :'computeModel',
    'compute_count': :'computeCount'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ `Object`

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

# File 'lib/oci/database/models/launch_db_system_base.rb', line 344

def self.get_subtype(object_hash)
  type = object_hash[:'source'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Database::Models::LaunchDbSystemDetails' if type == 'NONE'
  return 'OCI::Database::Models::LaunchStandbyDbSystemDetails' if type == 'DATAGUARD'
  return 'OCI::Database::Models::LaunchDbSystemFromDbSystemDetails' if type == 'DB_SYSTEM'
  return 'OCI::Database::Models::LaunchDbSystemFromDatabaseDetails' if type == 'DATABASE'
  return 'OCI::Database::Models::LaunchDbSystemFromBackupDetails' if type == 'DB_BACKUP'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Database::Models::LaunchDbSystemBase'
end

.swagger_types ⇒ `Object`

Attribute type mapping.

# File 'lib/oci/database/models/launch_db_system_base.rb', line 298

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'fault_domains': :'Array<String>',
    'display_name': :'String',
    'availability_domain': :'String',
    'subnet_id': :'String',
    'backup_subnet_id': :'String',
    'nsg_ids': :'Array<String>',
    'backup_network_nsg_ids': :'Array<String>',
    'shape': :'String',
    'time_zone': :'String',
    'db_system_options': :'OCI::Database::Models::DbSystemOptions',
    'storage_volume_performance_mode': :'String',
    'sparse_diskgroup': :'BOOLEAN',
    'ssh_public_keys': :'Array<String>',
    'hostname': :'String',
    'domain': :'String',
    'cpu_core_count': :'Integer',
    'cluster_name': :'String',
    'data_storage_percentage': :'Integer',
    'initial_data_storage_size_in_gb': :'Integer',
    'kms_key_id': :'String',
    'kms_key_version_id': :'String',
    'node_count': :'Integer',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'source': :'String',
    'private_ip': :'String',
    'private_ip_v6': :'String',
    'cluster_placement_group_id': :'String',
    'subscription_id': :'String',
    'data_collection_options': :'OCI::Database::Models::DataCollectionOptions',
    'compute_model': :'String',
    'compute_count': :'Integer'
    # 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

# File 'lib/oci/database/models/launch_db_system_base.rb', line 627

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    fault_domains == other.fault_domains &&
    display_name == other.display_name &&
    availability_domain == other.availability_domain &&
    subnet_id == other.subnet_id &&
    backup_subnet_id == other.backup_subnet_id &&
    nsg_ids == other.nsg_ids &&
    backup_network_nsg_ids == other.backup_network_nsg_ids &&
    shape == other.shape &&
    time_zone == other.time_zone &&
    db_system_options == other.db_system_options &&
    storage_volume_performance_mode == other.storage_volume_performance_mode &&
    sparse_diskgroup == other.sparse_diskgroup &&
    ssh_public_keys == other.ssh_public_keys &&
    hostname == other.hostname &&
    domain == other.domain &&
    cpu_core_count == other.cpu_core_count &&
    cluster_name == other.cluster_name &&
    data_storage_percentage == other.data_storage_percentage &&
    initial_data_storage_size_in_gb == other.initial_data_storage_size_in_gb &&
    kms_key_id == other.kms_key_id &&
    kms_key_version_id == other.kms_key_version_id &&
    node_count == other.node_count &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    security_attributes == other.security_attributes &&
    source == other.source &&
    private_ip == other.private_ip &&
    private_ip_v6 == other.private_ip_v6 &&
    cluster_placement_group_id == other.cluster_placement_group_id &&
    subscription_id == other.subscription_id &&
    data_collection_options == other.data_collection_options &&
    compute_model == other.compute_model &&
    compute_count == other.compute_count
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

# File 'lib/oci/database/models/launch_db_system_base.rb', line 690

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)

#hash ⇒ `Fixnum`

Calculates hash code according to all attributes.

Returns:

(Fixnum) —

Hash code



679
680
681

# File 'lib/oci/database/models/launch_db_system_base.rb', line 679

def hash
  [compartment_id, fault_domains, display_name, availability_domain, subnet_id, backup_subnet_id, nsg_ids, backup_network_nsg_ids, shape, time_zone, db_system_options, storage_volume_performance_mode, sparse_diskgroup, ssh_public_keys, hostname, domain, cpu_core_count, cluster_name, data_storage_percentage, initial_data_storage_size_in_gb, kms_key_id, kms_key_version_id, node_count, freeform_tags, defined_tags, security_attributes, source, private_ip, private_ip_v6, cluster_placement_group_id, subscription_id, data_collection_options, compute_model, compute_count].hash
end

#to_hash ⇒ `Hash`

Returns the object in the form of hash

Returns:

(Hash) —

Returns the object in the form of hash

# File 'lib/oci/database/models/launch_db_system_base.rb', line 723

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



717
718
719

# File 'lib/oci/database/models/launch_db_system_base.rb', line 717

def to_s
  to_hash.to_s
end

Class: OCI::Database::Models::LaunchDbSystemBase

Overview

Direct Known Subclasses

Constant Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LaunchDbSystemBase

Instance Attribute Details

#availability_domain ⇒ String

#backup_network_nsg_ids ⇒ Array<String>

#backup_subnet_id ⇒ String

#cluster_name ⇒ String

#cluster_placement_group_id ⇒ String

#compartment_id ⇒ String

#compute_count ⇒ Integer

#compute_model ⇒ String

#cpu_core_count ⇒ Integer

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

#data_storage_percentage ⇒ Integer

#db_system_options ⇒ OCI::Database::Models::DbSystemOptions

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

#display_name ⇒ String

#domain ⇒ String

#fault_domains ⇒ Array<String>

#freeform_tags ⇒ Hash<String, String>

#hostname ⇒ String

#initial_data_storage_size_in_gb ⇒ Integer

#kms_key_id ⇒ String

#kms_key_version_id ⇒ String

#node_count ⇒ Integer

#nsg_ids ⇒ Array<String>

#private_ip ⇒ String

#private_ip_v6 ⇒ String

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

#shape ⇒ String

#source ⇒ String

#sparse_diskgroup ⇒ BOOLEAN

#ssh_public_keys ⇒ Array<String>

#storage_volume_performance_mode ⇒ String

#subnet_id ⇒ String

#subscription_id ⇒ String

#time_zone ⇒ String

Class Method Details

.attribute_map ⇒ Object

.get_subtype(object_hash) ⇒ Object

.swagger_types ⇒ Object

Instance Method Details

#==(other) ⇒ Object

#build_from_hash(attributes) ⇒ Object

#eql?(other) ⇒ Boolean

#hash ⇒ Fixnum

#to_hash ⇒ Hash

#to_s ⇒ String

#initialize(attributes = {}) ⇒ `LaunchDbSystemBase`

#availability_domain ⇒ `String`

#backup_network_nsg_ids ⇒ `Array<String>`

#backup_subnet_id ⇒ `String`

#cluster_name ⇒ `String`

#cluster_placement_group_id ⇒ `String`

#compartment_id ⇒ `String`

#compute_count ⇒ `Integer`

#compute_model ⇒ `String`

#cpu_core_count ⇒ `Integer`

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

#data_storage_percentage ⇒ `Integer`

#db_system_options ⇒ `OCI::Database::Models::DbSystemOptions`

#defined_tags ⇒ `Hash<String, Hash<String, Object>>`

#display_name ⇒ `String`

#domain ⇒ `String`

#fault_domains ⇒ `Array<String>`

#freeform_tags ⇒ `Hash<String, String>`

#hostname ⇒ `String`

#initial_data_storage_size_in_gb ⇒ `Integer`

#kms_key_id ⇒ `String`

#kms_key_version_id ⇒ `String`

#node_count ⇒ `Integer`

#nsg_ids ⇒ `Array<String>`

#private_ip ⇒ `String`

#private_ip_v6 ⇒ `String`

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

#shape ⇒ `String`

#source ⇒ `String`

#sparse_diskgroup ⇒ `BOOLEAN`

#ssh_public_keys ⇒ `Array<String>`

#storage_volume_performance_mode ⇒ `String`

#subnet_id ⇒ `String`

#subscription_id ⇒ `String`

#time_zone ⇒ `String`

.attribute_map ⇒ `Object`

.get_subtype(object_hash) ⇒ `Object`

.swagger_types ⇒ `Object`

#==(other) ⇒ `Object`

#build_from_hash(attributes) ⇒ `Object`

#eql?(other) ⇒ `Boolean`

#hash ⇒ `Fixnum`

#to_hash ⇒ `Hash`

#to_s ⇒ `String`