com.oracle.bmc.cloudmigrations

Class MigrationClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.cloudmigrations.MigrationClient

All Implemented Interfaces:

Migration, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220919")
public class MigrationClient
extends BaseSyncClient
implements Migration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MigrationClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for Migration.

Constructor Summary

Constructors

Constructor and Description
MigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
MigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
MigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
MigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
MigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
MigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
MigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
MigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static MigrationClient.Builder	builder() Create a builder for this client.
CancelWorkRequestResponse	cancelWorkRequest(CancelWorkRequestRequest request) Cancels work request with the given ID.
ChangeMigrationCompartmentResponse	changeMigrationCompartment(ChangeMigrationCompartmentRequest request) Moves a migration resource from one compartment identifier to another.
ChangeMigrationPlanCompartmentResponse	changeMigrationPlanCompartment(ChangeMigrationPlanCompartmentRequest request) Moves a resource into a different compartment.
ChangeReplicationScheduleCompartmentResponse	changeReplicationScheduleCompartment(ChangeReplicationScheduleCompartmentRequest request) Moves a resource into a different compartment.
void	close()
CreateMigrationResponse	createMigration(CreateMigrationRequest request) Creates a migration.
CreateMigrationAssetResponse	createMigrationAsset(CreateMigrationAssetRequest request) Creates a migration asset.
CreateMigrationPlanResponse	createMigrationPlan(CreateMigrationPlanRequest request) Creates a migration plan.
CreateReplicationScheduleResponse	createReplicationSchedule(CreateReplicationScheduleRequest request) Creates a replication schedule.
CreateTargetAssetResponse	createTargetAsset(CreateTargetAssetRequest request) Creates a target asset.
DeleteMigrationResponse	deleteMigration(DeleteMigrationRequest request) Deletes a migration resource by identifier.
DeleteMigrationAssetResponse	deleteMigrationAsset(DeleteMigrationAssetRequest request) Deletes a migration asset resource by an identifier.
DeleteMigrationPlanResponse	deleteMigrationPlan(DeleteMigrationPlanRequest request) Deletes a migration plan resource by an identifier.
DeleteReplicationScheduleResponse	deleteReplicationSchedule(DeleteReplicationScheduleRequest request) Deletes a replication schedule resource by identifier.
DeleteTargetAssetResponse	deleteTargetAsset(DeleteTargetAssetRequest request) Deletes a target asset resource by identifier.
ExecuteMigrationPlanResponse	executeMigrationPlan(ExecuteMigrationPlanRequest request) Executes the migration plan with the migration plan ID.
ExportMigrationPlanResponse	exportMigrationPlan(ExportMigrationPlanRequest request) Exports the migration plan to a csv file.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetMigrationResponse	getMigration(GetMigrationRequest request) Gets a migration by identifier.
GetMigrationAssetResponse	getMigrationAsset(GetMigrationAssetRequest request) Gets a migration asset by identifier.
GetMigrationPlanResponse	getMigrationPlan(GetMigrationPlanRequest request) Gets a migration plan by identifier.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
MigrationPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetReplicationProgressResponse	getReplicationProgress(GetReplicationProgressRequest request) Gets the progress percentage of a migration asset’s replication process.
GetReplicationScheduleResponse	getReplicationSchedule(GetReplicationScheduleRequest request) Gets a replication schedule by identifier.
GetTargetAssetResponse	getTargetAsset(GetTargetAssetRequest request) Gets a target asset by identifier.
MigrationWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets the status of the work request with the given ID.
ImportMigrationPlanResponse	importMigrationPlan(ImportMigrationPlanRequest request) Imports a migration plan from a csv file.
ListAvailableShapesResponse	listAvailableShapes(ListAvailableShapesRequest request) List of shapes by parameters.
ListMigrationAssetsResponse	listMigrationAssets(ListMigrationAssetsRequest request) Returns a list of migration assets.
ListMigrationPlansResponse	listMigrationPlans(ListMigrationPlansRequest request) Returns a list of migration plans.
ListMigrationsResponse	listMigrations(ListMigrationsRequest request) Returns a list of migrations.
ListReplicationSchedulesResponse	listReplicationSchedules(ListReplicationSchedulesRequest request) Returns a list of replication schedules.
ListTargetAssetsResponse	listTargetAssets(ListTargetAssetsRequest request) Returns a list of target assets.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Returns a paginated list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Returns a paginated list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) List of work requests in a compartment.
void	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 backing HttpClient.
RefreshMigrationResponse	refreshMigration(RefreshMigrationRequest request) Refreshes migration based on the migration ID.
RefreshMigrationAssetResponse	refreshMigrationAsset(RefreshMigrationAssetRequest request) Refreshes the migration asset with the migration asset ID.
RefreshMigrationPlanResponse	refreshMigrationPlan(RefreshMigrationPlanRequest request) Refreshes the migration plan with the migration plan ID.
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’).
StartAssetReplicationResponse	startAssetReplication(StartAssetReplicationRequest request) Starts replication for the asset with the migration asset ID.
StartMigrationReplicationResponse	startMigrationReplication(StartMigrationReplicationRequest request) Starts replication for a migration or for some asset.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateMigrationResponse	updateMigration(UpdateMigrationRequest request) Updates the migration.
UpdateMigrationAssetResponse	updateMigrationAsset(UpdateMigrationAssetRequest request) Updates the migration asset.
UpdateMigrationPlanResponse	updateMigrationPlan(UpdateMigrationPlanRequest request) Updates the migration plan.
UpdateReplicationScheduleResponse	updateReplicationSchedule(UpdateReplicationScheduleRequest request) Updates the replication schedule.
UpdateTargetAssetResponse	updateTargetAsset(UpdateTargetAssetRequest request) Updates the target asset.
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 com.oracle.bmc.cloudmigrations.Migration

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Migration.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

