Class CloudVmCluster.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • compartmentId

        public CloudVmCluster.Builder compartmentId​(String compartmentId)
        The OCID of the compartment.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder
      • subscriptionId

        public CloudVmCluster.Builder subscriptionId​(String subscriptionId)
        The OCID of the subscription with which resource needs to be associated with.
        Parameters:
        subscriptionId - the value to set
        Returns:
        this builder
      • availabilityDomain

        public CloudVmCluster.Builder availabilityDomain​(String availabilityDomain)
        The name of the availability domain that the cloud Exadata infrastructure resource is located in.
        Parameters:
        availabilityDomain - the value to set
        Returns:
        this builder
      • subnetId

        public CloudVmCluster.Builder subnetId​(String subnetId)
        The OCID of the subnet associated with the cloud VM cluster.

        *Subnet Restrictions:** - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.

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

        Parameters:
        subnetId - the value to set
        Returns:
        this builder
      • backupSubnetId

        public CloudVmCluster.Builder backupSubnetId​(String backupSubnetId)
        The OCID of the backup network subnet associated with the cloud VM cluster.

        *Subnet Restriction:** See the subnet restrictions information for **subnetId**.

        Parameters:
        backupSubnetId - the value to set
        Returns:
        this builder
      • nsgIds

        public CloudVmCluster.Builder nsgIds​(List<String> nsgIds)
        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.

        Parameters:
        nsgIds - the value to set
        Returns:
        this builder
      • backupNetworkNsgIds

        public CloudVmCluster.Builder backupNetworkNsgIds​(List<String> backupNetworkNsgIds)
        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.

        Parameters:
        backupNetworkNsgIds - the value to set
        Returns:
        this builder
      • lastUpdateHistoryEntryId

        public CloudVmCluster.Builder lastUpdateHistoryEntryId​(String lastUpdateHistoryEntryId)
        The OCID of the last maintenance update history entry.

        This value is updated when a maintenance update starts.

        Parameters:
        lastUpdateHistoryEntryId - the value to set
        Returns:
        this builder
      • shape

        public CloudVmCluster.Builder shape​(String shape)
        The model name of the Exadata hardware running the cloud VM cluster.
        Parameters:
        shape - the value to set
        Returns:
        this builder
      • listenerPort

        public CloudVmCluster.Builder listenerPort​(Long listenerPort)
        The port number configured for the listener on the cloud VM cluster.
        Parameters:
        listenerPort - the value to set
        Returns:
        this builder
      • nodeCount

        public CloudVmCluster.Builder nodeCount​(Integer nodeCount)
        The number of nodes in the cloud VM cluster.
        Parameters:
        nodeCount - the value to set
        Returns:
        this builder
      • storageSizeInGBs

        public CloudVmCluster.Builder storageSizeInGBs​(Integer storageSizeInGBs)
        The storage allocation for the disk group, in gigabytes (GB).
        Parameters:
        storageSizeInGBs - the value to set
        Returns:
        this builder
      • displayName

        public CloudVmCluster.Builder displayName​(String displayName)
        The user-friendly name for the cloud VM cluster.

        The name does not need to be unique.

        Parameters:
        displayName - the value to set
        Returns:
        this builder
      • timeCreated

        public CloudVmCluster.Builder timeCreated​(Date timeCreated)
        The date and time that the cloud VM cluster was created.
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder
      • lifecycleDetails

        public CloudVmCluster.Builder lifecycleDetails​(String lifecycleDetails)
        Additional information about the current lifecycle state.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder
      • hostname

        public CloudVmCluster.Builder hostname​(String hostname)
        The hostname for the cloud VM cluster.
        Parameters:
        hostname - the value to set
        Returns:
        this builder
      • domain

        public CloudVmCluster.Builder domain​(String domain)
        The domain name for the cloud VM cluster.
        Parameters:
        domain - the value to set
        Returns:
        this builder
      • cpuCoreCount

        public CloudVmCluster.Builder cpuCoreCount​(Integer cpuCoreCount)
        The number of CPU cores enabled on the cloud VM cluster.
        Parameters:
        cpuCoreCount - the value to set
        Returns:
        this builder
      • ocpuCount

        public CloudVmCluster.Builder ocpuCount​(Float ocpuCount)
        The number of OCPU cores to enable on the cloud VM cluster.

        Only 1 decimal place is allowed for the fractional part.

        Parameters:
        ocpuCount - the value to set
        Returns:
        this builder
      • memorySizeInGBs

        public CloudVmCluster.Builder memorySizeInGBs​(Integer memorySizeInGBs)
        The memory to be allocated in GBs.
        Parameters:
        memorySizeInGBs - the value to set
        Returns:
        this builder
      • dbNodeStorageSizeInGBs

        public CloudVmCluster.Builder dbNodeStorageSizeInGBs​(Integer dbNodeStorageSizeInGBs)
        The local node storage to be allocated in GBs.
        Parameters:
        dbNodeStorageSizeInGBs - the value to set
        Returns:
        this builder
      • dataStorageSizeInTBs

        public CloudVmCluster.Builder dataStorageSizeInTBs​(Double dataStorageSizeInTBs)
        The data disk group size to be allocated in TBs.
        Parameters:
        dataStorageSizeInTBs - the value to set
        Returns:
        this builder
      • dbServers

        public CloudVmCluster.Builder dbServers​(List<String> dbServers)
        The list of DB servers.
        Parameters:
        dbServers - the value to set
        Returns:
        this builder
      • clusterName

        public CloudVmCluster.Builder clusterName​(String clusterName)
        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.

        Parameters:
        clusterName - the value to set
        Returns:
        this builder
      • dataStoragePercentage

        public CloudVmCluster.Builder dataStoragePercentage​(Integer dataStoragePercentage)
        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). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

        Parameters:
        dataStoragePercentage - the value to set
        Returns:
        this builder
      • isLocalBackupEnabled

        public CloudVmCluster.Builder isLocalBackupEnabled​(Boolean isLocalBackupEnabled)
        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.

        Parameters:
        isLocalBackupEnabled - the value to set
        Returns:
        this builder
      • cloudExadataInfrastructureId

        public CloudVmCluster.Builder cloudExadataInfrastructureId​(String cloudExadataInfrastructureId)
        The OCID of the cloud Exadata infrastructure.
        Parameters:
        cloudExadataInfrastructureId - the value to set
        Returns:
        this builder
      • isSparseDiskgroupEnabled

        public CloudVmCluster.Builder isSparseDiskgroupEnabled​(Boolean isSparseDiskgroupEnabled)
        If true, sparse disk group is configured for the cloud VM cluster.

        If false, sparse disk group is not created.

        Parameters:
        isSparseDiskgroupEnabled - the value to set
        Returns:
        this builder
      • giVersion

        public CloudVmCluster.Builder giVersion​(String giVersion)
        A valid Oracle Grid Infrastructure (GI) software version.
        Parameters:
        giVersion - the value to set
        Returns:
        this builder
      • systemVersion

        public CloudVmCluster.Builder systemVersion​(String systemVersion)
        Operating system version of the image.
        Parameters:
        systemVersion - the value to set
        Returns:
        this builder
      • sshPublicKeys

        public CloudVmCluster.Builder sshPublicKeys​(List<String> sshPublicKeys)
        The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.
        Parameters:
        sshPublicKeys - the value to set
        Returns:
        this builder
      • licenseModel

        public CloudVmCluster.Builder licenseModel​(CloudVmCluster.LicenseModel licenseModel)
        The Oracle license model that applies to the cloud VM cluster.

        The default is LICENSE_INCLUDED.

        Parameters:
        licenseModel - the value to set
        Returns:
        this builder
      • diskRedundancy

        public CloudVmCluster.Builder diskRedundancy​(CloudVmCluster.DiskRedundancy diskRedundancy)
        The type of redundancy configured for the cloud Vm cluster.

        NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

        Parameters:
        diskRedundancy - the value to set
        Returns:
        this builder
      • scanIpIds

        public CloudVmCluster.Builder scanIpIds​(List<String> scanIpIds)
        The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the cloud VM cluster.

        SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.

        *Note:** For a single-node DB system, this list is empty.

        Parameters:
        scanIpIds - the value to set
        Returns:
        this builder
      • vipIds

        public CloudVmCluster.Builder vipIds​(List<String> vipIds)
        The OCID of the virtual IP (VIP) IPv4 addresses associated with the cloud VM cluster.

        The Cluster Ready Services (CRS) creates and maintains one VIP IPv4 address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.

        *Note:** For a single-node DB system, this list is empty.

        Parameters:
        vipIds - the value to set
        Returns:
        this builder
      • scanIpv6Ids

        public CloudVmCluster.Builder scanIpv6Ids​(List<String> scanIpv6Ids)
        The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the cloud VM cluster.

        SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.

        *Note:** For a single-node DB system, this list is empty.

        Parameters:
        scanIpv6Ids - the value to set
        Returns:
        this builder
      • vipv6Ids

        public CloudVmCluster.Builder vipv6Ids​(List<String> vipv6Ids)
        The OCID of the virtual IP (VIP) IPv6 addresses associated with the cloud VM cluster.

        The Cluster Ready Services (CRS) creates and maintains one VIP IPv6 address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.

        *Note:** For a single-node DB system, this list is empty.

        Parameters:
        vipv6Ids - the value to set
        Returns:
        this builder
      • scanDnsRecordId

        public CloudVmCluster.Builder scanDnsRecordId​(String scanDnsRecordId)
        The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.
        Parameters:
        scanDnsRecordId - the value to set
        Returns:
        this builder
      • freeformTags

        public CloudVmCluster.Builder freeformTags​(Map<String,​String> freeformTags)
        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"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder
      • definedTags

        public CloudVmCluster.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Parameters:
        definedTags - the value to set
        Returns:
        this builder
      • securityAttributes

        public CloudVmCluster.Builder securityAttributes​(Map<String,​Map<String,​Object>> securityAttributes)
        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”}}}

        Parameters:
        securityAttributes - the value to set
        Returns:
        this builder
      • scanDnsName

        public CloudVmCluster.Builder scanDnsName​(String scanDnsName)
        The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.
        Parameters:
        scanDnsName - the value to set
        Returns:
        this builder
      • zoneId

        public CloudVmCluster.Builder zoneId​(String zoneId)
        The OCID of the zone the cloud VM cluster is associated with.
        Parameters:
        zoneId - the value to set
        Returns:
        this builder
      • scanListenerPortTcp

        public CloudVmCluster.Builder scanListenerPortTcp​(Integer scanListenerPortTcp)
        The TCP Single Client Access Name (SCAN) port.

        The default port is 1521.

        Parameters:
        scanListenerPortTcp - the value to set
        Returns:
        this builder
      • scanListenerPortTcpSsl

        public CloudVmCluster.Builder scanListenerPortTcpSsl​(Integer scanListenerPortTcpSsl)
        The TCPS Single Client Access Name (SCAN) port.

        The default port is 2484.

        Parameters:
        scanListenerPortTcpSsl - the value to set
        Returns:
        this builder
      • giSoftwareImageId

        public CloudVmCluster.Builder giSoftwareImageId​(String giSoftwareImageId)
        The OCID of a grid infrastructure software image.

        This is a database software image of the type GRID_IMAGE.

        Parameters:
        giSoftwareImageId - the value to set
        Returns:
        this builder
      • fileSystemConfigurationDetails

        public CloudVmCluster.Builder fileSystemConfigurationDetails​(List<FileSystemConfigurationDetail> fileSystemConfigurationDetails)
        Details of the file system configuration of the VM cluster.
        Parameters:
        fileSystemConfigurationDetails - the value to set
        Returns:
        this builder
      • computeModel

        public CloudVmCluster.Builder computeModel​(CloudVmCluster.ComputeModel computeModel)
        The compute model of the Autonomous Database.

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

        Parameters:
        computeModel - the value to set
        Returns:
        this builder