@Generated(value="OracleSDKGenerator",
comments="API Version: 20160918")
public class LaunchDbSystemBase
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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.
Note: Objects should always be created or deserialized using the Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the Builder, which maintain a
set of all explicitly set fields called Builder#__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
LaunchDbSystemBase.Source
The source of the database: Use
NONE for creating a new database. |
static class |
LaunchDbSystemBase.StorageVolumePerformanceMode
The block storage volume performance level.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Modifier | Constructor and Description |
|---|---|
protected |
LaunchDbSystemBase(String compartmentId,
List<String> faultDomains,
String displayName,
String availabilityDomain,
String subnetId,
String backupSubnetId,
List<String> nsgIds,
List<String> backupNetworkNsgIds,
String shape,
String timeZone,
DbSystemOptions dbSystemOptions,
LaunchDbSystemBase.StorageVolumePerformanceMode storageVolumePerformanceMode,
Boolean sparseDiskgroup,
List<String> sshPublicKeys,
String hostname,
String domain,
Integer cpuCoreCount,
String clusterName,
Integer dataStoragePercentage,
Integer initialDataStorageSizeInGB,
String kmsKeyId,
String kmsKeyVersionId,
Integer nodeCount,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> securityAttributes,
String privateIp,
DataCollectionOptions dataCollectionOptions)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object o) |
String |
getAvailabilityDomain()
The availability domain where the DB system is located.
|
List<String> |
getBackupNetworkNsgIds()
A list of the OCIDs
of the network security groups (NSGs) that the backup network of this DB system belongs to.
|
String |
getBackupSubnetId()
The OCID of the
backup network subnet the DB system is associated with.
|
String |
getClusterName()
The cluster name for Exadata and 2-node RAC virtual machine DB systems.
|
String |
getCompartmentId()
The OCID of the
compartment the DB system belongs in.
|
Integer |
getCpuCoreCount()
The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems.
|
DataCollectionOptions |
getDataCollectionOptions() |
Integer |
getDataStoragePercentage()
The percentage assigned to DATA storage (user data and database files).
|
DbSystemOptions |
getDbSystemOptions() |
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
The user-friendly name for the DB system.
|
String |
getDomain()
A domain name used for the DB system.
|
List<String> |
getFaultDomains()
A Fault Domain is a grouping of hardware and infrastructure within an availability domain.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getHostname()
The hostname for the DB system.
|
Integer |
getInitialDataStorageSizeInGB()
Size (in GB) of the initial data volume that will be created and attached to a virtual
machine DB system.
|
String |
getKmsKeyId()
The OCID of the key container that is used as the master encryption key in database
transparent data encryption (TDE) operations.
|
String |
getKmsKeyVersionId()
The OCID of the key container version that is used in database transparent data encryption
(TDE) operations KMS Key can have multiple key versions.
|
Integer |
getNodeCount()
The number of nodes to launch for a 2-node RAC virtual machine DB system.
|
List<String> |
getNsgIds()
The list of OCIDs
for the network security groups (NSGs) to which this resource belongs.
|
String |
getPrivateIp()
A private IP address of your choice.
|
Map<String,Map<String,Object>> |
getSecurityAttributes()
Security Attributes for this resource.
|
String |
getShape()
The shape of the DB system.
|
Boolean |
getSparseDiskgroup()
If true, Sparse Diskgroup is configured for Exadata dbsystem.
|
List<String> |
getSshPublicKeys()
The public key portion of the key pair to use for SSH access to the DB system.
|
LaunchDbSystemBase.StorageVolumePerformanceMode |
getStorageVolumePerformanceMode()
The block storage volume performance level.
|
String |
getSubnetId()
The OCID of the
subnet the DB system is associated with.
|
String |
getTimeZone()
The time zone to use for the DB system.
|
int |
hashCode() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"compartmentId","faultDomains","displayName","availabilityDomain","subnetId","backupSubnetId","nsgIds","backupNetworkNsgIds","shape","timeZone","dbSystemOptions","storageVolumePerformanceMode","sparseDiskgroup","sshPublicKeys","hostname","domain","cpuCoreCount","clusterName","dataStoragePercentage","initialDataStorageSizeInGB","kmsKeyId","kmsKeyVersionId","nodeCount","freeformTags","definedTags","securityAttributes","privateIp","dataCollectionOptions"}) protected LaunchDbSystemBase(String compartmentId, List<String> faultDomains, String displayName, String availabilityDomain, String subnetId, String backupSubnetId, List<String> nsgIds, List<String> backupNetworkNsgIds, String shape, String timeZone, DbSystemOptions dbSystemOptions, LaunchDbSystemBase.StorageVolumePerformanceMode storageVolumePerformanceMode, Boolean sparseDiskgroup, List<String> sshPublicKeys, String hostname, String domain, Integer cpuCoreCount, String clusterName, Integer dataStoragePercentage, Integer initialDataStorageSizeInGB, String kmsKeyId, String kmsKeyVersionId, Integer nodeCount, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> securityAttributes, String privateIp, DataCollectionOptions dataCollectionOptions)
public String getCompartmentId()
The OCID of the compartment the DB system belongs in.
public List<String> getFaultDomains()
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 listFaultDomains operation in the Identity and Access Management Service API.
Example: FAULT-DOMAIN-1
public String getDisplayName()
The user-friendly name for the DB system. The name does not have to be unique.
public String getAvailabilityDomain()
The availability domain where the DB system is located.
public String getSubnetId()
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.
public String getBackupSubnetId()
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**.
public List<String> getNsgIds()
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 Databases with private access. The nsgIds list can be empty.
public List<String> getBackupNetworkNsgIds()
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.
public String getShape()
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 listDbSystemShapes operation.
public String getTimeZone()
The time zone to use for the DB system. For details, see DB System Time Zones.
public DbSystemOptions getDbSystemOptions()
public LaunchDbSystemBase.StorageVolumePerformanceMode getStorageVolumePerformanceMode()
The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume
Performance
for more information.
public Boolean getSparseDiskgroup()
If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured.
public List<String> getSshPublicKeys()
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.
public String getHostname()
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.
public String getDomain()
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.
public Integer getCpuCoreCount()
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](https://docs.cloud.oracle.com/Content/Database/Concepts/overview.htm#virtualmachine)
public String getClusterName()
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.
public Integer getDataStoragePercentage()
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.
public Integer getInitialDataStorageSizeInGB()
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.
public String getKmsKeyId()
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
public String getKmsKeyVersionId()
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 Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
public Integer getNodeCount()
The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.
public Map<String,String> getFreeformTags()
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"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
public Map<String,Map<String,Object>> getSecurityAttributes()
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"}}}
public String getPrivateIp()
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.
public DataCollectionOptions getDataCollectionOptions()
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.