Package com.oracle.bmc.mysql

Interface DbBackupsAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DbBackupsAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
public interface DbBackupsAsync
extends AutoCloseable
    The API for the MySQL Database Service

    • 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 serice.

      • 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

      • cancelBackupDeletion

        Future<CancelBackupDeletionResponse> cancelBackupDeletion​(CancelBackupDeletionRequest request,
                                                          AsyncHandler<CancelBackupDeletionRequest,​CancelBackupDeletionResponse> handler)
        Cancels the scheduled deletion of a backup and moves it to ACTIVE state.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • changeBackupCompartment

        Future<ChangeBackupCompartmentResponse> changeBackupCompartment​(ChangeBackupCompartmentRequest request,
                                                                AsyncHandler<ChangeBackupCompartmentRequest,​ChangeBackupCompartmentResponse> handler)
        Moves a DB System Backup into a different compartment.

        When provided, If-Match is checked against ETag values of the Backup.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • copyBackup

        Future<CopyBackupResponse> copyBackup​(CopyBackupRequest request,
                                      AsyncHandler<CopyBackupRequest,​CopyBackupResponse> handler)
        Creates a copy of a DB system backup available in the specified source region.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createBackup

        Future<CreateBackupResponse> createBackup​(CreateBackupRequest request,
                                          AsyncHandler<CreateBackupRequest,​CreateBackupResponse> handler)
        Create a backup of a DB System.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteBackup

        Future<DeleteBackupResponse> deleteBackup​(DeleteBackupRequest request,
                                          AsyncHandler<DeleteBackupRequest,​DeleteBackupResponse> handler)
        Delete a Backup.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getBackup

        Future<GetBackupResponse> getBackup​(GetBackupRequest request,
                                    AsyncHandler<GetBackupRequest,​GetBackupResponse> handler)
        Get information about the specified Backup
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listBackups

        Future<ListBackupsResponse> listBackups​(ListBackupsRequest request,
                                        AsyncHandler<ListBackupsRequest,​ListBackupsResponse> handler)
        Get a list of DB System backups.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateBackup

        Future<UpdateBackupResponse> updateBackup​(UpdateBackupRequest request,
                                          AsyncHandler<UpdateBackupRequest,​UpdateBackupResponse> handler)
        Update the metadata of a Backup.

        Metadata such as the displayName or description

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • validateBackup

        Future<ValidateBackupResponse> validateBackup​(ValidateBackupRequest request,
                                              AsyncHandler<ValidateBackupRequest,​ValidateBackupResponse> handler)
        Request to validate the backup by checking the data consistency.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.