Package com.oracle.bmc.databasemigration

Interface DatabaseMigrationAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DatabaseMigrationAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230518")
public interface DatabaseMigrationAsync
extends AutoCloseable
    Use the Oracle Cloud Infrastructure Database Migration APIs to perform database migration operations.

    • 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

      • abortJob

        Future<AbortJobResponse> abortJob​(AbortJobRequest request,
                                  AsyncHandler<AbortJobRequest,​AbortJobResponse> handler)
        Aborts a Migration Job (either Evaluation or Migration).
        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.

      • addMigrationObjects

        Future<AddMigrationObjectsResponse> addMigrationObjects​(AddMigrationObjectsRequest request,
                                                        AsyncHandler<AddMigrationObjectsRequest,​AddMigrationObjectsResponse> handler)
        Add excluded/included object to the list.
        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.

      • cloneMigration

        Future<CloneMigrationResponse> cloneMigration​(CloneMigrationRequest request,
                                              AsyncHandler<CloneMigrationRequest,​CloneMigrationResponse> handler)
        Clone a configuration from an existing Migration.
        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.

      • connectionDiagnostics

        Future<ConnectionDiagnosticsResponse> connectionDiagnostics​(ConnectionDiagnosticsRequest request,
                                                            AsyncHandler<ConnectionDiagnosticsRequest,​ConnectionDiagnosticsResponse> handler)
        Perform connection test for a database connection.
        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.

      • createConnection

        Future<CreateConnectionResponse> createConnection​(CreateConnectionRequest request,
                                                  AsyncHandler<CreateConnectionRequest,​CreateConnectionResponse> handler)
        Create a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration.
        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.

      • createMigration

        Future<CreateMigrationResponse> createMigration​(CreateMigrationRequest request,
                                                AsyncHandler<CreateMigrationRequest,​CreateMigrationResponse> handler)
        Create a Migration resource that contains all the details to perform the database migration operation, such as source and destination database details, credentials, etc.
        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.

      • deleteConnection

        Future<DeleteConnectionResponse> deleteConnection​(DeleteConnectionRequest request,
                                                  AsyncHandler<DeleteConnectionRequest,​DeleteConnectionResponse> handler)
        Deletes the Database Connection represented by the specified connection 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.

      • deleteJob

        Future<DeleteJobResponse> deleteJob​(DeleteJobRequest request,
                                    AsyncHandler<DeleteJobRequest,​DeleteJobResponse> handler)
        Deletes the migration job represented by the given job 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.

      • deleteMigration

        Future<DeleteMigrationResponse> deleteMigration​(DeleteMigrationRequest request,
                                                AsyncHandler<DeleteMigrationRequest,​DeleteMigrationResponse> handler)
        Deletes the Migration represented by the specified migration 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.

      • evaluateMigration

        Future<EvaluateMigrationResponse> evaluateMigration​(EvaluateMigrationRequest request,
                                                    AsyncHandler<EvaluateMigrationRequest,​EvaluateMigrationResponse> handler)
        Start Validate Migration job.
        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.

      • getAdvisorReport

        Future<GetAdvisorReportResponse> getAdvisorReport​(GetAdvisorReportRequest request,
                                                  AsyncHandler<GetAdvisorReportRequest,​GetAdvisorReportResponse> handler)
        Get the Pre-Migration Advisor report details
        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.

      • getConnection

        Future<GetConnectionResponse> getConnection​(GetConnectionRequest request,
                                            AsyncHandler<GetConnectionRequest,​GetConnectionResponse> handler)
        Display Database Connection details.
        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.

      • getJob

        Future<GetJobResponse> getJob​(GetJobRequest request,
                              AsyncHandler<GetJobRequest,​GetJobResponse> handler)
        Get a migration job.
        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.

      • getJobOutputContent

        Future<GetJobOutputContentResponse> getJobOutputContent​(GetJobOutputContentRequest request,
                                                        AsyncHandler<GetJobOutputContentRequest,​GetJobOutputContentResponse> handler)
        Get the migration Job Output content as a String.
        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.

      • getMigration

        Future<GetMigrationResponse> getMigration​(GetMigrationRequest request,
                                          AsyncHandler<GetMigrationRequest,​GetMigrationResponse> handler)
        Display Migration details.
        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.

      • getParameterFileVersion

        Future<GetParameterFileVersionResponse> getParameterFileVersion​(GetParameterFileVersionRequest request,
                                                                AsyncHandler<GetParameterFileVersionRequest,​GetParameterFileVersionResponse> handler)
        Obtain the parameter file version contents for the specified parameter file name and the associated job.

        This operation will be allowed only if the job is certain acceptable lifecycle states.

        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 details of a 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.

      • listConnections

        Future<ListConnectionsResponse> listConnections​(ListConnectionsRequest request,
                                                AsyncHandler<ListConnectionsRequest,​ListConnectionsResponse> handler)
        List all Database Connections.
        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.

      • listExcludedObjects

        Future<ListExcludedObjectsResponse> listExcludedObjects​(ListExcludedObjectsRequest request,
                                                        AsyncHandler<ListExcludedObjectsRequest,​ListExcludedObjectsResponse> handler)
        List the excluded database objects.
        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.

      • listJobOutputs

        Future<ListJobOutputsResponse> listJobOutputs​(ListJobOutputsRequest request,
                                              AsyncHandler<ListJobOutputsRequest,​ListJobOutputsResponse> handler)
        List the Job Outputs
        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.

      • listJobs

        Future<ListJobsResponse> listJobs​(ListJobsRequest request,
                                  AsyncHandler<ListJobsRequest,​ListJobsResponse> handler)
        List all the names of the Migration jobs associated to the specified migration site.
        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.

      • listMigrationObjectTypes

        Future<ListMigrationObjectTypesResponse> listMigrationObjectTypes​(ListMigrationObjectTypesRequest request,
                                                                  AsyncHandler<ListMigrationObjectTypesRequest,​ListMigrationObjectTypesResponse> handler)
        Display sample object types to exclude or include for a Migration.
        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.

      • listMigrationObjects

        Future<ListMigrationObjectsResponse> listMigrationObjects​(ListMigrationObjectsRequest request,
                                                          AsyncHandler<ListMigrationObjectsRequest,​ListMigrationObjectsResponse> handler)
        Display excluded/included objects.
        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.

      • listMigrationParameters

        Future<ListMigrationParametersResponse> listMigrationParameters​(ListMigrationParametersRequest request,
                                                                AsyncHandler<ListMigrationParametersRequest,​ListMigrationParametersResponse> handler)
        List of parameters that can be used to customize migrations.
        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.

      • listMigrations

        Future<ListMigrationsResponse> listMigrations​(ListMigrationsRequest request,
                                              AsyncHandler<ListMigrationsRequest,​ListMigrationsResponse> handler)
        List all Migrations.
        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.

      • listParameterFileVersions

        Future<ListParameterFileVersionsResponse> listParameterFileVersions​(ListParameterFileVersionsRequest request,
                                                                    AsyncHandler<ListParameterFileVersionsRequest,​ListParameterFileVersionsResponse> handler)
        Return a list of the parameter file metadata of the migration execution of the specified job.

        This will only be acceptable if the job is in particular state. It will be accessible if the job is in the FAILED, PAUSED or SUSPENDED 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.

      • listWorkRequestErrors

        Future<ListWorkRequestErrorsResponse> listWorkRequestErrors​(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,​ListWorkRequestErrorsResponse> handler)
        Gets the errors for a 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)
        Gets the logs for a 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 or for a specified resource.
        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.

      • removeMigrationObjects

        Future<RemoveMigrationObjectsResponse> removeMigrationObjects​(RemoveMigrationObjectsRequest request,
                                                              AsyncHandler<RemoveMigrationObjectsRequest,​RemoveMigrationObjectsResponse> handler)
        Remove excluded/included objects.
        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.

      • resumeJob

        Future<ResumeJobResponse> resumeJob​(ResumeJobRequest request,
                                    AsyncHandler<ResumeJobRequest,​ResumeJobResponse> handler)
        Resume a migration Job.
        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.

      • retrieveSupportedPhases

        Future<RetrieveSupportedPhasesResponse> retrieveSupportedPhases​(RetrieveSupportedPhasesRequest request,
                                                                AsyncHandler<RetrieveSupportedPhasesRequest,​RetrieveSupportedPhasesResponse> handler)
        Display Migration Phases for a specified migration.
        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.

      • startMigration

        Future<StartMigrationResponse> startMigration​(StartMigrationRequest request,
                                              AsyncHandler<StartMigrationRequest,​StartMigrationResponse> handler)
        Start Migration job.
        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.

      • suspendJob

        Future<SuspendJobResponse> suspendJob​(SuspendJobRequest request,
                                      AsyncHandler<SuspendJobRequest,​SuspendJobResponse> handler)
        Place the currently executing migration Job in a Suspended 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.

      • updateConnection

        Future<UpdateConnectionResponse> updateConnection​(UpdateConnectionRequest request,
                                                  AsyncHandler<UpdateConnectionRequest,​UpdateConnectionResponse> handler)
        Update Database Connection resource details.
        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.

      • updateJob

        Future<UpdateJobResponse> updateJob​(UpdateJobRequest request,
                                    AsyncHandler<UpdateJobRequest,​UpdateJobResponse> handler)
        Update Migration Job resource details.
        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.

      • updateMigration

        Future<UpdateMigrationResponse> updateMigration​(UpdateMigrationRequest request,
                                                AsyncHandler<UpdateMigrationRequest,​UpdateMigrationResponse> handler)
        Update Migration resource details.
        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.