OpensearchClusterBackupClientCompositeOperations¶
-
class
oci.opensearch.
OpensearchClusterBackupClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
OpensearchClusterBackupClient
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 OpensearchClusterBackupClientCompositeOperations object delete_opensearch_cluster_backup_and_wait_for_state
(…)Calls delete_opensearch_cluster_backup()
and waits for theWorkRequest
to enter the given state(s).update_opensearch_cluster_backup_and_wait_for_state
(…)Calls update_opensearch_cluster_backup()
and waits for theWorkRequest
to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new OpensearchClusterBackupClientCompositeOperations object
Parameters: client (OpensearchClusterBackupClient) – The service client which will be wrapped by this object
-
delete_opensearch_cluster_backup_and_wait_for_state
(opensearch_cluster_backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_opensearch_cluster_backup()
and waits for theWorkRequest
to enter the given state(s).Parameters: - opensearch_cluster_backup_id (str) – (required) unique OpensearchClusterBackup 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_opensearch_cluster_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_opensearch_cluster_backup_and_wait_for_state
(opensearch_cluster_backup_id, update_opensearch_cluster_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_opensearch_cluster_backup()
and waits for theWorkRequest
to enter the given state(s).Parameters: - opensearch_cluster_backup_id (str) – (required) unique OpensearchClusterBackup identifier
- update_opensearch_cluster_backup_details (oci.opensearch.models.UpdateOpensearchClusterBackupDetails) – (required) Update the opensearch cluster backup details.
- 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_opensearch_cluster_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
-