com.oracle.bmc.applicationmigration

Interface ApplicationMigrationAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ApplicationMigrationAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20191031")
public interface ApplicationMigrationAsync
extends AutoCloseable

Application Migration simplifies the migration of applications from Oracle Cloud Infrastructure Classic to Oracle Cloud Infrastructure. You can use Application Migration API to migrate applications, such as Oracle Java Cloud Service, SOA Cloud Service, and Integration Classic instances, to Oracle Cloud Infrastructure. For more information, see Overview of Application Migration.

Method Summary

Modifier and Type	Method and Description
Future<CancelWorkRequestResponse>	cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler) Cancels the specified work request.
Future<ChangeMigrationCompartmentResponse>	changeMigrationCompartment(ChangeMigrationCompartmentRequest request, AsyncHandler<ChangeMigrationCompartmentRequest,ChangeMigrationCompartmentResponse> handler) Moves the specified migration into a different compartment within the same tenancy.
Future<ChangeSourceCompartmentResponse>	changeSourceCompartment(ChangeSourceCompartmentRequest request, AsyncHandler<ChangeSourceCompartmentRequest,ChangeSourceCompartmentResponse> handler) Moves the specified source into a different compartment within the same tenancy.
Future<CreateMigrationResponse>	createMigration(CreateMigrationRequest request, AsyncHandler<CreateMigrationRequest,CreateMigrationResponse> handler) Creates a migration.
Future<CreateSourceResponse>	createSource(CreateSourceRequest request, AsyncHandler<CreateSourceRequest,CreateSourceResponse> handler) Creates a source in the specified compartment.
Future<DeleteMigrationResponse>	deleteMigration(DeleteMigrationRequest request, AsyncHandler<DeleteMigrationRequest,DeleteMigrationResponse> handler) Deletes the specified migration.
Future<DeleteSourceResponse>	deleteSource(DeleteSourceRequest request, AsyncHandler<DeleteSourceRequest,DeleteSourceResponse> handler) Deletes the specified source.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetMigrationResponse>	getMigration(GetMigrationRequest request, AsyncHandler<GetMigrationRequest,GetMigrationResponse> handler) Retrieves details of the specified migration.
Future<GetSourceResponse>	getSource(GetSourceRequest request, AsyncHandler<GetSourceRequest,GetSourceResponse> handler) Retrieves details of the specified source.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the details of the specified work request.
Future<ListMigrationsResponse>	listMigrations(ListMigrationsRequest request, AsyncHandler<ListMigrationsRequest,ListMigrationsResponse> handler) Retrieves details of all the migrations that are available in the specified compartment.
Future<ListSourceApplicationsResponse>	listSourceApplications(ListSourceApplicationsRequest request, AsyncHandler<ListSourceApplicationsRequest,ListSourceApplicationsResponse> handler) Retrieves details of all the applications associated with the specified source.
Future<ListSourcesResponse>	listSources(ListSourcesRequest request, AsyncHandler<ListSourcesRequest,ListSourcesResponse> handler) Retrieves details of all the sources that are available in the specified compartment and match the specified query criteria.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Retrieves details of the errors encountered while executing an operation that is tracked by the specified work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Retrieves logs for the specified work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Retrieves details of all the work requests and match the specified query criteria.
Future<MigrateApplicationResponse>	migrateApplication(MigrateApplicationRequest request, AsyncHandler<MigrateApplicationRequest,MigrateApplicationResponse> handler) Starts migrating the specified application to Oracle Cloud Infrastructure.
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<UpdateMigrationResponse>	updateMigration(UpdateMigrationRequest request, AsyncHandler<UpdateMigrationRequest,UpdateMigrationResponse> handler) Updates the configuration details for the specified migration.
Future<UpdateSourceResponse>	updateSource(UpdateSourceRequest request, AsyncHandler<UpdateSourceRequest,UpdateSourceResponse> handler) You can update the authorization details to access the source environment from which you want to migrate applications to Oracle Cloud Infrastructure.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

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 the specified work request. When you cancel a work request, it causes the in-progress task to be canceled. For example, if the create migration work request is in the accepted or in progress state for a long time, you can cancel the work request.

