Package com.oracle.bmc.databasemanagement

Interface ManagedMySqlDatabases

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ManagedMySqlDatabasesClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20201101")
public interface ManagedMySqlDatabases
extends AutoCloseable
    Use the Database Management API to monitor and manage resources such as Oracle Databases, MySQL Databases, and External Database Systems.

    For more information, see Database Management.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • changeMysqlDatabaseManagementType

        ChangeMysqlDatabaseManagementTypeResponse changeMysqlDatabaseManagementType​(ChangeMysqlDatabaseManagementTypeRequest request)
        Changes the management type for a HeatWave MySQL instance, from BASIC to FULL and vice versa.

        It can also be used to enable or disable database management.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/ChangeMysqlDatabaseManagementTypeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeMysqlDatabaseManagementType API.

      • getBinaryLogInformation

        GetBinaryLogInformationResponse getBinaryLogInformation​(GetBinaryLogInformationRequest request)
        Retrieves information pertaining to binary log of a specific MySQL server.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/GetBinaryLogInformationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBinaryLogInformation API.

      • getGeneralReplicationInformation

        GetGeneralReplicationInformationResponse getGeneralReplicationInformation​(GetGeneralReplicationInformationRequest request)
        Retrieves general information regarding replication of a specific MySQL server.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/GetGeneralReplicationInformationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetGeneralReplicationInformation API.

      • getHeatWaveFleetMetric

        GetHeatWaveFleetMetricResponse getHeatWaveFleetMetric​(GetHeatWaveFleetMetricRequest request)
        Gets the health metrics for a fleet of HeatWave clusters in a compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/GetHeatWaveFleetMetricExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetHeatWaveFleetMetric API.

      • getManagedMySqlDatabase

        GetManagedMySqlDatabaseResponse getManagedMySqlDatabase​(GetManagedMySqlDatabaseRequest request)
        Retrieves the general information for a specific MySQL Database.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/GetManagedMySqlDatabaseExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetManagedMySqlDatabase API.

      • getMySqlFleetMetric

        GetMySqlFleetMetricResponse getMySqlFleetMetric​(GetMySqlFleetMetricRequest request)
        Gets the health metrics for a fleet of MySQL Databases in a compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/GetMySqlFleetMetricExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetMySqlFleetMetric API.

      • getMySqlQueryDetails

        GetMySqlQueryDetailsResponse getMySqlQueryDetails​(GetMySqlQueryDetailsRequest request)
        Retrieves query sample details, explain plan and potential warnings for a given digest.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/GetMySqlQueryDetailsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetMySqlQueryDetails API.

      • listHighAvailabilityMembers

        ListHighAvailabilityMembersResponse listHighAvailabilityMembers​(ListHighAvailabilityMembersRequest request)
        Information about high availability members of a specific MySQL server’s replication group.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/ListHighAvailabilityMembersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListHighAvailabilityMembers API.

      • listInboundReplications

        ListInboundReplicationsResponse listInboundReplications​(ListInboundReplicationsRequest request)
        Retrieves information about the inbound replications of a specific MySQL server.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/ListInboundReplicationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInboundReplications API.

      • listManagedMySqlDatabaseConfigurationData

        ListManagedMySqlDatabaseConfigurationDataResponse listManagedMySqlDatabaseConfigurationData​(ListManagedMySqlDatabaseConfigurationDataRequest request)
        Retrieves configuration data for a specific MySQL database.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/ListManagedMySqlDatabaseConfigurationDataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListManagedMySqlDatabaseConfigurationData API.

      • listManagedMySqlDatabaseSqlData

        ListManagedMySqlDatabaseSqlDataResponse listManagedMySqlDatabaseSqlData​(ListManagedMySqlDatabaseSqlDataRequest request)
        Retrieves the SQL performance data for a specific MySQL database.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/ListManagedMySqlDatabaseSqlDataExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListManagedMySqlDatabaseSqlData API.

      • listManagedMySqlDatabases

        ListManagedMySqlDatabasesResponse listManagedMySqlDatabases​(ListManagedMySqlDatabasesRequest request)
        Gets the list of Managed MySQL Databases in a specific compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/ListManagedMySqlDatabasesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListManagedMySqlDatabases API.

      • listMySqlDigestErrors

        ListMySqlDigestErrorsResponse listMySqlDigestErrors​(ListMySqlDigestErrorsRequest request)
        Retrieves any potential errors for a given digest.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/ListMySqlDigestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListMySqlDigestErrors API.

      • listOutboundReplications

        ListOutboundReplicationsResponse listOutboundReplications​(ListOutboundReplicationsRequest request)
        Retrieves information pertaining to outbound replications of a specific MySQL server.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/ListOutboundReplicationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOutboundReplications API.

      • summarizeManagedMySqlDatabaseAvailabilityMetrics

        SummarizeManagedMySqlDatabaseAvailabilityMetricsResponse summarizeManagedMySqlDatabaseAvailabilityMetrics​(SummarizeManagedMySqlDatabaseAvailabilityMetricsRequest request)
        Gets the availability metrics for the MySQL Database specified by managedMySqlDatabaseId.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.0/databasemanagement/SummarizeManagedMySqlDatabaseAvailabilityMetricsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SummarizeManagedMySqlDatabaseAvailabilityMetrics API.

      • getWaiters

        ManagedMySqlDatabasesWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        ManagedMySqlDatabasesPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.