MigrationClient

@Deprecated
public MigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

MigrationClient

@Deprecated
public MigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

MigrationClient

@Deprecated
public MigrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

MigrationClient

@Deprecated
public MigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

MigrationClient

@Deprecated
public MigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory,
                                   List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MigrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

MigrationClient

@Deprecated
public MigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory,
                                   List<ClientConfigurator> additionalClientConfigurators,
                                   String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MigrationClient.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)

MigrationClient

@Deprecated
public MigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory,
                                   Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                   List<ClientConfigurator> additionalClientConfigurators,
                                   String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MigrationClient.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

MigrationClient

@Deprecated
public MigrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory,
                                   Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                   List<ClientConfigurator> additionalClientConfigurators,
                                   String endpoint,
                                   ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MigrationClient.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 - MigrationClient.Builder.executorService

Method Detail

builder

public static MigrationClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Migration

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 interface Migration

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Migration

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface Migration

Parameters:

regionId - The public region ID.

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: Migration

Cancels work request with the given ID.

Specified by:

cancelWorkRequest in interface Migration

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: Migration

Moves a migration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeMigrationCompartment in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeMigrationPlanCompartment

public ChangeMigrationPlanCompartmentResponse changeMigrationPlanCompartment(ChangeMigrationPlanCompartmentRequest request)

Description copied from interface: Migration

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeMigrationPlanCompartment in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeReplicationScheduleCompartment

public ChangeReplicationScheduleCompartmentResponse changeReplicationScheduleCompartment(ChangeReplicationScheduleCompartmentRequest request)

Description copied from interface: Migration

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeReplicationScheduleCompartment in interface Migration

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: Migration

Creates a migration.

Specified by:

createMigration in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createMigrationAsset

public CreateMigrationAssetResponse createMigrationAsset(CreateMigrationAssetRequest request)

Description copied from interface: Migration

Creates a migration asset.

Specified by:

createMigrationAsset in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createMigrationPlan

public CreateMigrationPlanResponse createMigrationPlan(CreateMigrationPlanRequest request)

Description copied from interface: Migration

Creates a migration plan.

Specified by:

createMigrationPlan in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createReplicationSchedule

public CreateReplicationScheduleResponse createReplicationSchedule(CreateReplicationScheduleRequest request)

