DatabaseRecoveryClientCompositeOperations¶
- class oci.recovery.DatabaseRecoveryClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
DatabaseRecoveryClientand 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 DatabaseRecoveryClientCompositeOperations object
Calls
cancel_long_term_backup()and waits for theWorkRequestto enter the given state(s).change_protected_database_compartment_and_wait_for_state(...)Calls
change_protected_database_compartment()and waits for theWorkRequestto enter the given state(s).change_protected_database_subscription_and_wait_for_state(...)Calls
change_protected_database_subscription()and waits for theWorkRequestto enter the given state(s).change_protection_policy_compartment_and_wait_for_state(...)Calls
change_protection_policy_compartment()and waits for theWorkRequestto enter the given state(s).change_recovery_service_subnet_compartment_and_wait_for_state(...)Calls
change_recovery_service_subnet_compartment()and waits for theWorkRequestto enter the given state(s).Calls
create_long_term_backup()and waits for theWorkRequestto enter the given state(s).Calls
create_protected_database()and waits for theWorkRequestto enter the given state(s).Calls
create_protection_policy()and waits for theWorkRequestto enter the given state(s).Calls
create_recovery_service_subnet()and waits for theWorkRequestto enter the given state(s).Calls
delete_long_term_backup()and waits for theWorkRequestto enter the given state(s).Calls
delete_protected_database()and waits for theWorkRequestto enter the given state(s).Calls
delete_protection_policy()and waits for theWorkRequestto enter the given state(s).Calls
delete_recovery_service_subnet()and waits for theWorkRequestto enter the given state(s).schedule_protected_database_deletion_and_wait_for_state(...)Calls
schedule_protected_database_deletion()and waits for theWorkRequestto enter the given state(s).Calls
update_long_term_backup()and waits for theWorkRequestto enter the given state(s).Calls
update_protected_database()and waits for theWorkRequestto enter the given state(s).Calls
update_protection_policy()and waits for theWorkRequestto enter the given state(s).Calls
update_recovery_service_subnet()and waits for theWorkRequestto enter the given state(s).- __init__(client, **kwargs)¶
Creates a new DatabaseRecoveryClientCompositeOperations object
- Parameters
client (DatabaseRecoveryClient) – The service client which will be wrapped by this object
- cancel_long_term_backup_and_wait_for_state(long_term_backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
cancel_long_term_backup()and waits for theWorkRequestto enter the given state(s).- Parameters
long_term_backup_id (str) – (required) The long term backup OCID.
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_long_term_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
- change_protected_database_compartment_and_wait_for_state(protected_database_id, change_protected_database_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_protected_database_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
protected_database_id (str) – (required) The protected database OCID.
change_protected_database_compartment_details (oci.recovery.models.ChangeProtectedDatabaseCompartmentDetails) – (required) The configuration details required to move a protected database from the existing compartment to a specified compartment.
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_protected_database_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
- change_protected_database_subscription_and_wait_for_state(protected_database_id, change_protected_database_subscription_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_protected_database_subscription()and waits for theWorkRequestto enter the given state(s).- Parameters
protected_database_id (str) – (required) The protected database OCID.
change_protected_database_subscription_details (oci.recovery.models.ChangeProtectedDatabaseSubscriptionDetails) – (required) Associate a protected database with a different subscription.
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_protected_database_subscription()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_protection_policy_compartment_and_wait_for_state(protection_policy_id, change_protection_policy_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_protection_policy_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
protection_policy_id (str) – (required) The protection policy OCID.
change_protection_policy_compartment_details (oci.recovery.models.ChangeProtectionPolicyCompartmentDetails) – (required) The configuration details required to move a protection policy from the existing compartment to a specified compartment.
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_protection_policy_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
- change_recovery_service_subnet_compartment_and_wait_for_state(recovery_service_subnet_id, change_recovery_service_subnet_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_recovery_service_subnet_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
recovery_service_subnet_id (str) – (required) The recovery service subnet OCID.
change_recovery_service_subnet_compartment_details (oci.recovery.models.ChangeRecoveryServiceSubnetCompartmentDetails) – (required) The configuration details required to move a Recovery Service subnet from the existing compartment to a specified compartment.
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_recovery_service_subnet_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
- create_long_term_backup_and_wait_for_state(create_long_term_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_long_term_backup()and waits for theWorkRequestto enter the given state(s).- Parameters
create_long_term_backup_details (oci.recovery.models.CreateLongTermBackupDetails) – (required) Describes the parameters required to create a long term backup for a protected database.
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_long_term_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_protected_database_and_wait_for_state(create_protected_database_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_protected_database()and waits for theWorkRequestto enter the given state(s).- Parameters
create_protected_database_details (oci.recovery.models.CreateProtectedDatabaseDetails) – (required) Describes the parameters required to create a protected database.
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_protected_database()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_protection_policy_and_wait_for_state(create_protection_policy_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_protection_policy()and waits for theWorkRequestto enter the given state(s).- Parameters
create_protection_policy_details (oci.recovery.models.CreateProtectionPolicyDetails) – (required) Describes the parameters required to create a custom protection policy.
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_protection_policy()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_recovery_service_subnet_and_wait_for_state(create_recovery_service_subnet_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_recovery_service_subnet()and waits for theWorkRequestto enter the given state(s).- Parameters
create_recovery_service_subnet_details (oci.recovery.models.CreateRecoveryServiceSubnetDetails) – (required) Describes the parameters required to create a recovery service subnet.
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_recovery_service_subnet()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_long_term_backup_and_wait_for_state(long_term_backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_long_term_backup()and waits for theWorkRequestto enter the given state(s).- Parameters
long_term_backup_id (str) – (required) The long term backup OCID.
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_long_term_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_protected_database_and_wait_for_state(protected_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_protected_database()and waits for theWorkRequestto enter the given state(s).- Parameters
protected_database_id (str) – (required) The protected database OCID.
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_protected_database()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_protection_policy_and_wait_for_state(protection_policy_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_protection_policy()and waits for theWorkRequestto enter the given state(s).- Parameters
protection_policy_id (str) – (required) The protection policy OCID.
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_protection_policy()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_recovery_service_subnet_and_wait_for_state(recovery_service_subnet_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_recovery_service_subnet()and waits for theWorkRequestto enter the given state(s).- Parameters
recovery_service_subnet_id (str) – (required) The recovery service subnet OCID.
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_recovery_service_subnet()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
- schedule_protected_database_deletion_and_wait_for_state(protected_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
schedule_protected_database_deletion()and waits for theWorkRequestto enter the given state(s).- Parameters
protected_database_id (str) – (required) The protected database OCID.
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
schedule_protected_database_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
- update_long_term_backup_and_wait_for_state(long_term_backup_id, update_long_term_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_long_term_backup()and waits for theWorkRequestto enter the given state(s).- Parameters
long_term_backup_id (str) – (required) The long term backup OCID.
update_long_term_backup_details (oci.recovery.models.UpdateLongTermBackupDetails) – (required) The information to be updated.
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
update_long_term_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_protected_database_and_wait_for_state(protected_database_id, update_protected_database_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_protected_database()and waits for theWorkRequestto enter the given state(s).- Parameters
protected_database_id (str) – (required) The protected database OCID.
update_protected_database_details (oci.recovery.models.UpdateProtectedDatabaseDetails) – (required) Describes the parameters required to update a protected database.
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
update_protected_database()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_protection_policy_and_wait_for_state(protection_policy_id, update_protection_policy_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_protection_policy()and waits for theWorkRequestto enter the given state(s).- Parameters
protection_policy_id (str) – (required) The protection policy OCID.
update_protection_policy_details (oci.recovery.models.UpdateProtectionPolicyDetails) – (required) The information to be updated.
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
update_protection_policy()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_recovery_service_subnet_and_wait_for_state(recovery_service_subnet_id, update_recovery_service_subnet_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_recovery_service_subnet()and waits for theWorkRequestto enter the given state(s).- Parameters
recovery_service_subnet_id (str) – (required) The recovery service subnet OCID.
update_recovery_service_subnet_details (oci.recovery.models.UpdateRecoveryServiceSubnetDetails) – (required) Describes the parameters required to update a recovery service subnet.
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
update_recovery_service_subnet()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