When you cancel a work request, the state of the work request changes to cancelling, and then to the cancelled 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.

changeMigrationCompartment

Future<ChangeMigrationCompartmentResponse> changeMigrationCompartment(ChangeMigrationCompartmentRequest request,
                                                                      AsyncHandler<ChangeMigrationCompartmentRequest,ChangeMigrationCompartmentResponse> handler)

Moves the specified migration into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different 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.

changeSourceCompartment

Future<ChangeSourceCompartmentResponse> changeSourceCompartment(ChangeSourceCompartmentRequest request,
                                                                AsyncHandler<ChangeSourceCompartmentRequest,ChangeSourceCompartmentResponse> handler)

Moves the specified source into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different 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.

createMigration

Future<CreateMigrationResponse> createMigration(CreateMigrationRequest request,
                                                AsyncHandler<CreateMigrationRequest,CreateMigrationResponse> handler)

Creates a migration. A migration represents the end-to-end workflow of moving an application from a source environment to Oracle Cloud Infrastructure. Each migration moves a single application to Oracle Cloud Infrastructure. For more information, see Manage Migrations.

When you create a migration, provide the required information to let Application Migration access the source environment. Application Migration uses this information to access the application in the source environment and discover application artifacts.

All Oracle Cloud Infrastructure resources, including migrations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see Resource Identifiers.

After you send your request, a migration is created in the compartment that contains the source. The new migration's lifecycle state will temporarily be CREATING and the state of the migration will be DISCOVERING_APPLICATION. During this phase, Application Migration sets the template for the serviceConfig and applicationConfig fields of the migration. When this operation is complete, the state of the migration changes to MISSING_CONFIG_VALUES. Next, you'll need to update the migration to provide configuration values. Before updating the migration, ensure that its state has changed to MISSING_CONFIG_VALUES.

To track the progress of this operation, you can monitor the status of the Create Migration and Discover Application work requests by using the getWorkRequest REST API operation on the work request or by viewing the status of the work request in the console.

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.

createSource

Future<CreateSourceResponse> createSource(CreateSourceRequest request,
                                          AsyncHandler<CreateSourceRequest,CreateSourceResponse> handler)

Creates a source in the specified compartment. In Application Migration, a source refers to the environment from which the application is being migrated. For more information, see Manage Sources.

All Oracle Cloud Infrastructure resources, including sources, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

After you send your request, a source is created in the specified compartment. The new source's lifecycle state will temporarily be CREATING. Application Migration connects to the source environment with the authentication credentials that you have provided. If the connection is established, the status of the source changes to ACTIVE and Application Migration fetches the list of applications that are available for migration in the source environment.

To track the progress of the operation, you can monitor the status of the Create Source work request by using the getWorkRequest REST API operation on the work request or by viewing the status of the work request in the console.

Ensure that the state of the source has changed to ACTIVE, before you retrieve the list of applications from the source environment using the listSourceApplications REST API call.

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 specified migration.

If you have migrated the application or for any other reason if you no longer require a migration, then you can delete the relevant migration. You can delete a migration, irrespective of its state. If any work request is being processed for the migration that you want to delete, then the associated work requests are cancelled and then the migration is deleted.

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.

deleteSource

Future<DeleteSourceResponse> deleteSource(DeleteSourceRequest request,
                                          AsyncHandler<DeleteSourceRequest,DeleteSourceResponse> handler)

Deletes the specified source.

Before deleting a source, you must delete all the migrations associated with the source. If you have migrated all the required applications in a source or for any other reason you no longer require a source, then you can delete the relevant source.

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)

Retrieves details of the 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.

getSource

Future<GetSourceResponse> getSource(GetSourceRequest request,
                                    AsyncHandler<GetSourceRequest,GetSourceResponse> handler)

