OciCacheBackupClientCompositeOperations

class oci.redis.OciCacheBackupClientCompositeOperations(client, work_request_clients=None, **kwargs)

This class provides a wrapper around OciCacheBackupClient 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 functionality

Methods

__init__(client[, work_request_clients]) Creates a new OciCacheBackupClientCompositeOperations object
change_oci_cache_backup_compartment_and_wait_for_state(…) Calls change_oci_cache_backup_compartment() and waits for the WorkRequest to enter the given state(s).
create_oci_cache_backup_and_wait_for_state(…) Calls create_oci_cache_backup() and waits for the WorkRequest to enter the given state(s).
delete_oci_cache_backup_and_wait_for_state(…) Calls delete_oci_cache_backup() and waits for the WorkRequest to enter the given state(s).
export_oci_cache_backup_to_object_storage_and_wait_for_state(…) Calls export_oci_cache_backup_to_object_storage() and waits for the WorkRequest to enter the given state(s).
update_oci_cache_backup_and_wait_for_state(…) Calls update_oci_cache_backup() and waits for the WorkRequest to enter the given state(s).
__init__(client, work_request_clients=None, **kwargs)

Creates a new OciCacheBackupClientCompositeOperations object

Parameters:
  • client (OciCacheBackupClient) – 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.

change_oci_cache_backup_compartment_and_wait_for_state(oci_cache_backup_id, change_oci_cache_backup_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_oci_cache_backup_compartment() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • oci_cache_backup_id (str) – (required) Unique OCI Cache Backup identifier.
  • change_oci_cache_backup_compartment_details (oci.redis.models.ChangeOciCacheBackupCompartmentDetails) – (required) The information to be updated.
  • 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_oci_cache_backup_compartment()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_oci_cache_backup_and_wait_for_state(create_oci_cache_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_oci_cache_backup() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • create_oci_cache_backup_details (oci.redis.models.CreateOciCacheBackupDetails) – (required) Details for the new OCI Cache 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 create_oci_cache_backup()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_oci_cache_backup_and_wait_for_state(oci_cache_backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_oci_cache_backup() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • oci_cache_backup_id (str) – (required) Unique OCI Cache Backup identifier.
  • 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_oci_cache_backup()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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
export_oci_cache_backup_to_object_storage_and_wait_for_state(oci_cache_backup_id, export_oci_cache_backup_to_object_storage_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls export_oci_cache_backup_to_object_storage() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • oci_cache_backup_id (str) – (required) Unique OCI Cache Backup identifier.
  • export_oci_cache_backup_to_object_storage_details (oci.redis.models.ExportOciCacheBackupToObjectStorageDetails) – (required) The destination Object Storage information for the export.
  • 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 export_oci_cache_backup_to_object_storage()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_oci_cache_backup_and_wait_for_state(oci_cache_backup_id, update_oci_cache_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_oci_cache_backup() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • oci_cache_backup_id (str) – (required) Unique OCI Cache Backup identifier.
  • update_oci_cache_backup_details (oci.redis.models.UpdateOciCacheBackupDetails) – (required) The information to be updated.
  • 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_oci_cache_backup()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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