VaultsClientCompositeOperations¶
-
class
oci.vault.VaultsClientCompositeOperations(client, **kwargs)¶ This class provides a wrapper around
VaultsClientand 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 VaultsClientCompositeOperations object create_secret_and_wait_for_state(…[, …])Calls create_secret()and waits for theSecretacted upon to enter the given state(s).rotate_secret_and_wait_for_work_request(…)Calls rotate_secret()and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).update_secret_and_wait_for_state(secret_id, …)Calls update_secret()and waits for theSecretacted upon to enter the given state(s).-
__init__(client, **kwargs)¶ Creates a new VaultsClientCompositeOperations object
Parameters: client (VaultsClient) – The service client which will be wrapped by this object
-
create_secret_and_wait_for_state(create_secret_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_secret()and waits for theSecretacted upon to enter the given state(s).Parameters: - create_secret_details (oci.vault.models.CreateSecretDetails) – (required) Request to create a new secret.
- 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
create_secret() - 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
-
rotate_secret_and_wait_for_work_request(secret_id, work_request_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
rotate_secret()and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).Parameters: - secret_id (str) – (required) The OCID of the secret.
- work_request_states (list[str]) – (optional)
An array of work requests states to wait on. These should be valid values for
statusDefault values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED] - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
rotate_secret() - 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_secret_and_wait_for_state(secret_id, update_secret_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_secret()and waits for theSecretacted upon to enter the given state(s).Parameters: - secret_id (str) – (required) The OCID of the secret.
- update_secret_details (oci.vault.models.UpdateSecretDetails) – (required) Request to update a secret.
- 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_secret() - 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
-