Retrieves details of the specified source. Specify the OCID of the source for which you want to retrieve 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.

getWorkRequest

Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Gets the details of the specified 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.

listMigrations

Future<ListMigrationsResponse> listMigrations(ListMigrationsRequest request,
                                              AsyncHandler<ListMigrationsRequest,ListMigrationsResponse> handler)

Retrieves details of all the migrations that are available in the specified 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.

listSourceApplications

Future<ListSourceApplicationsResponse> listSourceApplications(ListSourceApplicationsRequest request,
                                                              AsyncHandler<ListSourceApplicationsRequest,ListSourceApplicationsResponse> handler)

Retrieves details of all the applications associated with the specified source. This list is generated dynamically by interrogating the source and the list changes as applications are started or stopped in the source environment.

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.

listSources

Future<ListSourcesResponse> listSources(ListSourcesRequest request,
                                        AsyncHandler<ListSourcesRequest,ListSourcesResponse> handler)

Retrieves details of all the sources that are available in the specified compartment and match the specified query criteria. If you don’t specify any query criteria, then details of all the sources are displayed. To filter the retrieved results, you can pass one or more of the following query parameters, by appending them to the URI as shown in the following example.

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)

Retrieves details of the errors encountered while executing an operation that is tracked by the specified 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)

Retrieves logs for the specified 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)

Retrieves details of all the work requests and match the specified query criteria. To filter the retrieved results, you can pass one or more of the following query parameters, by appending them to the URI as shown in the following example.

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.

migrateApplication

Future<MigrateApplicationResponse> migrateApplication(MigrateApplicationRequest request,
                                                      AsyncHandler<MigrateApplicationRequest,MigrateApplicationResponse> handler)

Starts migrating the specified application to Oracle Cloud Infrastructure.

Before sending this request, ensure that you have provided configuration details to update the migration and the state of the migration is READY.

After you send this request, the migration's state will temporarily be MIGRATING .

To track the progress of the operation, you can monitor the status of the Migrate Application work request by using the getWorkRequest REST API operation on the work request or by viewing the status of the work request in the console. When this work request is processed successfully, Application Migration creates the required resources in the target environment and the state of the migration changes to MIGRATION_SUCCEEDED.

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 configuration details for the specified migration.

When you create a migration, Application Migration sets the template for the serviceConfig and applicationConfig attributes of the migration. When you update the migration, you must provide values for these fields to specify configuration information for the application in the target environment.

Before updating the migration, complete the following tasks:

1. Identify the migration that you want to update and ensure that the migration is in the MISSING_CONFIG_VALUES state.
2. Get details of the migration using the GetMigration command. This returns the template for the serviceConfig and applicationConfig attributes of the migration.
3. You must fill out the required details for the serviceConfig and applicationConfig attributes. The isRequired attribute of a configuration property indicates whether it is mandatory to provide a value.
4. You can provide values for the optional configuration properties or you can delete the optional properties for which you do not provide values. Note that you cannot add any property that is not present in the template.

To update the migration, pass the configuration values in the request body. The information that you must provide depends on the type of application that you are migrating. For reference information about configuration fields, see [Provide Configuration Information](https://docs.cloud.oracle.com/iaas/application-migration/manage_migrations.htm#provide_configuration_details).

To track the progress of the operation, you can monitor the status of the Update Migration work request by using the getWorkRequest REST API operation on the work request or by viewing the status of the work request in the console.

When the migration has been updated, the state of the migration changes to READY . After updating the migration, you can start the migration whenever you are ready.

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.

updateSource

Future<UpdateSourceResponse> updateSource(UpdateSourceRequest request,
                                          AsyncHandler<UpdateSourceRequest,UpdateSourceResponse> handler)

You can update the authorization details to access the source environment from which you want to migrate applications to Oracle Cloud Infrastructure. You can also update the description and tags of a source.

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

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.