Package com.oracle.bmc.disasterrecovery

Interface DisasterRecoveryAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DisasterRecoveryAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220125")
public interface DisasterRecoveryAsync
extends AutoCloseable
    Use the Full Stack Disaster Recovery (DR) API to manage disaster recovery for business applications.

    Full Stack DR is an OCI disaster recovery orchestration and management service that provides comprehensive disaster recovery capabilities for all layers of an application stack, including infrastructure, middleware, database, and application.

    • 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

      • associateDrProtectionGroup

        Future<AssociateDrProtectionGroupResponse> associateDrProtectionGroup​(AssociateDrProtectionGroupRequest request,
                                                                      AsyncHandler<AssociateDrProtectionGroupRequest,​AssociateDrProtectionGroupResponse> handler)
        Create an association between the DR protection group identified by drProtectionGroupId and another DR protection group.
        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.

      • cancelDrPlanExecution

        Future<CancelDrPlanExecutionResponse> cancelDrPlanExecution​(CancelDrPlanExecutionRequest request,
                                                            AsyncHandler<CancelDrPlanExecutionRequest,​CancelDrPlanExecutionResponse> handler)
        Cancel the DR plan execution identified by drPlanExecutionId.
        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.

      • cancelWorkRequest

        Future<CancelWorkRequestResponse> cancelWorkRequest​(CancelWorkRequestRequest request,
                                                    AsyncHandler<CancelWorkRequestRequest,​CancelWorkRequestResponse> handler)
        Cancel the work request identified by workRequestId.
        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.

      • createDrPlan

        Future<CreateDrPlanResponse> createDrPlan​(CreateDrPlanRequest request,
                                          AsyncHandler<CreateDrPlanRequest,​CreateDrPlanResponse> handler)
        Create a DR plan of the specified DR plan type.
        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.

      • createDrPlanExecution

        Future<CreateDrPlanExecutionResponse> createDrPlanExecution​(CreateDrPlanExecutionRequest request,
                                                            AsyncHandler<CreateDrPlanExecutionRequest,​CreateDrPlanExecutionResponse> handler)
        Execute a DR plan for a DR protection group.
        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.

      • deleteDrPlan

        Future<DeleteDrPlanResponse> deleteDrPlan​(DeleteDrPlanRequest request,
                                          AsyncHandler<DeleteDrPlanRequest,​DeleteDrPlanResponse> handler)
        Delete the DR plan identified by drPlanId.
        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.

      • deleteDrPlanExecution

        Future<DeleteDrPlanExecutionResponse> deleteDrPlanExecution​(DeleteDrPlanExecutionRequest request,
                                                            AsyncHandler<DeleteDrPlanExecutionRequest,​DeleteDrPlanExecutionResponse> handler)
        Delete the DR plan execution identified by drPlanExecutionId.
        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.

      • deleteDrProtectionGroup

        Future<DeleteDrProtectionGroupResponse> deleteDrProtectionGroup​(DeleteDrProtectionGroupRequest request,
                                                                AsyncHandler<DeleteDrProtectionGroupRequest,​DeleteDrProtectionGroupResponse> handler)
        Delete the DR protection group identified by drProtectionGroupId.
        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.

      • getDrPlan

        Future<GetDrPlanResponse> getDrPlan​(GetDrPlanRequest request,
                                    AsyncHandler<GetDrPlanRequest,​GetDrPlanResponse> handler)
        Get details for the DR plan identified by drPlanId.
        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.

      • getDrPlanExecution

        Future<GetDrPlanExecutionResponse> getDrPlanExecution​(GetDrPlanExecutionRequest request,
                                                      AsyncHandler<GetDrPlanExecutionRequest,​GetDrPlanExecutionResponse> handler)
        Get details for the DR plan execution identified by drPlanExecutionId.
        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.

      • getDrProtectionGroup

        Future<GetDrProtectionGroupResponse> getDrProtectionGroup​(GetDrProtectionGroupRequest request,
                                                          AsyncHandler<GetDrProtectionGroupRequest,​GetDrProtectionGroupResponse> handler)
        Get the DR protection group identified by drProtectionGroupId.
        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)
        Get the status of the work request identified by workRequestId.
        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.

      • ignoreDrPlanExecution

        Future<IgnoreDrPlanExecutionResponse> ignoreDrPlanExecution​(IgnoreDrPlanExecutionRequest request,
                                                            AsyncHandler<IgnoreDrPlanExecutionRequest,​IgnoreDrPlanExecutionResponse> handler)
        Ignore the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution.
        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.

      • listDrPlanExecutions

        Future<ListDrPlanExecutionsResponse> listDrPlanExecutions​(ListDrPlanExecutionsRequest request,
                                                          AsyncHandler<ListDrPlanExecutionsRequest,​ListDrPlanExecutionsResponse> handler)
        Get a summary list of all DR plan executions for a DR protection group.
        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.

      • listDrPlans

        Future<ListDrPlansResponse> listDrPlans​(ListDrPlansRequest request,
                                        AsyncHandler<ListDrPlansRequest,​ListDrPlansResponse> handler)
        Get a summary list of all DR plans for a DR protection group.
        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.

      • listDrProtectionGroups

        Future<ListDrProtectionGroupsResponse> listDrProtectionGroups​(ListDrProtectionGroupsRequest request,
                                                              AsyncHandler<ListDrProtectionGroupsRequest,​ListDrProtectionGroupsResponse> handler)
        Get a summary list of all DR protection groups 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.

      • listWorkRequestErrors

        Future<ListWorkRequestErrorsResponse> listWorkRequestErrors​(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,​ListWorkRequestErrorsResponse> handler)
        Get a list of work request errors for the work request identified by workRequestId.
        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)
        Get a list of logs for the work request identified by workRequestId.
        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.

      • pauseDrPlanExecution

        Future<PauseDrPlanExecutionResponse> pauseDrPlanExecution​(PauseDrPlanExecutionRequest request,
                                                          AsyncHandler<PauseDrPlanExecutionRequest,​PauseDrPlanExecutionResponse> handler)
        Pause the DR plan execution identified by drPlanExecutionId.
        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.

      • refreshDrPlan

        Future<RefreshDrPlanResponse> refreshDrPlan​(RefreshDrPlanRequest request,
                                            AsyncHandler<RefreshDrPlanRequest,​RefreshDrPlanResponse> handler)
        Refresh DR Plan identified by drPlanId.
        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.

      • resumeDrPlanExecution

        Future<ResumeDrPlanExecutionResponse> resumeDrPlanExecution​(ResumeDrPlanExecutionRequest request,
                                                            AsyncHandler<ResumeDrPlanExecutionRequest,​ResumeDrPlanExecutionResponse> handler)
        Resume the DR plan execution identified by drPlanExecutionId.
        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.

      • retryDrPlanExecution

        Future<RetryDrPlanExecutionResponse> retryDrPlanExecution​(RetryDrPlanExecutionRequest request,
                                                          AsyncHandler<RetryDrPlanExecutionRequest,​RetryDrPlanExecutionResponse> handler)
        Retry the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution.
        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.

      • updateDrPlan

        Future<UpdateDrPlanResponse> updateDrPlan​(UpdateDrPlanRequest request,
                                          AsyncHandler<UpdateDrPlanRequest,​UpdateDrPlanResponse> handler)
        Update the DR plan identified by drPlanId.
        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.

      • updateDrPlanExecution

        Future<UpdateDrPlanExecutionResponse> updateDrPlanExecution​(UpdateDrPlanExecutionRequest request,
                                                            AsyncHandler<UpdateDrPlanExecutionRequest,​UpdateDrPlanExecutionResponse> handler)
        Update the DR plan execution identified by drPlanExecutionId.
        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.

      • updateDrProtectionGroup

        Future<UpdateDrProtectionGroupResponse> updateDrProtectionGroup​(UpdateDrProtectionGroupRequest request,
                                                                AsyncHandler<UpdateDrProtectionGroupRequest,​UpdateDrProtectionGroupResponse> handler)
        Update the DR protection group identified by drProtectionGroupId.
        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.

      • verifyDrPlan

        Future<VerifyDrPlanResponse> verifyDrPlan​(VerifyDrPlanRequest request,
                                          AsyncHandler<VerifyDrPlanRequest,​VerifyDrPlanResponse> handler)
        Verify DR Plan identified by drPlanId.
        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.