Description copied from interface: Migration

Creates a replication schedule.

Specified by:

createReplicationSchedule in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createTargetAsset

public CreateTargetAssetResponse createTargetAsset(CreateTargetAssetRequest request)

Description copied from interface: Migration

Creates a target asset.

Specified by:

createTargetAsset in interface Migration

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: Migration

Deletes a migration resource by identifier.

Specified by:

deleteMigration in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteMigrationAsset

public DeleteMigrationAssetResponse deleteMigrationAsset(DeleteMigrationAssetRequest request)

Description copied from interface: Migration

Deletes a migration asset resource by an identifier.

Specified by:

deleteMigrationAsset in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteMigrationPlan

public DeleteMigrationPlanResponse deleteMigrationPlan(DeleteMigrationPlanRequest request)

Description copied from interface: Migration

Deletes a migration plan resource by an identifier.

Specified by:

deleteMigrationPlan in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteReplicationSchedule

public DeleteReplicationScheduleResponse deleteReplicationSchedule(DeleteReplicationScheduleRequest request)

Description copied from interface: Migration

Deletes a replication schedule resource by identifier.

Specified by:

deleteReplicationSchedule in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteTargetAsset

public DeleteTargetAssetResponse deleteTargetAsset(DeleteTargetAssetRequest request)

Description copied from interface: Migration

Deletes a target asset resource by identifier.

Specified by:

deleteTargetAsset in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

executeMigrationPlan

public ExecuteMigrationPlanResponse executeMigrationPlan(ExecuteMigrationPlanRequest request)

Description copied from interface: Migration

Executes the migration plan with the migration plan ID.

Specified by:

executeMigrationPlan in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

exportMigrationPlan

public ExportMigrationPlanResponse exportMigrationPlan(ExportMigrationPlanRequest request)

Description copied from interface: Migration

Exports the migration plan to a csv file.

Specified by:

exportMigrationPlan in interface Migration

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: Migration

Gets a migration by identifier.

Specified by:

getMigration in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getMigrationAsset

public GetMigrationAssetResponse getMigrationAsset(GetMigrationAssetRequest request)

Description copied from interface: Migration

Gets a migration asset by identifier.

Specified by:

getMigrationAsset in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getMigrationPlan

public GetMigrationPlanResponse getMigrationPlan(GetMigrationPlanRequest request)

Description copied from interface: Migration

Gets a migration plan by identifier.

Specified by:

getMigrationPlan in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getReplicationProgress

public GetReplicationProgressResponse getReplicationProgress(GetReplicationProgressRequest request)

Description copied from interface: Migration

Gets the progress percentage of a migration asset’s replication process.

Specified by:

getReplicationProgress in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getReplicationSchedule

public GetReplicationScheduleResponse getReplicationSchedule(GetReplicationScheduleRequest request)

Description copied from interface: Migration

Gets a replication schedule by identifier.

Specified by:

getReplicationSchedule in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getTargetAsset

public GetTargetAssetResponse getTargetAsset(GetTargetAssetRequest request)

Description copied from interface: Migration

Gets a target asset by identifier.

Specified by:

getTargetAsset in interface Migration

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: Migration

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

importMigrationPlan

public ImportMigrationPlanResponse importMigrationPlan(ImportMigrationPlanRequest request)

Description copied from interface: Migration

Imports a migration plan from a csv file.

Note: This operation consumes a stream.

