Package com.oracle.bmc.database.model

Class LaunchDbSystemBase

  • Direct Known Subclasses:
    LaunchDbSystemDetails, LaunchDbSystemFromBackupDetails, LaunchDbSystemFromDatabaseDetails, LaunchDbSystemFromDbSystemDetails
    @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).

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment the DB system belongs in.
        Returns:
        the value

      • getFaultDomains

        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

        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The user-friendly name for the DB system.

        The name does not have to be unique.

        Returns:
        the value

      • getAvailabilityDomain

        public String getAvailabilityDomain()
        The availability domain where the DB system is located.
        Returns:
        the value

      • getSubnetId

        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.

        Returns:
        the value

      • getBackupSubnetId

        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**.

        Returns:
        the value

      • getNsgIds

        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.

        Returns:
        the value

      • getBackupNetworkNsgIds

        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.

        Returns:
        the value

      • getShape

        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.

        Returns:
        the value

      • getTimeZone

        public String getTimeZone()
        The time zone to use for the DB system.

        For details, see DB System Time Zones.

        Returns:
        the value

      • getSparseDiskgroup

        public Boolean getSparseDiskgroup()
        If true, Sparse Diskgroup is configured for Exadata dbsystem.

        If False, Sparse diskgroup is not configured.

        Returns:
        the value

      • getSshPublicKeys

        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.

        Returns:
        the value

      • getHostname

        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.

        Returns:
        the value

      • getDomain

        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.

        Returns:
        the value

      • getCpuCoreCount

        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.oracle.com/iaas/Content/Database/Concepts/overview.htm#virtualmachine)

        Returns:
        the value

      • getClusterName

        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.

        Returns:
        the value

      • getDataStoragePercentage

        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.

        Returns:
        the value

      • getInitialDataStorageSizeInGB

        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.

        Returns:
        the value

      • getKmsKeyId

        public String getKmsKeyId()
        The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
        Returns:
        the value

      • getKmsKeyVersionId

        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.

        Returns:
        the value

      • getNodeCount

        public Integer getNodeCount()
        The number of nodes to launch for a 2-node RAC virtual machine DB system.

        Specify either 1 or 2.

        Returns:
        the value

      • getFreeformTags

        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"}

        Returns:
        the value

      • getDefinedTags

        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.

        Returns:
        the value

      • getSecurityAttributes

        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”}}}

        Returns:
        the value

      • getPrivateIp

        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.

        Returns:
        the value

      • getPrivateIpV6

        public String getPrivateIpV6()
        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:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel