Package com.oracle.bmc.database.model

Class DbSystemSummary.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • compartmentId

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

      • displayName

        public DbSystemSummary.Builder displayName​(String displayName)
        The user-friendly name for the DB system.

        The name does not have to be unique.

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

      • availabilityDomain

        public DbSystemSummary.Builder availabilityDomain​(String availabilityDomain)
        The name of the availability domain that the DB system is located in.
        Parameters:
        availabilityDomain - the value to set
        Returns:
        this builder

      • faultDomains

        public DbSystemSummary.Builder faultDomains​(List<String> faultDomains)
        List of the Fault Domains in which this DB system is provisioned.
        Parameters:
        faultDomains - the value to set
        Returns:
        this builder

      • subnetId

        public DbSystemSummary.Builder subnetId​(String subnetId)
        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 backup subnet.

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

      • backupSubnetId

        public DbSystemSummary.Builder backupSubnetId​(String backupSubnetId)
        The OCID of the backup network subnet the DB system is associated with.

        Applicable only to Exadata DB systems.

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

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

      • nsgIds

        public DbSystemSummary.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 DbSystemSummary.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

      • giSoftwareImageId

        public DbSystemSummary.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

      • memorySizeInGBs

        public DbSystemSummary.Builder memorySizeInGBs​(Integer memorySizeInGBs)
        Memory allocated to the DB system, in gigabytes.
        Parameters:
        memorySizeInGBs - the value to set
        Returns:
        this builder

      • shape

        public DbSystemSummary.Builder shape​(String shape)
        The shape of the DB system.

        The shape determines resources to allocate 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, storage, and memory
        Parameters:
        shape - the value to set
        Returns:
        this builder

      • sshPublicKeys

        public DbSystemSummary.Builder sshPublicKeys​(List<String> sshPublicKeys)
        The public key portion of one or more key pairs used for SSH access to the DB system.
        Parameters:
        sshPublicKeys - the value to set
        Returns:
        this builder

      • hostname

        public DbSystemSummary.Builder hostname​(String hostname)
        The hostname for the DB system.
        Parameters:
        hostname - the value to set
        Returns:
        this builder

      • domain

        public DbSystemSummary.Builder domain​(String domain)
        The domain name for the DB system.
        Parameters:
        domain - the value to set
        Returns:
        this builder

      • kmsKeyId

        public DbSystemSummary.Builder kmsKeyId​(String kmsKeyId)
        The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
        Parameters:
        kmsKeyId - the value to set
        Returns:
        this builder

      • version

        public DbSystemSummary.Builder version​(String version)
        The Oracle Database version of the DB system.
        Parameters:
        version - the value to set
        Returns:
        this builder

      • osVersion

        public DbSystemSummary.Builder osVersion​(String osVersion)
        The most recent OS Patch Version applied on the DB system.
        Parameters:
        osVersion - the value to set
        Returns:
        this builder

      • cpuCoreCount

        public DbSystemSummary.Builder cpuCoreCount​(Integer cpuCoreCount)
        The number of CPU cores enabled on the DB system.
        Parameters:
        cpuCoreCount - the value to set
        Returns:
        this builder

      • clusterName

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

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

      • dataStoragePercentage

        public DbSystemSummary.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 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

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

      • lastPatchHistoryEntryId

        public DbSystemSummary.Builder lastPatchHistoryEntryId​(String lastPatchHistoryEntryId)
        The OCID of the last patch history.

        This value is updated as soon as a patch operation starts.

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

      • listenerPort

        public DbSystemSummary.Builder listenerPort​(Integer listenerPort)
        The port number configured for the listener on the DB system.
        Parameters:
        listenerPort - the value to set
        Returns:
        this builder

      • timeCreated

        public DbSystemSummary.Builder timeCreated​(Date timeCreated)
        The date and time the DB system was created.
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • lifecycleDetails

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

      • diskRedundancy

        public DbSystemSummary.Builder diskRedundancy​(DbSystemSummary.DiskRedundancy diskRedundancy)
        The type of redundancy configured for the DB system.

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

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

      • sparseDiskgroup

        public DbSystemSummary.Builder sparseDiskgroup​(Boolean sparseDiskgroup)
        True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.
        Parameters:
        sparseDiskgroup - the value to set
        Returns:
        this builder

      • scanIpIds

        public DbSystemSummary.Builder scanIpIds​(List<String> scanIpIds)
        The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system.

        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 DbSystemSummary.Builder vipIds​(List<String> vipIds)
        The OCID of the virtual IPv4 (VIP) addresses associated with the DB system.

        The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 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 DbSystemSummary.Builder scanIpv6Ids​(List<String> scanIpv6Ids)
        The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system.

        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 DbSystemSummary.Builder vipv6Ids​(List<String> vipv6Ids)
        The OCID of the virtual IPv6 (VIP) addresses associated with the DB system.

        The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system 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 DbSystemSummary.Builder scanDnsRecordId​(String scanDnsRecordId)
        The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
        Parameters:
        scanDnsRecordId - the value to set
        Returns:
        this builder

      • scanDnsName

        public DbSystemSummary.Builder scanDnsName​(String scanDnsName)
        The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
        Parameters:
        scanDnsName - the value to set
        Returns:
        this builder

      • zoneId

        public DbSystemSummary.Builder zoneId​(String zoneId)
        The OCID of the zone the DB system is associated with.
        Parameters:
        zoneId - the value to set
        Returns:
        this builder

      • dataStorageSizeInGBs

        public DbSystemSummary.Builder dataStorageSizeInGBs​(Integer dataStorageSizeInGBs)
        The data storage size, in gigabytes, that is currently available to the DB system.

        Applies only for virtual machine DB systems.

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

      • recoStorageSizeInGB

        public DbSystemSummary.Builder recoStorageSizeInGB​(Integer recoStorageSizeInGB)
        The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system.

        Applies only for virtual machine DB systems.

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

      • nodeCount

        public DbSystemSummary.Builder nodeCount​(Integer nodeCount)
        The number of nodes in the DB system.

        For RAC DB systems, the value is greater than 1.

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

      • licenseModel

        public DbSystemSummary.Builder licenseModel​(DbSystemSummary.LicenseModel licenseModel)
        The Oracle license model that applies to all the databases on the DB system.

        The default is LICENSE_INCLUDED.

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

      • lastMaintenanceRunId

        public DbSystemSummary.Builder lastMaintenanceRunId​(String lastMaintenanceRunId)
        The OCID of the last maintenance run.
        Parameters:
        lastMaintenanceRunId - the value to set
        Returns:
        this builder

      • nextMaintenanceRunId

        public DbSystemSummary.Builder nextMaintenanceRunId​(String nextMaintenanceRunId)
        The OCID of the next maintenance run.
        Parameters:
        nextMaintenanceRunId - the value to set
        Returns:
        this builder

      • freeformTags

        public DbSystemSummary.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

      • securityAttributes

        public DbSystemSummary.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

      • sourceDbSystemId

        public DbSystemSummary.Builder sourceDbSystemId​(String sourceDbSystemId)
        The OCID of the DB system.
        Parameters:
        sourceDbSystemId - the value to set
        Returns:
        this builder

      • pointInTimeDataDiskCloneTimestamp

        public DbSystemSummary.Builder pointInTimeDataDiskCloneTimestamp​(Date pointInTimeDataDiskCloneTimestamp)
        The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
        Parameters:
        pointInTimeDataDiskCloneTimestamp - the value to set
        Returns:
        this builder