If the stream supports InputStream.mark(int) and InputStream.reset(), when a retry is necessary, the stream is reset so it starts at the beginning (or whatever the stream's position was at the time this operation is called}.

Note this means that if the caller has used InputStream.mark(int) before, then the mark will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by the caller will reset the stream not to the caller's mark, but to the position the stream was in when this operation was called.

If the stream is a FileInputStream, and the stream's FileChannel position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as above is followed. If the stream's FileChannel position cannot be changed (like for a named pipe), then the stream's contents will be buffered in memory, as described below.

If the stream does not support InputStream.mark(int) and InputStream.reset(), then the stream is wrapped in a BufferedInputStream, which means the entire contents may be buffered in memory. Then the same procedure as above is followed.

The contents of the stream, except when the stream is a FileInputStream whose FileChannel position can be changed, should be less than 2 GiB in size if retries are used. This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in retries and manage retries yourself.

Specified by:

importMigrationPlan in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAvailableShapes

public ListAvailableShapesResponse listAvailableShapes(ListAvailableShapesRequest request)

Description copied from interface: Migration

List of shapes by parameters.

Specified by:

listAvailableShapes in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listMigrationAssets

public ListMigrationAssetsResponse listMigrationAssets(ListMigrationAssetsRequest request)

Description copied from interface: Migration

Returns a list of migration assets.

Specified by:

listMigrationAssets in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listMigrationPlans

public ListMigrationPlansResponse listMigrationPlans(ListMigrationPlansRequest request)

Description copied from interface: Migration

Returns a list of migration plans.

Specified by:

listMigrationPlans in interface Migration

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: Migration

Returns a list of migrations.

Specified by:

listMigrations in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listReplicationSchedules

public ListReplicationSchedulesResponse listReplicationSchedules(ListReplicationSchedulesRequest request)

Description copied from interface: Migration

Returns a list of replication schedules.

Specified by:

listReplicationSchedules in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTargetAssets

public ListTargetAssetsResponse listTargetAssets(ListTargetAssetsRequest request)

Description copied from interface: Migration

Returns a list of target assets.

Specified by:

listTargetAssets in interface Migration

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: Migration

Returns a paginated list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface Migration

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: Migration

Returns a paginated list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface Migration

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: Migration

List of work requests in a compartment.

Specified by:

listWorkRequests in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

refreshMigration

public RefreshMigrationResponse refreshMigration(RefreshMigrationRequest request)

Description copied from interface: Migration

Refreshes migration based on the migration ID.

Specified by:

refreshMigration in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

refreshMigrationAsset

public RefreshMigrationAssetResponse refreshMigrationAsset(RefreshMigrationAssetRequest request)

Description copied from interface: Migration

Refreshes the migration asset with the migration asset ID.

Specified by:

refreshMigrationAsset in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

refreshMigrationPlan

public RefreshMigrationPlanResponse refreshMigrationPlan(RefreshMigrationPlanRequest request)

Description copied from interface: Migration

Refreshes the migration plan with the migration plan ID.

Specified by:

refreshMigrationPlan in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startAssetReplication

public StartAssetReplicationResponse startAssetReplication(StartAssetReplicationRequest request)

Description copied from interface: Migration

Starts replication for the asset with the migration asset ID.

Specified by:

startAssetReplication in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startMigrationReplication

public StartMigrationReplicationResponse startMigrationReplication(StartMigrationReplicationRequest request)

Description copied from interface: Migration

Starts replication for a migration or for some asset.

Specified by:

startMigrationReplication in interface Migration

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: Migration

Updates the migration.

Specified by:

updateMigration in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateMigrationAsset

public UpdateMigrationAssetResponse updateMigrationAsset(UpdateMigrationAssetRequest request)

Description copied from interface: Migration

Updates the migration asset.

Specified by:

updateMigrationAsset in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateMigrationPlan

public UpdateMigrationPlanResponse updateMigrationPlan(UpdateMigrationPlanRequest request)

Description copied from interface: Migration

Updates the migration plan.

Specified by:

updateMigrationPlan in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateReplicationSchedule

public UpdateReplicationScheduleResponse updateReplicationSchedule(UpdateReplicationScheduleRequest request)

Description copied from interface: Migration

Updates the replication schedule.

Specified by:

updateReplicationSchedule in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateTargetAsset

public UpdateTargetAssetResponse updateTargetAsset(UpdateTargetAssetRequest request)

Description copied from interface: Migration

Updates the target asset.

Specified by:

updateTargetAsset in interface Migration

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public MigrationWaiters getWaiters()

Description copied from interface: Migration

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface Migration

Returns:

The service waiters.

getPaginators

public MigrationPaginators getPaginators()

Description copied from interface: Migration

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 interface Migration

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 use

requiredParametersMap - 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 backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()