DbBackupsClientCompositeOperations¶
-
class
oci.mysql.
DbBackupsClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
DbBackupsClient
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 DbBackupsClientCompositeOperations object change_backup_compartment_and_wait_for_state
(…)Calls change_backup_compartment()
and waits for theWorkRequest
to enter the given state(s).copy_backup_and_wait_for_state
(…[, …])Calls copy_backup()
and waits for theWorkRequest
to enter the given state(s).create_backup_and_wait_for_state
(…[, …])Calls create_backup()
and waits for theWorkRequest
to enter the given state(s).delete_backup_and_wait_for_state
(backup_id)Calls delete_backup()
and waits for theWorkRequest
to enter the given state(s).update_backup_and_wait_for_state
(backup_id, …)Calls update_backup()
and waits for theBackup
acted upon to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new DbBackupsClientCompositeOperations object
Parameters: client (DbBackupsClient) – The service client which will be wrapped by this object
-
change_backup_compartment_and_wait_for_state
(backup_id, change_backup_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_backup_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - backup_id (str) – (required) The OCID of the Backup
- change_backup_compartment_details (oci.mysql.models.ChangeBackupCompartmentDetails) – (required) Target compartment for a DB System Backup.
- 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
change_backup_compartment()
- 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
-
copy_backup_and_wait_for_state
(copy_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
copy_backup()
and waits for theWorkRequest
to enter the given state(s).Parameters: - copy_backup_details (oci.mysql.models.CopyBackupDetails) – (required) Details required to copy a given DB system backup to another region.
- 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
copy_backup()
- 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_backup_and_wait_for_state
(create_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_backup()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_backup_details (oci.mysql.models.CreateBackupDetails) – (required) Create a Backup of a DB System.
- 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_backup()
- 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_backup_and_wait_for_state
(backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_backup()
and waits for theWorkRequest
to enter the given state(s).Parameters: - backup_id (str) – (required) The OCID of the Backup
- 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_backup()
- 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_backup_and_wait_for_state
(backup_id, update_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_backup()
and waits for theBackup
acted upon to enter the given state(s).Parameters: - backup_id (str) – (required) The OCID of the Backup
- update_backup_details (oci.mysql.models.UpdateBackupDetails) – (required) Request to update a Backup’s metadata.
- 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_backup()
- 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
-