Package com.oracle.bmc.cloudmigrations

Interface MigrationAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    MigrationAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220919")
public interface MigrationAsync
extends AutoCloseable
    A description of the Oracle Cloud Migrations API.

    • 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

      • cancelWorkRequest

        Future<CancelWorkRequestResponse> cancelWorkRequest​(CancelWorkRequestRequest request,
                                                    AsyncHandler<CancelWorkRequestRequest,​CancelWorkRequestResponse> handler)
        Cancels work request with the given 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.

      • changeMigrationCompartment

        Future<ChangeMigrationCompartmentResponse> changeMigrationCompartment​(ChangeMigrationCompartmentRequest request,
                                                                      AsyncHandler<ChangeMigrationCompartmentRequest,​ChangeMigrationCompartmentResponse> handler)
        Moves a migration resource from one compartment identifier to another.

        When provided, If-Match is checked against ETag values of the 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.

      • createMigration

        Future<CreateMigrationResponse> createMigration​(CreateMigrationRequest request,
                                                AsyncHandler<CreateMigrationRequest,​CreateMigrationResponse> handler)
        Creates 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.

      • createMigrationAsset

        Future<CreateMigrationAssetResponse> createMigrationAsset​(CreateMigrationAssetRequest request,
                                                          AsyncHandler<CreateMigrationAssetRequest,​CreateMigrationAssetResponse> handler)
        Creates a migration asset.
        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.

      • createMigrationPlan

        Future<CreateMigrationPlanResponse> createMigrationPlan​(CreateMigrationPlanRequest request,
                                                        AsyncHandler<CreateMigrationPlanRequest,​CreateMigrationPlanResponse> handler)
        Creates a migration plan.
        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.

      • createTargetAsset

        Future<CreateTargetAssetResponse> createTargetAsset​(CreateTargetAssetRequest request,
                                                    AsyncHandler<CreateTargetAssetRequest,​CreateTargetAssetResponse> handler)
        Creates a target asset.
        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 a migration resource by identifier.
        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.

      • deleteMigrationAsset

        Future<DeleteMigrationAssetResponse> deleteMigrationAsset​(DeleteMigrationAssetRequest request,
                                                          AsyncHandler<DeleteMigrationAssetRequest,​DeleteMigrationAssetResponse> handler)
        Deletes a migration asset resource by an identifier.
        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.

      • deleteMigrationPlan

        Future<DeleteMigrationPlanResponse> deleteMigrationPlan​(DeleteMigrationPlanRequest request,
                                                        AsyncHandler<DeleteMigrationPlanRequest,​DeleteMigrationPlanResponse> handler)
        Deletes a migration plan resource by an identifier.
        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.

      • deleteTargetAsset

        Future<DeleteTargetAssetResponse> deleteTargetAsset​(DeleteTargetAssetRequest request,
                                                    AsyncHandler<DeleteTargetAssetRequest,​DeleteTargetAssetResponse> handler)
        Deletes a target asset resource by identifier.
        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.

      • executeMigrationPlan

        Future<ExecuteMigrationPlanResponse> executeMigrationPlan​(ExecuteMigrationPlanRequest request,
                                                          AsyncHandler<ExecuteMigrationPlanRequest,​ExecuteMigrationPlanResponse> handler)
        Executes the migration plan with the migration plan 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.

      • exportMigrationPlan

        Future<ExportMigrationPlanResponse> exportMigrationPlan​(ExportMigrationPlanRequest request,
                                                        AsyncHandler<ExportMigrationPlanRequest,​ExportMigrationPlanResponse> handler)
        Exports the migration plan to a csv file.
        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)
        Gets a migration by identifier.
        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.

      • getMigrationAsset

        Future<GetMigrationAssetResponse> getMigrationAsset​(GetMigrationAssetRequest request,
                                                    AsyncHandler<GetMigrationAssetRequest,​GetMigrationAssetResponse> handler)
        Gets a migration asset by identifier.
        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.

      • getMigrationPlan

        Future<GetMigrationPlanResponse> getMigrationPlan​(GetMigrationPlanRequest request,
                                                  AsyncHandler<GetMigrationPlanRequest,​GetMigrationPlanResponse> handler)
        Gets a migration plan by identifier.
        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.

      • getReplicationProgress

        Future<GetReplicationProgressResponse> getReplicationProgress​(GetReplicationProgressRequest request,
                                                              AsyncHandler<GetReplicationProgressRequest,​GetReplicationProgressResponse> handler)
        Gets the progress percentage of a migration asset’s replication process.
        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.

      • getReplicationSchedule

        Future<GetReplicationScheduleResponse> getReplicationSchedule​(GetReplicationScheduleRequest request,
                                                              AsyncHandler<GetReplicationScheduleRequest,​GetReplicationScheduleResponse> handler)
        Gets a replication schedule by identifier.
        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.

      • getTargetAsset

        Future<GetTargetAssetResponse> getTargetAsset​(GetTargetAssetRequest request,
                                              AsyncHandler<GetTargetAssetRequest,​GetTargetAssetResponse> handler)
        Gets a target asset by identifier.
        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 with the given 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.

      • importMigrationPlan

        Future<ImportMigrationPlanResponse> importMigrationPlan​(ImportMigrationPlanRequest request,
                                                        AsyncHandler<ImportMigrationPlanRequest,​ImportMigrationPlanResponse> handler)
        Imports a migration plan from a csv file.
        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.

      • listAvailableShapes

        Future<ListAvailableShapesResponse> listAvailableShapes​(ListAvailableShapesRequest request,
                                                        AsyncHandler<ListAvailableShapesRequest,​ListAvailableShapesResponse> handler)
        List of shapes by 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.

      • listMigrationAssets

        Future<ListMigrationAssetsResponse> listMigrationAssets​(ListMigrationAssetsRequest request,
                                                        AsyncHandler<ListMigrationAssetsRequest,​ListMigrationAssetsResponse> handler)
        Returns a list of migration assets.
        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.

      • listMigrationPlans

        Future<ListMigrationPlansResponse> listMigrationPlans​(ListMigrationPlansRequest request,
                                                      AsyncHandler<ListMigrationPlansRequest,​ListMigrationPlansResponse> handler)
        Returns a list of migration plans.
        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)
        Returns a list of 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.

      • listTargetAssets

        Future<ListTargetAssetsResponse> listTargetAssets​(ListTargetAssetsRequest request,
                                                  AsyncHandler<ListTargetAssetsRequest,​ListTargetAssetsResponse> handler)
        Returns a list of target assets.
        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)
        Returns 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)
        Returns 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)
        List of 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.

      • refreshMigration

        Future<RefreshMigrationResponse> refreshMigration​(RefreshMigrationRequest request,
                                                  AsyncHandler<RefreshMigrationRequest,​RefreshMigrationResponse> handler)
        Refreshes migration based on the 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.

      • refreshMigrationAsset

        Future<RefreshMigrationAssetResponse> refreshMigrationAsset​(RefreshMigrationAssetRequest request,
                                                            AsyncHandler<RefreshMigrationAssetRequest,​RefreshMigrationAssetResponse> handler)
        Refreshes the migration asset with the migration asset 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.

      • refreshMigrationPlan

        Future<RefreshMigrationPlanResponse> refreshMigrationPlan​(RefreshMigrationPlanRequest request,
                                                          AsyncHandler<RefreshMigrationPlanRequest,​RefreshMigrationPlanResponse> handler)
        Refreshes the migration plan with the migration plan 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.

      • startAssetReplication

        Future<StartAssetReplicationResponse> startAssetReplication​(StartAssetReplicationRequest request,
                                                            AsyncHandler<StartAssetReplicationRequest,​StartAssetReplicationResponse> handler)
        Starts replication for the asset with the migration asset 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.

      • updateMigration

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

      • updateMigrationAsset

        Future<UpdateMigrationAssetResponse> updateMigrationAsset​(UpdateMigrationAssetRequest request,
                                                          AsyncHandler<UpdateMigrationAssetRequest,​UpdateMigrationAssetResponse> handler)
        Updates the migration asset.
        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.

      • updateMigrationPlan

        Future<UpdateMigrationPlanResponse> updateMigrationPlan​(UpdateMigrationPlanRequest request,
                                                        AsyncHandler<UpdateMigrationPlanRequest,​UpdateMigrationPlanResponse> handler)
        Updates the migration plan.
        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.

      • updateTargetAsset

        Future<UpdateTargetAssetResponse> updateTargetAsset​(UpdateTargetAssetRequest request,
                                                    AsyncHandler<UpdateTargetAssetRequest,​UpdateTargetAssetResponse> handler)
        Updates the target asset.
        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.