Class DatabaseMigrationClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.databasemigration.DatabaseMigrationClient
-
- All Implemented Interfaces:
DatabaseMigration
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20230518") public class DatabaseMigrationClient extends BaseSyncClient implements DatabaseMigration
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DatabaseMigrationClient.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 DatabaseMigration.
-
Constructor Summary
Constructors Constructor Description DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.DatabaseMigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.DatabaseMigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.DatabaseMigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AbortJobResponse
abortJob(AbortJobRequest request)
Aborts a Migration Job (either Evaluation or Migration).AddMigrationObjectsResponse
addMigrationObjects(AddMigrationObjectsRequest request)
Add excluded/included object to the list.static DatabaseMigrationClient.Builder
builder()
Create a builder for this client.ChangeConnectionCompartmentResponse
changeConnectionCompartment(ChangeConnectionCompartmentRequest request)
Used to change the Database Connection compartment.ChangeMigrationCompartmentResponse
changeMigrationCompartment(ChangeMigrationCompartmentRequest request)
Used to change the Migration compartment.CloneMigrationResponse
cloneMigration(CloneMigrationRequest request)
Clone a configuration from an existing Migration.void
close()
ConnectionDiagnosticsResponse
connectionDiagnostics(ConnectionDiagnosticsRequest request)
Perform connection test for a database connection.CreateConnectionResponse
createConnection(CreateConnectionRequest request)
Create a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration.CreateMigrationResponse
createMigration(CreateMigrationRequest request)
Create a Migration resource that contains all the details to perform the database migration operation, such as source and destination database details, credentials, etc.CreateParameterFileVersionResponse
createParameterFileVersion(CreateParameterFileVersionRequest request)
Creates a new version of the current parameter file contents to the specified value.DeleteConnectionResponse
deleteConnection(DeleteConnectionRequest request)
Deletes the Database Connection represented by the specified connection ID.DeleteJobResponse
deleteJob(DeleteJobRequest request)
Deletes the migration job represented by the given job ID.DeleteMigrationResponse
deleteMigration(DeleteMigrationRequest request)
Deletes the Migration represented by the specified migration ID.DeleteParameterFileVersionResponse
deleteParameterFileVersion(DeleteParameterFileVersionRequest request)
Deletes the given parameter file versionEvaluateMigrationResponse
evaluateMigration(EvaluateMigrationRequest request)
Start Validate Migration job.GetAdvisorReportResponse
getAdvisorReport(GetAdvisorReportRequest request)
Get the Pre-Migration Advisor report detailsString
getClientCommonLibraryVersion()
GetConnectionResponse
getConnection(GetConnectionRequest request)
Display Database Connection details.protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
GetJobResponse
getJob(GetJobRequest request)
Get a migration job.GetJobOutputContentResponse
getJobOutputContent(GetJobOutputContentRequest request)
Get the migration Job Output content as a String.GetMigrationResponse
getMigration(GetMigrationRequest request)
Display Migration details.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
DatabaseMigrationPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetParameterFileVersionResponse
getParameterFileVersion(GetParameterFileVersionRequest request)
Obtain the parameter file version contents for the specified parameter file name and the associated job.DatabaseMigrationWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponse
getWorkRequest(GetWorkRequestRequest request)
Gets the details of a work request.ListConnectionsResponse
listConnections(ListConnectionsRequest request)
List all Database Connections.ListExcludedObjectsResponse
listExcludedObjects(ListExcludedObjectsRequest request)
List the excluded database objects.ListJobOutputsResponse
listJobOutputs(ListJobOutputsRequest request)
List the Job OutputsListJobsResponse
listJobs(ListJobsRequest request)
List all the names of the Migration jobs associated to the specified migration site.ListMigrationObjectsResponse
listMigrationObjects(ListMigrationObjectsRequest request)
Display excluded/included objects.ListMigrationObjectTypesResponse
listMigrationObjectTypes(ListMigrationObjectTypesRequest request)
Display sample object types to exclude or include for a Migration.ListMigrationParametersResponse
listMigrationParameters(ListMigrationParametersRequest request)
List of parameters that can be used to customize migrations.ListMigrationsResponse
listMigrations(ListMigrationsRequest request)
List all Migrations.ListParameterFileVersionsResponse
listParameterFileVersions(ListParameterFileVersionsRequest request)
Return a list of the parameter file metadata of the migration execution of the specified job.ListWorkRequestErrorsResponse
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Gets the errors for a work request.ListWorkRequestLogsResponse
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Gets the logs for a work request.ListWorkRequestsResponse
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment or for a specified resource.MakeCurrentParameterFileVersionResponse
makeCurrentParameterFileVersion(MakeCurrentParameterFileVersionRequest request)
Make current the given parameter file versionvoid
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.void
refreshClient()
Rebuild the backingHttpClient
.RemoveMigrationObjectsResponse
removeMigrationObjects(RemoveMigrationObjectsRequest request)
Remove excluded/included objects.ResumeJobResponse
resumeJob(ResumeJobRequest request)
Resume a migration Job.RetrieveSupportedPhasesResponse
retrieveSupportedPhases(RetrieveSupportedPhasesRequest request)
Display Migration Phases for a specified migration.void
setEndpoint(String endpoint)
void
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).void
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).StartMigrationResponse
startMigration(StartMigrationRequest request)
Start Migration job.SuspendJobResponse
suspendJob(SuspendJobRequest request)
Place the currently executing migration Job in a Suspended State.void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.UpdateConnectionResponse
updateConnection(UpdateConnectionRequest request)
Update Database Connection resource details.UpdateJobResponse
updateJob(UpdateJobRequest request)
Update Migration Job resource details.UpdateMigrationResponse
updateMigration(UpdateMigrationRequest request)
Update Migration resource details.void
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
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.DatabaseMigration
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DatabaseMigrationClient
@Deprecated public DatabaseMigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatabaseMigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
DatabaseMigrationClient
@Deprecated public DatabaseMigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatabaseMigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
DatabaseMigrationClient
@Deprecated public DatabaseMigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatabaseMigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DatabaseMigrationClient
@Deprecated public DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatabaseMigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
DatabaseMigrationClient
@Deprecated public DatabaseMigrationClient(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 (seeDatabaseMigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
DatabaseMigrationClient
@Deprecated public DatabaseMigrationClient(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 (seeDatabaseMigrationClient.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)
-
DatabaseMigrationClient
@Deprecated public DatabaseMigrationClient(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 (seeDatabaseMigrationClient.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
-
DatabaseMigrationClient
@Deprecated public DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatabaseMigrationClient.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
executorService
-DatabaseMigrationClient.Builder.executorService
-
-
Method Detail
-
builder
public static DatabaseMigrationClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DatabaseMigration
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 interfaceDatabaseMigration
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DatabaseMigration
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 interfaceDatabaseMigration
- Parameters:
regionId
- The public region ID.
-
abortJob
public AbortJobResponse abortJob(AbortJobRequest request)
Description copied from interface:DatabaseMigration
Aborts a Migration Job (either Evaluation or Migration).- Specified by:
abortJob
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addMigrationObjects
public AddMigrationObjectsResponse addMigrationObjects(AddMigrationObjectsRequest request)
Description copied from interface:DatabaseMigration
Add excluded/included object to the list.- Specified by:
addMigrationObjects
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeConnectionCompartment
public ChangeConnectionCompartmentResponse changeConnectionCompartment(ChangeConnectionCompartmentRequest request)
Description copied from interface:DatabaseMigration
Used to change the Database Connection compartment.- Specified by:
changeConnectionCompartment
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeMigrationCompartment
public ChangeMigrationCompartmentResponse changeMigrationCompartment(ChangeMigrationCompartmentRequest request)
Description copied from interface:DatabaseMigration
Used to change the Migration compartment.- Specified by:
changeMigrationCompartment
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cloneMigration
public CloneMigrationResponse cloneMigration(CloneMigrationRequest request)
Description copied from interface:DatabaseMigration
Clone a configuration from an existing Migration.- Specified by:
cloneMigration
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
connectionDiagnostics
public ConnectionDiagnosticsResponse connectionDiagnostics(ConnectionDiagnosticsRequest request)
Description copied from interface:DatabaseMigration
Perform connection test for a database connection.- Specified by:
connectionDiagnostics
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createConnection
public CreateConnectionResponse createConnection(CreateConnectionRequest request)
Description copied from interface:DatabaseMigration
Create a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration.- Specified by:
createConnection
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createMigration
public CreateMigrationResponse createMigration(CreateMigrationRequest request)
Description copied from interface:DatabaseMigration
Create 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:
createMigration
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createParameterFileVersion
public CreateParameterFileVersionResponse createParameterFileVersion(CreateParameterFileVersionRequest request)
Description copied from interface:DatabaseMigration
Creates a new version of the current parameter file contents to the specified value.- Specified by:
createParameterFileVersion
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteConnection
public DeleteConnectionResponse deleteConnection(DeleteConnectionRequest request)
Description copied from interface:DatabaseMigration
Deletes the Database Connection represented by the specified connection ID.- Specified by:
deleteConnection
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteJob
public DeleteJobResponse deleteJob(DeleteJobRequest request)
Description copied from interface:DatabaseMigration
Deletes the migration job represented by the given job ID.- Specified by:
deleteJob
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteMigration
public DeleteMigrationResponse deleteMigration(DeleteMigrationRequest request)
Description copied from interface:DatabaseMigration
Deletes the Migration represented by the specified migration ID.- Specified by:
deleteMigration
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteParameterFileVersion
public DeleteParameterFileVersionResponse deleteParameterFileVersion(DeleteParameterFileVersionRequest request)
Description copied from interface:DatabaseMigration
Deletes the given parameter file version- Specified by:
deleteParameterFileVersion
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
evaluateMigration
public EvaluateMigrationResponse evaluateMigration(EvaluateMigrationRequest request)
Description copied from interface:DatabaseMigration
Start Validate Migration job.- Specified by:
evaluateMigration
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAdvisorReport
public GetAdvisorReportResponse getAdvisorReport(GetAdvisorReportRequest request)
Description copied from interface:DatabaseMigration
Get the Pre-Migration Advisor report details- Specified by:
getAdvisorReport
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getConnection
public GetConnectionResponse getConnection(GetConnectionRequest request)
Description copied from interface:DatabaseMigration
Display Database Connection details.- Specified by:
getConnection
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJob
public GetJobResponse getJob(GetJobRequest request)
Description copied from interface:DatabaseMigration
Get a migration job.- Specified by:
getJob
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJobOutputContent
public GetJobOutputContentResponse getJobOutputContent(GetJobOutputContentRequest request)
Description copied from interface:DatabaseMigration
Get the migration Job Output content as a String.- Specified by:
getJobOutputContent
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getMigration
public GetMigrationResponse getMigration(GetMigrationRequest request)
Description copied from interface:DatabaseMigration
Display Migration details.- Specified by:
getMigration
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getParameterFileVersion
public GetParameterFileVersionResponse getParameterFileVersion(GetParameterFileVersionRequest request)
Description copied from interface:DatabaseMigration
Obtain the parameter file version contents for the specified parameter file name and the associated job.This operation will be allowed only if the job is certain acceptable lifecycle states.
- Specified by:
getParameterFileVersion
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:DatabaseMigration
Gets the details of a work request.- Specified by:
getWorkRequest
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listConnections
public ListConnectionsResponse listConnections(ListConnectionsRequest request)
Description copied from interface:DatabaseMigration
List all Database Connections.- Specified by:
listConnections
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listExcludedObjects
public ListExcludedObjectsResponse listExcludedObjects(ListExcludedObjectsRequest request)
Description copied from interface:DatabaseMigration
List the excluded database objects.- Specified by:
listExcludedObjects
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJobOutputs
public ListJobOutputsResponse listJobOutputs(ListJobOutputsRequest request)
Description copied from interface:DatabaseMigration
List the Job Outputs- Specified by:
listJobOutputs
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJobs
public ListJobsResponse listJobs(ListJobsRequest request)
Description copied from interface:DatabaseMigration
List all the names of the Migration jobs associated to the specified migration site.- Specified by:
listJobs
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMigrationObjectTypes
public ListMigrationObjectTypesResponse listMigrationObjectTypes(ListMigrationObjectTypesRequest request)
Description copied from interface:DatabaseMigration
Display sample object types to exclude or include for a Migration.- Specified by:
listMigrationObjectTypes
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMigrationObjects
public ListMigrationObjectsResponse listMigrationObjects(ListMigrationObjectsRequest request)
Description copied from interface:DatabaseMigration
Display excluded/included objects.- Specified by:
listMigrationObjects
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMigrationParameters
public ListMigrationParametersResponse listMigrationParameters(ListMigrationParametersRequest request)
Description copied from interface:DatabaseMigration
List of parameters that can be used to customize migrations.- Specified by:
listMigrationParameters
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMigrations
public ListMigrationsResponse listMigrations(ListMigrationsRequest request)
Description copied from interface:DatabaseMigration
List all Migrations.- Specified by:
listMigrations
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listParameterFileVersions
public ListParameterFileVersionsResponse listParameterFileVersions(ListParameterFileVersionsRequest request)
Description copied from interface:DatabaseMigration
Return a list of the parameter file metadata of the migration execution of the specified job.This will only be acceptable if the job is in particular state. It will be accessible if the job is in the FAILED, PAUSED or SUSPENDED state.
- Specified by:
listParameterFileVersions
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:DatabaseMigration
Gets the errors for a work request.- Specified by:
listWorkRequestErrors
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:DatabaseMigration
Gets the logs for a work request.- Specified by:
listWorkRequestLogs
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:DatabaseMigration
Lists the work requests in a compartment or for a specified resource.- Specified by:
listWorkRequests
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
makeCurrentParameterFileVersion
public MakeCurrentParameterFileVersionResponse makeCurrentParameterFileVersion(MakeCurrentParameterFileVersionRequest request)
Description copied from interface:DatabaseMigration
Make current the given parameter file version- Specified by:
makeCurrentParameterFileVersion
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeMigrationObjects
public RemoveMigrationObjectsResponse removeMigrationObjects(RemoveMigrationObjectsRequest request)
Description copied from interface:DatabaseMigration
Remove excluded/included objects.- Specified by:
removeMigrationObjects
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
resumeJob
public ResumeJobResponse resumeJob(ResumeJobRequest request)
Description copied from interface:DatabaseMigration
Resume a migration Job.- Specified by:
resumeJob
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
retrieveSupportedPhases
public RetrieveSupportedPhasesResponse retrieveSupportedPhases(RetrieveSupportedPhasesRequest request)
Description copied from interface:DatabaseMigration
Display Migration Phases for a specified migration.- Specified by:
retrieveSupportedPhases
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
startMigration
public StartMigrationResponse startMigration(StartMigrationRequest request)
Description copied from interface:DatabaseMigration
Start Migration job.- Specified by:
startMigration
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
suspendJob
public SuspendJobResponse suspendJob(SuspendJobRequest request)
Description copied from interface:DatabaseMigration
Place the currently executing migration Job in a Suspended State.- Specified by:
suspendJob
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateConnection
public UpdateConnectionResponse updateConnection(UpdateConnectionRequest request)
Description copied from interface:DatabaseMigration
Update Database Connection resource details.- Specified by:
updateConnection
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateJob
public UpdateJobResponse updateJob(UpdateJobRequest request)
Description copied from interface:DatabaseMigration
Update Migration Job resource details.- Specified by:
updateJob
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateMigration
public UpdateMigrationResponse updateMigration(UpdateMigrationRequest request)
Description copied from interface:DatabaseMigration
Update Migration resource details.- Specified by:
updateMigration
in interfaceDatabaseMigration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DatabaseMigrationWaiters getWaiters()
Description copied from interface:DatabaseMigration
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceDatabaseMigration
- Returns:
- The service waiters.
-
getPaginators
public DatabaseMigrationPaginators getPaginators()
Description copied from interface:DatabaseMigration
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginators
in interfaceDatabaseMigration
- Returns:
- The service paginators.
-
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()
-
-