Class DatabaseMigrationAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.databasemigration.DatabaseMigrationAsyncClient
-
- All Implemented Interfaces:
DatabaseMigrationAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20230518") public class DatabaseMigrationAsyncClient extends BaseAsyncClient implements DatabaseMigrationAsyncAsync client implementation for DatabaseMigration 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 classDatabaseMigrationAsyncClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for DatabaseMigration.
-
Constructor Summary
Constructors Constructor Description DatabaseMigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DatabaseMigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DatabaseMigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DatabaseMigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DatabaseMigrationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DatabaseMigrationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DatabaseMigrationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
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.databasemigration.DatabaseMigrationAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DatabaseMigrationAsyncClient
@Deprecated public DatabaseMigrationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
DatabaseMigrationAsyncClient
@Deprecated public DatabaseMigrationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
DatabaseMigrationAsyncClient
@Deprecated public DatabaseMigrationAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DatabaseMigrationAsyncClient
@Deprecated public DatabaseMigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
DatabaseMigrationAsyncClient
@Deprecated public DatabaseMigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
DatabaseMigrationAsyncClient
@Deprecated public DatabaseMigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
DatabaseMigrationAsyncClient
@Deprecated public DatabaseMigrationAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseMigrationAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
Method Detail
-
builder
public static DatabaseMigrationAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DatabaseMigrationAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceDatabaseMigrationAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DatabaseMigrationAsyncSets 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:
setRegionin interfaceDatabaseMigrationAsync- Parameters:
regionId- The public region ID.
-
abortJob
public Future<AbortJobResponse> abortJob(AbortJobRequest request, AsyncHandler<AbortJobRequest,AbortJobResponse> handler)
Description copied from interface:DatabaseMigrationAsyncAborts a Migration Job (either Evaluation or Migration).- Specified by:
abortJobin interfaceDatabaseMigrationAsync- 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.
-
addMigrationObjects
public Future<AddMigrationObjectsResponse> addMigrationObjects(AddMigrationObjectsRequest request, AsyncHandler<AddMigrationObjectsRequest,AddMigrationObjectsResponse> handler)
Description copied from interface:DatabaseMigrationAsyncAdd excluded/included object to the list.- Specified by:
addMigrationObjectsin interfaceDatabaseMigrationAsync- 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.
-
changeConnectionCompartment
public Future<ChangeConnectionCompartmentResponse> changeConnectionCompartment(ChangeConnectionCompartmentRequest request, AsyncHandler<ChangeConnectionCompartmentRequest,ChangeConnectionCompartmentResponse> handler)
Description copied from interface:DatabaseMigrationAsyncUsed to change the Database Connection compartment.- Specified by:
changeConnectionCompartmentin interfaceDatabaseMigrationAsync- 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:DatabaseMigrationAsyncUsed to change the Migration compartment.- Specified by:
changeMigrationCompartmentin interfaceDatabaseMigrationAsync- 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.
-
cloneMigration
public Future<CloneMigrationResponse> cloneMigration(CloneMigrationRequest request, AsyncHandler<CloneMigrationRequest,CloneMigrationResponse> handler)
Description copied from interface:DatabaseMigrationAsyncClone a configuration from an existing Migration.- Specified by:
cloneMigrationin interfaceDatabaseMigrationAsync- 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.
-
collectTraces
public Future<CollectTracesResponse> collectTraces(CollectTracesRequest request, AsyncHandler<CollectTracesRequest,CollectTracesResponse> handler)
Description copied from interface:DatabaseMigrationAsyncCollects the DB trace and alert logs.- Specified by:
collectTracesin interfaceDatabaseMigrationAsync- 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.
-
connectionDiagnostics
public Future<ConnectionDiagnosticsResponse> connectionDiagnostics(ConnectionDiagnosticsRequest request, AsyncHandler<ConnectionDiagnosticsRequest,ConnectionDiagnosticsResponse> handler)
Description copied from interface:DatabaseMigrationAsyncPerform connection test for a database connection.- Specified by:
connectionDiagnosticsin interfaceDatabaseMigrationAsync- 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.
-
createConnection
public Future<CreateConnectionResponse> createConnection(CreateConnectionRequest request, AsyncHandler<CreateConnectionRequest,CreateConnectionResponse> handler)
Description copied from interface:DatabaseMigrationAsyncCreate a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration.- Specified by:
createConnectionin interfaceDatabaseMigrationAsync- 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:DatabaseMigrationAsyncCreate a Migration resource that contains all the details to perform the database migration operation, such as source and destination database details, credentials, etc.- Specified by:
createMigrationin interfaceDatabaseMigrationAsync- 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.
-
createParameterFileVersion
public Future<CreateParameterFileVersionResponse> createParameterFileVersion(CreateParameterFileVersionRequest request, AsyncHandler<CreateParameterFileVersionRequest,CreateParameterFileVersionResponse> handler)
Description copied from interface:DatabaseMigrationAsyncCreates a new version of the current parameter file contents to the specified value.- Specified by:
createParameterFileVersionin interfaceDatabaseMigrationAsync- 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.
-
deleteConnection
public Future<DeleteConnectionResponse> deleteConnection(DeleteConnectionRequest request, AsyncHandler<DeleteConnectionRequest,DeleteConnectionResponse> handler)
Description copied from interface:DatabaseMigrationAsyncDeletes the Database Connection represented by the specified connection ID.- Specified by:
deleteConnectionin interfaceDatabaseMigrationAsync- 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.
-
deleteJob
public Future<DeleteJobResponse> deleteJob(DeleteJobRequest request, AsyncHandler<DeleteJobRequest,DeleteJobResponse> handler)
Description copied from interface:DatabaseMigrationAsyncDeletes the migration job represented by the given job ID.- Specified by:
deleteJobin interfaceDatabaseMigrationAsync- 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:DatabaseMigrationAsyncDeletes the Migration represented by the specified migration ID.- Specified by:
deleteMigrationin interfaceDatabaseMigrationAsync- 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.
-
deleteParameterFileVersion
public Future<DeleteParameterFileVersionResponse> deleteParameterFileVersion(DeleteParameterFileVersionRequest request, AsyncHandler<DeleteParameterFileVersionRequest,DeleteParameterFileVersionResponse> handler)
Description copied from interface:DatabaseMigrationAsyncDeletes the given parameter file version- Specified by:
deleteParameterFileVersionin interfaceDatabaseMigrationAsync- 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.
-
evaluateMigration
public Future<EvaluateMigrationResponse> evaluateMigration(EvaluateMigrationRequest request, AsyncHandler<EvaluateMigrationRequest,EvaluateMigrationResponse> handler)
Description copied from interface:DatabaseMigrationAsyncStart Validate Migration job.- Specified by:
evaluateMigrationin interfaceDatabaseMigrationAsync- 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.
-
getAdvisorReport
public Future<GetAdvisorReportResponse> getAdvisorReport(GetAdvisorReportRequest request, AsyncHandler<GetAdvisorReportRequest,GetAdvisorReportResponse> handler)
Description copied from interface:DatabaseMigrationAsyncGet the Pre-Migration Advisor report details- Specified by:
getAdvisorReportin interfaceDatabaseMigrationAsync- 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.
-
getConnection
public Future<GetConnectionResponse> getConnection(GetConnectionRequest request, AsyncHandler<GetConnectionRequest,GetConnectionResponse> handler)
Description copied from interface:DatabaseMigrationAsyncDisplay Database Connection details.- Specified by:
getConnectionin interfaceDatabaseMigrationAsync- 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.
-
getJob
public Future<GetJobResponse> getJob(GetJobRequest request, AsyncHandler<GetJobRequest,GetJobResponse> handler)
Description copied from interface:DatabaseMigrationAsyncGet a migration job.- Specified by:
getJobin interfaceDatabaseMigrationAsync- 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.
-
getJobOutputContent
public Future<GetJobOutputContentResponse> getJobOutputContent(GetJobOutputContentRequest request, AsyncHandler<GetJobOutputContentRequest,GetJobOutputContentResponse> handler)
Description copied from interface:DatabaseMigrationAsyncGet the migration Job Output content as a String.- Specified by:
getJobOutputContentin interfaceDatabaseMigrationAsync- 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:DatabaseMigrationAsyncDisplay Migration details.- Specified by:
getMigrationin interfaceDatabaseMigrationAsync- 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.
-
getParameterFileVersion
public Future<GetParameterFileVersionResponse> getParameterFileVersion(GetParameterFileVersionRequest request, AsyncHandler<GetParameterFileVersionRequest,GetParameterFileVersionResponse> handler)
Description copied from interface:DatabaseMigrationAsyncObtain the parameter file version contents for the specified parameter file name and the associated job.This operation will be allowed only if the job is certain acceptable lifecycle states.
- Specified by:
getParameterFileVersionin interfaceDatabaseMigrationAsync- 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:DatabaseMigrationAsyncGets the details of a work request.- Specified by:
getWorkRequestin interfaceDatabaseMigrationAsync- 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.
-
listConnections
public Future<ListConnectionsResponse> listConnections(ListConnectionsRequest request, AsyncHandler<ListConnectionsRequest,ListConnectionsResponse> handler)
Description copied from interface:DatabaseMigrationAsyncList all Database Connections.- Specified by:
listConnectionsin interfaceDatabaseMigrationAsync- 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.
-
listExcludedObjects
public Future<ListExcludedObjectsResponse> listExcludedObjects(ListExcludedObjectsRequest request, AsyncHandler<ListExcludedObjectsRequest,ListExcludedObjectsResponse> handler)
Description copied from interface:DatabaseMigrationAsyncList the excluded database objects.- Specified by:
listExcludedObjectsin interfaceDatabaseMigrationAsync- 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.
-
listJobOutputs
public Future<ListJobOutputsResponse> listJobOutputs(ListJobOutputsRequest request, AsyncHandler<ListJobOutputsRequest,ListJobOutputsResponse> handler)
Description copied from interface:DatabaseMigrationAsyncList the Job Outputs- Specified by:
listJobOutputsin interfaceDatabaseMigrationAsync- 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.
-
listJobs
public Future<ListJobsResponse> listJobs(ListJobsRequest request, AsyncHandler<ListJobsRequest,ListJobsResponse> handler)
Description copied from interface:DatabaseMigrationAsyncList all the names of the Migration jobs associated to the specified migration site.- Specified by:
listJobsin interfaceDatabaseMigrationAsync- 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.
-
listMigrationObjectTypes
public Future<ListMigrationObjectTypesResponse> listMigrationObjectTypes(ListMigrationObjectTypesRequest request, AsyncHandler<ListMigrationObjectTypesRequest,ListMigrationObjectTypesResponse> handler)
Description copied from interface:DatabaseMigrationAsyncDisplay sample object types to exclude or include for a Migration.- Specified by:
listMigrationObjectTypesin interfaceDatabaseMigrationAsync- 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.
-
listMigrationObjects
public Future<ListMigrationObjectsResponse> listMigrationObjects(ListMigrationObjectsRequest request, AsyncHandler<ListMigrationObjectsRequest,ListMigrationObjectsResponse> handler)
Description copied from interface:DatabaseMigrationAsyncDisplay excluded/included objects.- Specified by:
listMigrationObjectsin interfaceDatabaseMigrationAsync- 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.
-
listMigrationParameters
public Future<ListMigrationParametersResponse> listMigrationParameters(ListMigrationParametersRequest request, AsyncHandler<ListMigrationParametersRequest,ListMigrationParametersResponse> handler)
Description copied from interface:DatabaseMigrationAsyncList of parameters that can be used to customize migrations.- Specified by:
listMigrationParametersin interfaceDatabaseMigrationAsync- 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:DatabaseMigrationAsyncList all Migrations.- Specified by:
listMigrationsin interfaceDatabaseMigrationAsync- 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.
-
listParameterFileVersions
public Future<ListParameterFileVersionsResponse> listParameterFileVersions(ListParameterFileVersionsRequest request, AsyncHandler<ListParameterFileVersionsRequest,ListParameterFileVersionsResponse> handler)
Description copied from interface:DatabaseMigrationAsyncReturn a list of the parameter file metadata of the migration execution of the specified job.This will only be acceptable if the job is in particular state. It will be accessible if the job is in the FAILED, PAUSED or SUSPENDED state.
- Specified by:
listParameterFileVersionsin interfaceDatabaseMigrationAsync- 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:DatabaseMigrationAsyncGets the errors for a work request.- Specified by:
listWorkRequestErrorsin interfaceDatabaseMigrationAsync- 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:DatabaseMigrationAsyncGets the logs for a work request.- Specified by:
listWorkRequestLogsin interfaceDatabaseMigrationAsync- 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:DatabaseMigrationAsyncLists the work requests in a compartment or for a specified resource.- Specified by:
listWorkRequestsin interfaceDatabaseMigrationAsync- 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.
-
makeCurrentParameterFileVersion
public Future<MakeCurrentParameterFileVersionResponse> makeCurrentParameterFileVersion(MakeCurrentParameterFileVersionRequest request, AsyncHandler<MakeCurrentParameterFileVersionRequest,MakeCurrentParameterFileVersionResponse> handler)
Description copied from interface:DatabaseMigrationAsyncMake current the given parameter file version- Specified by:
makeCurrentParameterFileVersionin interfaceDatabaseMigrationAsync- 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.
-
removeMigrationObjects
public Future<RemoveMigrationObjectsResponse> removeMigrationObjects(RemoveMigrationObjectsRequest request, AsyncHandler<RemoveMigrationObjectsRequest,RemoveMigrationObjectsResponse> handler)
Description copied from interface:DatabaseMigrationAsyncRemove excluded/included objects.- Specified by:
removeMigrationObjectsin interfaceDatabaseMigrationAsync- 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.
-
resumeJob
public Future<ResumeJobResponse> resumeJob(ResumeJobRequest request, AsyncHandler<ResumeJobRequest,ResumeJobResponse> handler)
Description copied from interface:DatabaseMigrationAsyncResume a migration Job.- Specified by:
resumeJobin interfaceDatabaseMigrationAsync- 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.
-
retrieveSupportedPhases
public Future<RetrieveSupportedPhasesResponse> retrieveSupportedPhases(RetrieveSupportedPhasesRequest request, AsyncHandler<RetrieveSupportedPhasesRequest,RetrieveSupportedPhasesResponse> handler)
Description copied from interface:DatabaseMigrationAsyncDisplay Migration Phases for a specified migration.- Specified by:
retrieveSupportedPhasesin interfaceDatabaseMigrationAsync- 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.
-
startMigration
public Future<StartMigrationResponse> startMigration(StartMigrationRequest request, AsyncHandler<StartMigrationRequest,StartMigrationResponse> handler)
Description copied from interface:DatabaseMigrationAsyncStart Migration job.- Specified by:
startMigrationin interfaceDatabaseMigrationAsync- 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.
-
suspendJob
public Future<SuspendJobResponse> suspendJob(SuspendJobRequest request, AsyncHandler<SuspendJobRequest,SuspendJobResponse> handler)
Description copied from interface:DatabaseMigrationAsyncPlace the currently executing migration Job in a Suspended State.- Specified by:
suspendJobin interfaceDatabaseMigrationAsync- 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.
-
updateConnection
public Future<UpdateConnectionResponse> updateConnection(UpdateConnectionRequest request, AsyncHandler<UpdateConnectionRequest,UpdateConnectionResponse> handler)
Description copied from interface:DatabaseMigrationAsyncUpdate Database Connection resource details.- Specified by:
updateConnectionin interfaceDatabaseMigrationAsync- 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.
-
updateJob
public Future<UpdateJobResponse> updateJob(UpdateJobRequest request, AsyncHandler<UpdateJobRequest,UpdateJobResponse> handler)
Description copied from interface:DatabaseMigrationAsyncUpdate Migration Job resource details.- Specified by:
updateJobin interfaceDatabaseMigrationAsync- 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:DatabaseMigrationAsyncUpdate Migration resource details.- Specified by:
updateMigrationin interfaceDatabaseMigrationAsync- 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
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein 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)
-
-