DbBackupsClientCompositeOperations¶
- class oci.mysql.DbBackupsClientCompositeOperations(client, work_request_clients=None, **kwargs)¶
This class provides a wrapper around
DbBackupsClientand 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[, work_request_clients])Creates a new DbBackupsClientCompositeOperations object
Calls
cancel_backup_deletion()and waits for theWorkRequestto enter the given state(s).Calls
change_backup_compartment()and waits for theWorkRequestto enter the given state(s).copy_backup_and_wait_for_state(...[, ...])Calls
copy_backup()and waits for theWorkRequestto enter the given state(s).create_backup_and_wait_for_state(...[, ...])Calls
create_backup()and waits for theWorkRequestto enter the given state(s).delete_backup_and_wait_for_state(backup_id)Calls
delete_backup()and waits for theWorkRequestto enter the given state(s).export_backup_and_wait_for_state(backup_id, ...)Calls
export_backup()and waits for theWorkRequestto enter the given state(s).update_backup_and_wait_for_state(backup_id, ...)Calls
update_backup()and waits for theBackupacted upon to enter the given state(s).validate_backup_and_wait_for_state(backup_id)Calls
validate_backup()and waits for theWorkRequestto enter the given state(s).- __init__(client, work_request_clients=None, **kwargs)¶
Creates a new DbBackupsClientCompositeOperations object
- Parameters
client (DbBackupsClient) – The service client which will be wrapped by this object
work_request_clients (dict) –
(optional) Service-local clients keyed by generated client class name, for example
{'WorkRequestClient': work_request_client}. By default, regional clients are created when needed using the wrapped client’s signer, endpoint and constructor options.Automatically created work-request clients are cached. Before each wait, their endpoint and signer are refreshed from the wrapped client; other client settings and HTTP session changes are not synchronized. Do not modify the wrapped client’s endpoint or signer while a wait is in progress.
Supply a client for non-regional endpoints or customized HTTP sessions. These clients are separate from the shared Work Requests service.
- cancel_backup_deletion_and_wait_for_state(backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
cancel_backup_deletion()and waits for theWorkRequestto 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
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
cancel_backup_deletion()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- 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 theWorkRequestto 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
statusoperation_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_secondsormax_interval_secondsas 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 theWorkRequestto 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
statusoperation_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_secondsormax_interval_secondsas 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 theWorkRequestto 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
statusoperation_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_secondsormax_interval_secondsas 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 theWorkRequestto 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
statusoperation_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_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- export_backup_and_wait_for_state(backup_id, export_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
export_backup()and waits for theWorkRequestto enter the given state(s).- Parameters
backup_id (str) – (required) The OCID of the Backup
export_backup_details (oci.mysql.models.ExportBackupDetails) – (required) Details required to export a given DB system backup to an Object Storage bucket.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
export_backup()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas 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 theBackupacted 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_stateoperation_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_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- validate_backup_and_wait_for_state(backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
validate_backup()and waits for theWorkRequestto 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
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
validate_backup()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait