Package com.oracle.bmc.mysql.model

Class DbSystem.Builder

  • Enclosing class:
    DbSystem
    public static class DbSystem.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public DbSystem.Builder id​(String id)
        The OCID of the DB System.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • displayName

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

        It does not have to be unique.

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

      • description

        public DbSystem.Builder description​(String description)
        User-provided data about the DB System.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • compartmentId

        public DbSystem.Builder compartmentId​(String compartmentId)
        The OCID of the compartment the DB System belongs in.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • subnetId

        public DbSystem.Builder subnetId​(String subnetId)
        The OCID of the subnet the DB System is associated with.
        Parameters:
        subnetId - the value to set
        Returns:
        this builder

      • nsgIds

        public DbSystem.Builder nsgIds​(List<String> nsgIds)
        Network Security Group OCIDs used for the VNIC attachment.
        Parameters:
        nsgIds - the value to set
        Returns:
        this builder

      • securityAttributes

        public DbSystem.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 ZPR Artifacts. Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “audit”}}}

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

      • isHighlyAvailable

        public DbSystem.Builder isHighlyAvailable​(Boolean isHighlyAvailable)
        Specifies if the DB System is highly available.
        Parameters:
        isHighlyAvailable - the value to set
        Returns:
        this builder

      • isHeatWaveClusterAttached

        public DbSystem.Builder isHeatWaveClusterAttached​(Boolean isHeatWaveClusterAttached)
        If the DB System has a HeatWave Cluster attached.
        Parameters:
        isHeatWaveClusterAttached - the value to set
        Returns:
        this builder

      • availabilityDomain

        public DbSystem.Builder availabilityDomain​(String availabilityDomain)
        The availability domain on which to deploy the Read/Write endpoint.

        This defines the preferred primary instance.

        In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

        For a standalone DB System, this defines the availability domain in which the DB System is placed.

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

      • faultDomain

        public DbSystem.Builder faultDomain​(String faultDomain)
        The fault domain on which to deploy the Read/Write endpoint.

        This defines the preferred primary instance.

        In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

        For a standalone DB System, this defines the fault domain in which the DB System is placed.

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

      • shapeName

        public DbSystem.Builder shapeName​(String shapeName)
        The shape of the primary instances of the DB System.

        The shape determines resources allocated to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use (the listShapes operation.

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

      • mysqlVersion

        public DbSystem.Builder mysqlVersion​(String mysqlVersion)
        Name of the MySQL Version in use for the DB System.
        Parameters:
        mysqlVersion - the value to set
        Returns:
        this builder

      • configurationId

        public DbSystem.Builder configurationId​(String configurationId)
        The OCID of the Configuration to be used for Instances in this DB System.
        Parameters:
        configurationId - the value to set
        Returns:
        this builder

      • dataStorageSizeInGBs

        public DbSystem.Builder dataStorageSizeInGBs​(Integer dataStorageSizeInGBs)
        DEPRECATED: User specified size of the data volume.

        May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs.

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

      • hostnameLabel

        public DbSystem.Builder hostnameLabel​(String hostnameLabel)
        The hostname for the primary endpoint of the DB System.

        Used for DNS. The value is the hostname portion of the primary private IP’s fully qualified domain name (FQDN) (for example, “dbsystem-1” in FQDN “dbsystem-1.subnet123.vcn1.oraclevcn.com”). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

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

      • ipAddress

        public DbSystem.Builder ipAddress​(String ipAddress)
        The IP address the DB System is configured to listen on.

        A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet’s CIDR. This will be a “dotted-quad” style IPv4 address.

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

      • port

        public DbSystem.Builder port​(Integer port)
        The port for primary endpoint of the DB System to listen on.
        Parameters:
        port - the value to set
        Returns:
        this builder

      • portX

        public DbSystem.Builder portX​(Integer portX)
        The network port on which X Plugin listens for TCP/IP connections.

        This is the X Plugin equivalent of port.

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

      • endpoints

        public DbSystem.Builder endpoints​(List<DbSystemEndpoint> endpoints)
        The network endpoints available for this DB System.
        Parameters:
        endpoints - the value to set
        Returns:
        this builder

      • channels

        public DbSystem.Builder channels​(List<ChannelSummary> channels)
        A list with a summary of all the Channels attached to the DB System.
        Parameters:
        channels - the value to set
        Returns:
        this builder

      • lifecycleState

        public DbSystem.Builder lifecycleState​(DbSystem.LifecycleState lifecycleState)
        The current state of the DB System.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • lifecycleDetails

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

      • timeCreated

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

      • timeUpdated

        public DbSystem.Builder timeUpdated​(Date timeUpdated)
        The time the DB System was last updated.
        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • freeformTags

        public DbSystem.Builder freeformTags​(Map<String,​String> freeformTags)
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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

      • definedTags

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

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

      • systemTags

        public DbSystem.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        Usage of system tag keys.

        These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

      • crashRecovery

        public DbSystem.Builder crashRecovery​(CrashRecoveryStatus crashRecovery)
        Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.
        Parameters:
        crashRecovery - the value to set
        Returns:
        this builder

      • databaseManagement

        public DbSystem.Builder databaseManagement​(DatabaseManagementStatus databaseManagement)
        Whether to enable monitoring via the Database Management service.
        Parameters:
        databaseManagement - the value to set
        Returns:
        this builder

      • databaseMode

        public DbSystem.Builder databaseMode​(DbSystem.DatabaseMode databaseMode)
        The database mode indicating the types of statements that are allowed to run in the the DB system.

        This mode applies only to statements run by user connections. Replicated write statements continue to be allowed regardless of the DatabaseMode. - READ_WRITE: allow running read and write statements on the DB system; - READ_ONLY: only allow running read statements on the DB system.

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

      • accessMode

        public DbSystem.Builder accessMode​(DbSystem.AccessMode accessMode)
        The access mode indicating if the database access is unrestricted (to all MySQL user accounts), or restricted (to only certain users with specific privileges): - UNRESTRICTED: the access to the database is not restricted; - RESTRICTED: access allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable offline_mode to ON.
        Parameters:
        accessMode - the value to set
        Returns:
        this builder

      • customerContacts

        public DbSystem.Builder customerContacts​(List<CustomerContact> customerContacts)
        The list of customer email addresses that receive information from Oracle about the specified OCI DB System resource.

        Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a DB System.

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