Package com.oracle.bmc.mysql.model

Class DbSystem

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
public final class DbSystem
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A DB System is the core logical unit of MySQL Database Service.
    Note: Objects should always be created or deserialized using the DbSystem.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 DbSystem.Builder, which maintain a set of all explicitly set fields called DbSystem.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

      • getId

        public String getId()
        The OCID of the DB System.
        Returns:
        the value

      • getDisplayName

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

        It does not have to be unique.

        Returns:
        the value

      • getDescription

        public String getDescription()
        User-provided data about the DB System.
        Returns:
        the value

      • getCompartmentId

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

      • getSubnetId

        public String getSubnetId()
        The OCID of the subnet the DB System is associated with.
        Returns:
        the value

      • getNsgIds

        public List<String> getNsgIds()
        Network Security Group OCIDs used for the VNIC attachment.
        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 ZPR Artifacts. Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “audit”}}}

        Returns:
        the value

      • getIsHighlyAvailable

        public Boolean getIsHighlyAvailable()
        Specifies if the DB System is highly available.
        Returns:
        the value

      • getIsHeatWaveClusterAttached

        public Boolean getIsHeatWaveClusterAttached()
        If the DB System has a HeatWave Cluster attached.
        Returns:
        the value

      • getAvailabilityDomain

        public String getAvailabilityDomain()
        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.

        Returns:
        the value

      • getFaultDomain

        public String getFaultDomain()
        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.

        Returns:
        the value

      • getShapeName

        public String getShapeName()
        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.

        Returns:
        the value

      • getMysqlVersion

        public String getMysqlVersion()
        Name of the MySQL Version in use for the DB System.
        Returns:
        the value

      • getConfigurationId

        public String getConfigurationId()
        The OCID of the Configuration to be used for Instances in this DB System.
        Returns:
        the value

      • getDataStorageSizeInGBs

        public Integer getDataStorageSizeInGBs()
        DEPRECATED: User specified size of the data volume.

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

        Returns:
        the value

      • getHostnameLabel

        public String getHostnameLabel()
        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.

        Returns:
        the value

      • getIpAddress

        public String getIpAddress()
        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.

        Returns:
        the value

      • getPort

        public Integer getPort()
        The port for primary endpoint of the DB System to listen on.
        Returns:
        the value

      • getPortX

        public Integer getPortX()
        The network port on which X Plugin listens for TCP/IP connections.

        This is the X Plugin equivalent of port.

        Returns:
        the value

      • getEndpoints

        public List<DbSystemEndpoint> getEndpoints()
        The network endpoints available for this DB System.
        Returns:
        the value

      • getChannels

        public List<ChannelSummary> getChannels()
        A list with a summary of all the Channels attached to the DB System.
        Returns:
        the value

      • getLifecycleState

        public DbSystem.LifecycleState getLifecycleState()
        The current state of the DB System.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        Additional information about the current lifecycleState.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the DB System was created.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time the DB System was last updated.
        Returns:
        the value

      • getFreeformTags

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

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

        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. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value

      • getSystemTags

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

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

        Returns:
        the value

      • getCrashRecovery

        public CrashRecoveryStatus getCrashRecovery()
        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.
        Returns:
        the value

      • getDatabaseManagement

        public DatabaseManagementStatus getDatabaseManagement()
        Whether to enable monitoring via the Database Management service.
        Returns:
        the value

      • getDatabaseMode

        public DbSystem.DatabaseMode getDatabaseMode()
        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.

        Returns:
        the value

      • getAccessMode

        public DbSystem.AccessMode getAccessMode()
        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.
        Returns:
        the value

      • getCustomerContacts

        public List<CustomerContact> getCustomerContacts()
        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.

        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