DatabaseMigrationClientCompositeOperations¶
-
class
oci.database_migration.
DatabaseMigrationClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
DatabaseMigrationClient
and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionalityMethods
__init__
(client, **kwargs)Creates a new DatabaseMigrationClientCompositeOperations object abort_job_and_wait_for_state
(job_id[, …])Calls abort_job()
and waits for theJob
acted upon to enter the given state(s).clone_migration_and_wait_for_state
(…[, …])Calls clone_migration()
and waits for theWorkRequest
to enter the given state(s).create_connection_and_wait_for_state
(…[, …])Calls create_connection()
and waits for theWorkRequest
to enter the given state(s).create_migration_and_wait_for_state
(…[, …])Calls create_migration()
and waits for theWorkRequest
to enter the given state(s).create_parameter_file_version_and_wait_for_state
(…)Calls create_parameter_file_version()
and waits for theWorkRequest
to enter the given state(s).delete_connection_and_wait_for_state
(…[, …])Calls delete_connection()
and waits for theWorkRequest
to enter the given state(s).delete_job_and_wait_for_state
(job_id[, …])Calls delete_job()
and waits for theJob
acted upon to enter the given state(s).delete_migration_and_wait_for_state
(migration_id)Calls delete_migration()
and waits for theWorkRequest
to enter the given state(s).delete_parameter_file_version_and_wait_for_state
(…)Calls delete_parameter_file_version()
and waits for theWorkRequest
to enter the given state(s).evaluate_migration_and_wait_for_state
(…[, …])Calls evaluate_migration()
and waits for theWorkRequest
to enter the given state(s).make_current_parameter_file_version_and_wait_for_state
(…)Calls make_current_parameter_file_version()
and waits for theJob
acted upon to enter the given state(s).resume_job_and_wait_for_state
(job_id[, …])Calls resume_job()
and waits for theJob
acted upon to enter the given state(s).start_migration_and_wait_for_state
(migration_id)Calls start_migration()
and waits for theWorkRequest
to enter the given state(s).suspend_job_and_wait_for_state
(job_id[, …])Calls suspend_job()
and waits for theJob
acted upon to enter the given state(s).update_connection_and_wait_for_state
(…[, …])Calls update_connection()
and waits for theWorkRequest
to enter the given state(s).update_job_and_wait_for_state
(job_id, …[, …])Calls update_job()
and waits for theJob
acted upon to enter the given state(s).update_migration_and_wait_for_state
(…[, …])Calls update_migration()
and waits for theWorkRequest
to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new DatabaseMigrationClientCompositeOperations object
Parameters: client (DatabaseMigrationClient) – The service client which will be wrapped by this object
-
abort_job_and_wait_for_state
(job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
abort_job()
and waits for theJob
acted upon to enter the given state(s).Parameters: - job_id (str) – (required) The OCID of the job
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
abort_job()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
clone_migration_and_wait_for_state
(migration_id, clone_migration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
clone_migration()
and waits for theWorkRequest
to enter the given state(s).Parameters: - migration_id (str) – (required) The OCID of the migration
- clone_migration_details (oci.database_migration.models.CloneMigrationDetails) – (required) Clone Migration properties.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
clone_migration()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
create_connection_and_wait_for_state
(create_connection_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_connection()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_connection_details (oci.database_migration.models.CreateConnectionDetails) – (required) Database Connection properties.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_connection()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
create_migration_and_wait_for_state
(create_migration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_migration()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_migration_details (oci.database_migration.models.CreateMigrationDetails) – (required) Migration properties.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_migration()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
create_parameter_file_version_and_wait_for_state
(job_id, create_parameter_file_version_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_parameter_file_version()
and waits for theWorkRequest
to enter the given state(s).Parameters: - job_id (str) – (required) The OCID of the job
- create_parameter_file_version_details (oci.database_migration.models.CreateParameterFileVersionDetails) – (required) The parameter file version details to be created
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_parameter_file_version()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
delete_connection_and_wait_for_state
(connection_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_connection()
and waits for theWorkRequest
to enter the given state(s).Parameters: - connection_id (str) – (required) The OCID of the database connection.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_connection()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
delete_job_and_wait_for_state
(job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_job()
and waits for theJob
acted upon to enter the given state(s).Parameters: - job_id (str) – (required) The OCID of the job
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_job()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
delete_migration_and_wait_for_state
(migration_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_migration()
and waits for theWorkRequest
to enter the given state(s).Parameters: - migration_id (str) – (required) The OCID of the migration
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_migration()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
delete_parameter_file_version_and_wait_for_state
(job_id, parameter_file_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_parameter_file_version()
and waits for theWorkRequest
to enter the given state(s).Parameters: - job_id (str) – (required) The OCID of the job
- parameter_file_name (str) – (required) A unique name associated with the current migration/job and extract/replicat name
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_parameter_file_version()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
evaluate_migration_and_wait_for_state
(migration_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
evaluate_migration()
and waits for theWorkRequest
to enter the given state(s).Parameters: - migration_id (str) – (required) The OCID of the migration
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
evaluate_migration()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
make_current_parameter_file_version_and_wait_for_state
(job_id, parameter_file_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
make_current_parameter_file_version()
and waits for theJob
acted upon to enter the given state(s).Parameters: - job_id (str) – (required) The OCID of the job
- parameter_file_name (str) – (required) A unique name associated with the current migration/job and extract/replicat name
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
make_current_parameter_file_version()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
resume_job_and_wait_for_state
(job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
resume_job()
and waits for theJob
acted upon to enter the given state(s).Parameters: - job_id (str) – (required) The OCID of the job
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
resume_job()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
start_migration_and_wait_for_state
(migration_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
start_migration()
and waits for theWorkRequest
to enter the given state(s).Parameters: - migration_id (str) – (required) The OCID of the migration
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
start_migration()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
suspend_job_and_wait_for_state
(job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
suspend_job()
and waits for theJob
acted upon to enter the given state(s).Parameters: - job_id (str) – (required) The OCID of the job
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
suspend_job()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
update_connection_and_wait_for_state
(connection_id, update_connection_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_connection()
and waits for theWorkRequest
to enter the given state(s).Parameters: - connection_id (str) – (required) The OCID of the database connection.
- update_connection_details (oci.database_migration.models.UpdateConnectionDetails) – (required) Database Connection properties.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_connection()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
update_job_and_wait_for_state
(job_id, update_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_job()
and waits for theJob
acted upon to enter the given state(s).Parameters: - job_id (str) – (required) The OCID of the job
- update_job_details (oci.database_migration.models.UpdateJobDetails) – (required) Migration Job properties.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_job()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
update_migration_and_wait_for_state
(migration_id, update_migration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_migration()
and waits for theWorkRequest
to enter the given state(s).Parameters: - migration_id (str) – (required) The OCID of the migration
- update_migration_details (oci.database_migration.models.UpdateMigrationDetails) – (required) Migration properties.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_migration()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-