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 classDatabaseMigrationClient.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 DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.DatabaseMigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DatabaseMigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DatabaseMigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AbortJobResponseabortJob(AbortJobRequest request)Aborts a Migration Job (either Evaluation or Migration).AddMigrationObjectsResponseaddMigrationObjects(AddMigrationObjectsRequest request)Add excluded/included object to the list.static DatabaseMigrationClient.Builderbuilder()Create a builder for this client.ChangeConnectionCompartmentResponsechangeConnectionCompartment(ChangeConnectionCompartmentRequest request)Used to change the Database Connection compartment.ChangeMigrationCompartmentResponsechangeMigrationCompartment(ChangeMigrationCompartmentRequest request)Used to change the Migration compartment.CloneMigrationResponsecloneMigration(CloneMigrationRequest request)Clone a configuration from an existing Migration.voidclose()CollectTracesResponsecollectTraces(CollectTracesRequest request)Collects the DB trace and alert logs.ConnectionDiagnosticsResponseconnectionDiagnostics(ConnectionDiagnosticsRequest request)Perform connection test for a database connection.CreateConnectionResponsecreateConnection(CreateConnectionRequest request)Create a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration.CreateMigrationResponsecreateMigration(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.CreateParameterFileVersionResponsecreateParameterFileVersion(CreateParameterFileVersionRequest request)Creates a new version of the current parameter file contents to the specified value.DeleteConnectionResponsedeleteConnection(DeleteConnectionRequest request)Deletes the Database Connection represented by the specified connection ID.DeleteJobResponsedeleteJob(DeleteJobRequest request)Deletes the migration job represented by the given job ID.DeleteMigrationResponsedeleteMigration(DeleteMigrationRequest request)Deletes the Migration represented by the specified migration ID.DeleteParameterFileVersionResponsedeleteParameterFileVersion(DeleteParameterFileVersionRequest request)Deletes the given parameter file versionEvaluateMigrationResponseevaluateMigration(EvaluateMigrationRequest request)Start Validate Migration job.GetAdvisorReportResponsegetAdvisorReport(GetAdvisorReportRequest request)Get the Pre-Migration Advisor report detailsStringgetClientCommonLibraryVersion()GetConnectionResponsegetConnection(GetConnectionRequest request)Display Database Connection details.protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()GetJobResponsegetJob(GetJobRequest request)Get a migration job.GetJobOutputContentResponsegetJobOutputContent(GetJobOutputContentRequest request)Get the migration Job Output content as a String.GetMigrationResponsegetMigration(GetMigrationRequest request)Display Migration details.Optional<String>getMinimumClientCommonLibraryVersionFromClient()DatabaseMigrationPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetParameterFileVersionResponsegetParameterFileVersion(GetParameterFileVersionRequest request)Obtain the parameter file version contents for the specified parameter file name and the associated job.DatabaseMigrationWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponsegetWorkRequest(GetWorkRequestRequest request)Gets the details of a work request.ListConnectionsResponselistConnections(ListConnectionsRequest request)List all Database Connections.ListExcludedObjectsResponselistExcludedObjects(ListExcludedObjectsRequest request)List the excluded database objects.ListJobOutputsResponselistJobOutputs(ListJobOutputsRequest request)List the Job OutputsListJobsResponselistJobs(ListJobsRequest request)List all the names of the Migration jobs associated to the specified migration site.ListMigrationObjectsResponselistMigrationObjects(ListMigrationObjectsRequest request)Display excluded/included objects.ListMigrationObjectTypesResponselistMigrationObjectTypes(ListMigrationObjectTypesRequest request)Display sample object types to exclude or include for a Migration.ListMigrationParametersResponselistMigrationParameters(ListMigrationParametersRequest request)List of parameters that can be used to customize migrations.ListMigrationsResponselistMigrations(ListMigrationsRequest request)List all Migrations.ListParameterFileVersionsResponselistParameterFileVersions(ListParameterFileVersionsRequest request)Return a list of the parameter file metadata of the migration execution of the specified job.ListWorkRequestErrorsResponselistWorkRequestErrors(ListWorkRequestErrorsRequest request)Gets the errors for a work request.ListWorkRequestLogsResponselistWorkRequestLogs(ListWorkRequestLogsRequest request)Gets the logs for a work request.ListWorkRequestsResponselistWorkRequests(ListWorkRequestsRequest request)Lists the work requests in a compartment or for a specified resource.MakeCurrentParameterFileVersionResponsemakeCurrentParameterFileVersion(MakeCurrentParameterFileVersionRequest request)Make current the given parameter file versionvoidpopulateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)Populate the parameters in the endpoint with its corresponding value and update the base endpoint.voidrefreshClient()Rebuild the backingHttpClient.RemoveMigrationObjectsResponseremoveMigrationObjects(RemoveMigrationObjectsRequest request)Remove excluded/included objects.ResumeJobResponseresumeJob(ResumeJobRequest request)Resume a migration Job.RetrieveSupportedPhasesResponseretrieveSupportedPhases(RetrieveSupportedPhasesRequest request)Display Migration Phases for a specified migration.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).StartMigrationResponsestartMigration(StartMigrationRequest request)Start Migration job.SuspendJobResponsesuspendJob(SuspendJobRequest request)Place the currently executing migration Job in a Suspended State.voidupdateBaseEndpoint(String endpoint)This method should be used for parameterized endpoint templates only.UpdateConnectionResponseupdateConnection(UpdateConnectionRequest request)Update Database Connection resource details.UpdateJobResponseupdateJob(UpdateJobRequest request)Update Migration Job resource details.UpdateMigrationResponseupdateMigration(UpdateMigrationRequest request)Update Migration resource details.voiduseRealmSpecificEndpointTemplate(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 thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseMigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DatabaseMigrationClient
@Deprecated public DatabaseMigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseMigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseMigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
DatabaseMigrationClient
@Deprecated public DatabaseMigrationClient(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 (seeDatabaseMigrationClient.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)
-
DatabaseMigrationClient
@Deprecated public DatabaseMigrationClient(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 (seeDatabaseMigrationClient.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
-
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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatabaseMigrationClient.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.signingStrategyRequestSignerFactoriesexecutorService-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:DatabaseMigrationSets 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 interfaceDatabaseMigration- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DatabaseMigrationSets 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 interfaceDatabaseMigration- Parameters:
regionId- The public region ID.
-
abortJob
public AbortJobResponse abortJob(AbortJobRequest request)
Description copied from interface:DatabaseMigrationAborts a Migration Job (either Evaluation or Migration).- Specified by:
abortJobin 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:DatabaseMigrationAdd excluded/included object to the list.- Specified by:
addMigrationObjectsin 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:DatabaseMigrationUsed to change the Database Connection compartment.- Specified by:
changeConnectionCompartmentin 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:DatabaseMigrationUsed to change the Migration compartment.- Specified by:
changeMigrationCompartmentin 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:DatabaseMigrationClone a configuration from an existing Migration.- Specified by:
cloneMigrationin interfaceDatabaseMigration- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
collectTraces
public CollectTracesResponse collectTraces(CollectTracesRequest request)
Description copied from interface:DatabaseMigrationCollects the DB trace and alert logs.- Specified by:
collectTracesin 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:DatabaseMigrationPerform connection test for a database connection.- Specified by:
connectionDiagnosticsin 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:DatabaseMigrationCreate a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration.- Specified by:
createConnectionin 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:DatabaseMigrationCreate 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 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:DatabaseMigrationCreates a new version of the current parameter file contents to the specified value.- Specified by:
createParameterFileVersionin 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:DatabaseMigrationDeletes the Database Connection represented by the specified connection ID.- Specified by:
deleteConnectionin 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:DatabaseMigrationDeletes the migration job represented by the given job ID.- Specified by:
deleteJobin 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:DatabaseMigrationDeletes the Migration represented by the specified migration ID.- Specified by:
deleteMigrationin 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:DatabaseMigrationDeletes the given parameter file version- Specified by:
deleteParameterFileVersionin 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:DatabaseMigrationStart Validate Migration job.- Specified by:
evaluateMigrationin 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:DatabaseMigrationGet the Pre-Migration Advisor report details- Specified by:
getAdvisorReportin 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:DatabaseMigrationDisplay Database Connection details.- Specified by:
getConnectionin 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:DatabaseMigrationGet a migration job.- Specified by:
getJobin 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:DatabaseMigrationGet the migration Job Output content as a String.- Specified by:
getJobOutputContentin 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:DatabaseMigrationDisplay Migration details.- Specified by:
getMigrationin 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:DatabaseMigrationObtain 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 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:DatabaseMigrationGets the details of a work request.- Specified by:
getWorkRequestin 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:DatabaseMigrationList all Database Connections.- Specified by:
listConnectionsin 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:DatabaseMigrationList the excluded database objects.- Specified by:
listExcludedObjectsin 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:DatabaseMigrationList the Job Outputs- Specified by:
listJobOutputsin 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:DatabaseMigrationList all the names of the Migration jobs associated to the specified migration site.- Specified by:
listJobsin 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:DatabaseMigrationDisplay sample object types to exclude or include for a Migration.- Specified by:
listMigrationObjectTypesin 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:DatabaseMigrationDisplay excluded/included objects.- Specified by:
listMigrationObjectsin 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:DatabaseMigrationList of parameters that can be used to customize migrations.- Specified by:
listMigrationParametersin 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:DatabaseMigrationList all Migrations.- Specified by:
listMigrationsin 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:DatabaseMigrationReturn 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 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:DatabaseMigrationGets the errors for a work request.- Specified by:
listWorkRequestErrorsin 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:DatabaseMigrationGets the logs for a work request.- Specified by:
listWorkRequestLogsin 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:DatabaseMigrationLists the work requests in a compartment or for a specified resource.- Specified by:
listWorkRequestsin 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:DatabaseMigrationMake current the given parameter file version- Specified by:
makeCurrentParameterFileVersionin 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:DatabaseMigrationRemove excluded/included objects.- Specified by:
removeMigrationObjectsin 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:DatabaseMigrationResume a migration Job.- Specified by:
resumeJobin 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:DatabaseMigrationDisplay Migration Phases for a specified migration.- Specified by:
retrieveSupportedPhasesin 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:DatabaseMigrationStart Migration job.- Specified by:
startMigrationin 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:DatabaseMigrationPlace the currently executing migration Job in a Suspended State.- Specified by:
suspendJobin 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:DatabaseMigrationUpdate Database Connection resource details.- Specified by:
updateConnectionin 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:DatabaseMigrationUpdate Migration Job resource details.- Specified by:
updateJobin 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:DatabaseMigrationUpdate Migration resource details.- Specified by:
updateMigrationin 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:DatabaseMigrationGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceDatabaseMigration- Returns:
- The service waiters.
-
getPaginators
public DatabaseMigrationPaginators getPaginators()
Description copied from interface:DatabaseMigrationGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin 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
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()
-
-