Class MigrationAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.cloudmigrations.MigrationAsyncClient
-
- All Implemented Interfaces:
MigrationAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20220919") public class MigrationAsyncClient extends BaseAsyncClient implements MigrationAsync
Async client implementation for Migration service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream
, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MigrationAsyncClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for Migration.
-
Constructor Summary
Constructors Constructor Description MigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.MigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.MigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.MigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.MigrationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.MigrationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.MigrationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.cloudmigrations.MigrationAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
MigrationAsyncClient
@Deprecated public MigrationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
MigrationAsyncClient
@Deprecated public MigrationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
MigrationAsyncClient
@Deprecated public MigrationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
MigrationAsyncClient
@Deprecated public MigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
MigrationAsyncClient
@Deprecated public MigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
MigrationAsyncClient
@Deprecated public MigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
MigrationAsyncClient
@Deprecated public MigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
Method Detail
-
builder
public static MigrationAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:MigrationAsync
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.- Specified by:
setRegion
in interfaceMigrationAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:MigrationAsync
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 callsetEndpoint
.- Specified by:
setRegion
in interfaceMigrationAsync
- Parameters:
regionId
- The public region ID.
-
cancelWorkRequest
public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
Description copied from interface:MigrationAsync
Cancels work request with the given ID.- Specified by:
cancelWorkRequest
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ChangeMigrationCompartmentResponse> changeMigrationCompartment(ChangeMigrationCompartmentRequest request, AsyncHandler<ChangeMigrationCompartmentRequest,ChangeMigrationCompartmentResponse> handler)
Description copied from interface:MigrationAsync
Moves a migration resource from one compartment identifier to another.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeMigrationCompartment
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
changeMigrationPlanCompartment
public Future<ChangeMigrationPlanCompartmentResponse> changeMigrationPlanCompartment(ChangeMigrationPlanCompartmentRequest request, AsyncHandler<ChangeMigrationPlanCompartmentRequest,ChangeMigrationPlanCompartmentResponse> handler)
Description copied from interface:MigrationAsync
Moves a resource into a different compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeMigrationPlanCompartment
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
changeReplicationScheduleCompartment
public Future<ChangeReplicationScheduleCompartmentResponse> changeReplicationScheduleCompartment(ChangeReplicationScheduleCompartmentRequest request, AsyncHandler<ChangeReplicationScheduleCompartmentRequest,ChangeReplicationScheduleCompartmentResponse> handler)
Description copied from interface:MigrationAsync
Moves a resource into a different compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeReplicationScheduleCompartment
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<CreateMigrationResponse> createMigration(CreateMigrationRequest request, AsyncHandler<CreateMigrationRequest,CreateMigrationResponse> handler)
Description copied from interface:MigrationAsync
Creates a migration.- Specified by:
createMigration
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<CreateMigrationAssetResponse> createMigrationAsset(CreateMigrationAssetRequest request, AsyncHandler<CreateMigrationAssetRequest,CreateMigrationAssetResponse> handler)
Description copied from interface:MigrationAsync
Creates a migration asset.- Specified by:
createMigrationAsset
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<CreateMigrationPlanResponse> createMigrationPlan(CreateMigrationPlanRequest request, AsyncHandler<CreateMigrationPlanRequest,CreateMigrationPlanResponse> handler)
Description copied from interface:MigrationAsync
Creates a migration plan.- Specified by:
createMigrationPlan
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
createReplicationSchedule
public Future<CreateReplicationScheduleResponse> createReplicationSchedule(CreateReplicationScheduleRequest request, AsyncHandler<CreateReplicationScheduleRequest,CreateReplicationScheduleResponse> handler)
Description copied from interface:MigrationAsync
Creates a replication schedule.- Specified by:
createReplicationSchedule
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<CreateTargetAssetResponse> createTargetAsset(CreateTargetAssetRequest request, AsyncHandler<CreateTargetAssetRequest,CreateTargetAssetResponse> handler)
Description copied from interface:MigrationAsync
Creates a target asset.- Specified by:
createTargetAsset
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<DeleteMigrationResponse> deleteMigration(DeleteMigrationRequest request, AsyncHandler<DeleteMigrationRequest,DeleteMigrationResponse> handler)
Description copied from interface:MigrationAsync
Deletes a migration resource by identifier.- Specified by:
deleteMigration
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<DeleteMigrationAssetResponse> deleteMigrationAsset(DeleteMigrationAssetRequest request, AsyncHandler<DeleteMigrationAssetRequest,DeleteMigrationAssetResponse> handler)
Description copied from interface:MigrationAsync
Deletes a migration asset resource by an identifier.- Specified by:
deleteMigrationAsset
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<DeleteMigrationPlanResponse> deleteMigrationPlan(DeleteMigrationPlanRequest request, AsyncHandler<DeleteMigrationPlanRequest,DeleteMigrationPlanResponse> handler)
Description copied from interface:MigrationAsync
Deletes a migration plan resource by an identifier.- Specified by:
deleteMigrationPlan
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
deleteReplicationSchedule
public Future<DeleteReplicationScheduleResponse> deleteReplicationSchedule(DeleteReplicationScheduleRequest request, AsyncHandler<DeleteReplicationScheduleRequest,DeleteReplicationScheduleResponse> handler)
Description copied from interface:MigrationAsync
Deletes a replication schedule resource by identifier.- Specified by:
deleteReplicationSchedule
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<DeleteTargetAssetResponse> deleteTargetAsset(DeleteTargetAssetRequest request, AsyncHandler<DeleteTargetAssetRequest,DeleteTargetAssetResponse> handler)
Description copied from interface:MigrationAsync
Deletes a target asset resource by identifier.- Specified by:
deleteTargetAsset
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ExecuteMigrationPlanResponse> executeMigrationPlan(ExecuteMigrationPlanRequest request, AsyncHandler<ExecuteMigrationPlanRequest,ExecuteMigrationPlanResponse> handler)
Description copied from interface:MigrationAsync
Executes the migration plan with the migration plan ID.- Specified by:
executeMigrationPlan
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ExportMigrationPlanResponse> exportMigrationPlan(ExportMigrationPlanRequest request, AsyncHandler<ExportMigrationPlanRequest,ExportMigrationPlanResponse> handler)
Description copied from interface:MigrationAsync
Exports the migration plan to a csv file.- Specified by:
exportMigrationPlan
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetMigrationResponse> getMigration(GetMigrationRequest request, AsyncHandler<GetMigrationRequest,GetMigrationResponse> handler)
Description copied from interface:MigrationAsync
Gets a migration by identifier.- Specified by:
getMigration
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetMigrationAssetResponse> getMigrationAsset(GetMigrationAssetRequest request, AsyncHandler<GetMigrationAssetRequest,GetMigrationAssetResponse> handler)
Description copied from interface:MigrationAsync
Gets a migration asset by identifier.- Specified by:
getMigrationAsset
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetMigrationPlanResponse> getMigrationPlan(GetMigrationPlanRequest request, AsyncHandler<GetMigrationPlanRequest,GetMigrationPlanResponse> handler)
Description copied from interface:MigrationAsync
Gets a migration plan by identifier.- Specified by:
getMigrationPlan
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetReplicationProgressResponse> getReplicationProgress(GetReplicationProgressRequest request, AsyncHandler<GetReplicationProgressRequest,GetReplicationProgressResponse> handler)
Description copied from interface:MigrationAsync
Gets the progress percentage of a migration asset’s replication process.- Specified by:
getReplicationProgress
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetReplicationScheduleResponse> getReplicationSchedule(GetReplicationScheduleRequest request, AsyncHandler<GetReplicationScheduleRequest,GetReplicationScheduleResponse> handler)
Description copied from interface:MigrationAsync
Gets a replication schedule by identifier.- Specified by:
getReplicationSchedule
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetTargetAssetResponse> getTargetAsset(GetTargetAssetRequest request, AsyncHandler<GetTargetAssetRequest,GetTargetAssetResponse> handler)
Description copied from interface:MigrationAsync
Gets a target asset by identifier.- Specified by:
getTargetAsset
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Description copied from interface:MigrationAsync
Gets the status of the work request with the given ID.- Specified by:
getWorkRequest
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ImportMigrationPlanResponse> importMigrationPlan(ImportMigrationPlanRequest request, AsyncHandler<ImportMigrationPlanRequest,ImportMigrationPlanResponse> handler)
Description copied from interface:MigrationAsync
Imports a migration plan from a csv file.- Specified by:
importMigrationPlan
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListAvailableShapesResponse> listAvailableShapes(ListAvailableShapesRequest request, AsyncHandler<ListAvailableShapesRequest,ListAvailableShapesResponse> handler)
Description copied from interface:MigrationAsync
List of shapes by parameters.- Specified by:
listAvailableShapes
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListMigrationAssetsResponse> listMigrationAssets(ListMigrationAssetsRequest request, AsyncHandler<ListMigrationAssetsRequest,ListMigrationAssetsResponse> handler)
Description copied from interface:MigrationAsync
Returns a list of migration assets.- Specified by:
listMigrationAssets
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListMigrationPlansResponse> listMigrationPlans(ListMigrationPlansRequest request, AsyncHandler<ListMigrationPlansRequest,ListMigrationPlansResponse> handler)
Description copied from interface:MigrationAsync
Returns a list of migration plans.- Specified by:
listMigrationPlans
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListMigrationsResponse> listMigrations(ListMigrationsRequest request, AsyncHandler<ListMigrationsRequest,ListMigrationsResponse> handler)
Description copied from interface:MigrationAsync
Returns a list of migrations.- Specified by:
listMigrations
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listReplicationSchedules
public Future<ListReplicationSchedulesResponse> listReplicationSchedules(ListReplicationSchedulesRequest request, AsyncHandler<ListReplicationSchedulesRequest,ListReplicationSchedulesResponse> handler)
Description copied from interface:MigrationAsync
Returns a list of replication schedules.- Specified by:
listReplicationSchedules
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListTargetAssetsResponse> listTargetAssets(ListTargetAssetsRequest request, AsyncHandler<ListTargetAssetsRequest,ListTargetAssetsResponse> handler)
Description copied from interface:MigrationAsync
Returns a list of target assets.- Specified by:
listTargetAssets
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Description copied from interface:MigrationAsync
Returns a paginated list of errors for a given work request.- Specified by:
listWorkRequestErrors
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Description copied from interface:MigrationAsync
Returns a paginated list of logs for a given work request.- Specified by:
listWorkRequestLogs
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Description copied from interface:MigrationAsync
List of work requests in a compartment.- Specified by:
listWorkRequests
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<RefreshMigrationResponse> refreshMigration(RefreshMigrationRequest request, AsyncHandler<RefreshMigrationRequest,RefreshMigrationResponse> handler)
Description copied from interface:MigrationAsync
Refreshes migration based on the migration ID.- Specified by:
refreshMigration
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<RefreshMigrationAssetResponse> refreshMigrationAsset(RefreshMigrationAssetRequest request, AsyncHandler<RefreshMigrationAssetRequest,RefreshMigrationAssetResponse> handler)
Description copied from interface:MigrationAsync
Refreshes the migration asset with the migration asset ID.- Specified by:
refreshMigrationAsset
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<RefreshMigrationPlanResponse> refreshMigrationPlan(RefreshMigrationPlanRequest request, AsyncHandler<RefreshMigrationPlanRequest,RefreshMigrationPlanResponse> handler)
Description copied from interface:MigrationAsync
Refreshes the migration plan with the migration plan ID.- Specified by:
refreshMigrationPlan
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<StartAssetReplicationResponse> startAssetReplication(StartAssetReplicationRequest request, AsyncHandler<StartAssetReplicationRequest,StartAssetReplicationResponse> handler)
Description copied from interface:MigrationAsync
Starts replication for the asset with the migration asset ID.- Specified by:
startAssetReplication
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
startMigrationReplication
public Future<StartMigrationReplicationResponse> startMigrationReplication(StartMigrationReplicationRequest request, AsyncHandler<StartMigrationReplicationRequest,StartMigrationReplicationResponse> handler)
Description copied from interface:MigrationAsync
Starts replication for a migration or for some asset.- Specified by:
startMigrationReplication
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<UpdateMigrationResponse> updateMigration(UpdateMigrationRequest request, AsyncHandler<UpdateMigrationRequest,UpdateMigrationResponse> handler)
Description copied from interface:MigrationAsync
Updates the migration.- Specified by:
updateMigration
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<UpdateMigrationAssetResponse> updateMigrationAsset(UpdateMigrationAssetRequest request, AsyncHandler<UpdateMigrationAssetRequest,UpdateMigrationAssetResponse> handler)
Description copied from interface:MigrationAsync
Updates the migration asset.- Specified by:
updateMigrationAsset
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<UpdateMigrationPlanResponse> updateMigrationPlan(UpdateMigrationPlanRequest request, AsyncHandler<UpdateMigrationPlanRequest,UpdateMigrationPlanResponse> handler)
Description copied from interface:MigrationAsync
Updates the migration plan.- Specified by:
updateMigrationPlan
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
updateReplicationSchedule
public Future<UpdateReplicationScheduleResponse> updateReplicationSchedule(UpdateReplicationScheduleRequest request, AsyncHandler<UpdateReplicationScheduleRequest,UpdateReplicationScheduleResponse> handler)
Description copied from interface:MigrationAsync
Updates the replication schedule.- Specified by:
updateReplicationSchedule
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<UpdateTargetAssetResponse> updateTargetAsset(UpdateTargetAssetRequest request, AsyncHandler<UpdateTargetAssetRequest,UpdateTargetAssetResponse> handler)
Description copied from interface:MigrationAsync
Updates the target asset.- Specified by:
updateTargetAsset
in interfaceMigrationAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
-
-