Package com.oracle.bmc.recovery

Interface DatabaseRecoveryAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DatabaseRecoveryAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210216")
public interface DatabaseRecoveryAsync
extends AutoCloseable
    Use Oracle Database Autonomous Recovery Service API to manage Protected Databases.

    • 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

      • cancelProtectedDatabaseDeletion

        Future<CancelProtectedDatabaseDeletionResponse> cancelProtectedDatabaseDeletion​(CancelProtectedDatabaseDeletionRequest request,
                                                                                AsyncHandler<CancelProtectedDatabaseDeletionRequest,​CancelProtectedDatabaseDeletionResponse> handler)
        Cancels the scheduled deletion of a protected database, and returns the protected database to an ACTIVE state.

        You can cancel the deletion only if the protected database is in the DELETE SCHEDULED 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.

      • createProtectionPolicy

        Future<CreateProtectionPolicyResponse> createProtectionPolicy​(CreateProtectionPolicyRequest request,
                                                              AsyncHandler<CreateProtectionPolicyRequest,​CreateProtectionPolicyResponse> handler)
        Creates a new Protection Policy.
        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.

      • deleteProtectedDatabase

        Future<DeleteProtectedDatabaseResponse> deleteProtectedDatabase​(DeleteProtectedDatabaseRequest request,
                                                                AsyncHandler<DeleteProtectedDatabaseRequest,​DeleteProtectedDatabaseResponse> handler)
        Deletes a protected database based on the specified protected database ID.
        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.

      • deleteProtectionPolicy

        Future<DeleteProtectionPolicyResponse> deleteProtectionPolicy​(DeleteProtectionPolicyRequest request,
                                                              AsyncHandler<DeleteProtectionPolicyRequest,​DeleteProtectionPolicyResponse> handler)
        Deletes a specified protection policy.

        You can delete custom policies only. Deleting a Oracle predefined policies will result in status code 405 Method Not Allowed.

        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.

      • getProtectedDatabase

        Future<GetProtectedDatabaseResponse> getProtectedDatabase​(GetProtectedDatabaseRequest request,
                                                          AsyncHandler<GetProtectedDatabaseRequest,​GetProtectedDatabaseResponse> handler)
        Gets information about a specified protected database.
        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.

      • getProtectionPolicy

        Future<GetProtectionPolicyResponse> getProtectionPolicy​(GetProtectionPolicyRequest request,
                                                        AsyncHandler<GetProtectionPolicyRequest,​GetProtectionPolicyResponse> handler)
        Gets information about a specified protection policy.
        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.

      • getRecoveryServiceSubnet

        Future<GetRecoveryServiceSubnetResponse> getRecoveryServiceSubnet​(GetRecoveryServiceSubnetRequest request,
                                                                  AsyncHandler<GetRecoveryServiceSubnetRequest,​GetRecoveryServiceSubnetResponse> handler)
        Gets information about a specified recovery service subnet.
        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.

      • getWorkRequest

        Future<GetWorkRequestResponse> getWorkRequest​(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,​GetWorkRequestResponse> handler)
        Gets the status of the work request based on the specified ID
        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.

      • listProtectedDatabases

        Future<ListProtectedDatabasesResponse> listProtectedDatabases​(ListProtectedDatabasesRequest request,
                                                              AsyncHandler<ListProtectedDatabasesRequest,​ListProtectedDatabasesResponse> handler)
        Lists the protected databases based on the specified parameters.
        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.

      • listProtectionPolicies

        Future<ListProtectionPoliciesResponse> listProtectionPolicies​(ListProtectionPoliciesRequest request,
                                                              AsyncHandler<ListProtectionPoliciesRequest,​ListProtectionPoliciesResponse> handler)
        Gets a list of protection policies based on the specified parameters.
        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.

      • listWorkRequestErrors

        Future<ListWorkRequestErrorsResponse> listWorkRequestErrors​(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,​ListWorkRequestErrorsResponse> handler)
        Return a (paginated) list of errors for a given work request.
        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.

      • listWorkRequestLogs

        Future<ListWorkRequestLogsResponse> listWorkRequestLogs​(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,​ListWorkRequestLogsResponse> handler)
        Return a (paginated) list of logs for a given work request.
        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.

      • listWorkRequests

        Future<ListWorkRequestsResponse> listWorkRequests​(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,​ListWorkRequestsResponse> handler)
        Lists the work requests in a compartment.
        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.

      • scheduleProtectedDatabaseDeletion

        Future<ScheduleProtectedDatabaseDeletionResponse> scheduleProtectedDatabaseDeletion​(ScheduleProtectedDatabaseDeletionRequest request,
                                                                                    AsyncHandler<ScheduleProtectedDatabaseDeletionRequest,​ScheduleProtectedDatabaseDeletionResponse> handler)
        Defines a preferred schedule to delete a protected database after you terminate the source database.

        The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated. The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.

        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.

      • updateProtectionPolicy

        Future<UpdateProtectionPolicyResponse> updateProtectionPolicy​(UpdateProtectionPolicyRequest request,
                                                              AsyncHandler<UpdateProtectionPolicyRequest,​UpdateProtectionPolicyResponse> handler)
        Updates the specified protection policy.
        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.