KmsVaultClientCompositeOperations

class oci.key_management.KmsVaultClientCompositeOperations(client, **kwargs)

This class provides a wrapper around KmsVaultClient 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, **kwargs)	Creates a new KmsVaultClientCompositeOperations object
backup_vault_and_wait_for_state(vault_id[, …])	Calls backup_vault() and waits for the Vault acted upon to enter the given state(s).
cancel_vault_deletion_and_wait_for_state(…)	Calls cancel_vault_deletion() and waits for the Vault acted upon to enter the given state(s).
create_vault_and_wait_for_state(…[, …])	Calls create_vault() and waits for the Vault acted upon to enter the given state(s).
schedule_vault_deletion_and_wait_for_state(…)	Calls schedule_vault_deletion() and waits for the Vault acted upon to enter the given state(s).
update_vault_and_wait_for_state(vault_id, …)	Calls update_vault() and waits for the Vault acted upon to enter the given state(s).

__init__(client, **kwargs)

Creates a new KmsVaultClientCompositeOperations object

Parameters:client (KmsVaultClient) – The service client which will be wrapped by this object

backup_vault_and_wait_for_state(vault_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls backup_vault() and waits for the Vault acted upon to enter the given state(s).

Parameters:

• vault_id (str) – (required) The OCID of the vault.
• 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 backup_vault()
• 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

cancel_vault_deletion_and_wait_for_state(vault_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls cancel_vault_deletion() and waits for the Vault acted upon to enter the given state(s).

Parameters:

• vault_id (str) – (required) The OCID of the vault.
• 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 cancel_vault_deletion()
• 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_vault_and_wait_for_state(create_vault_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_vault() and waits for the Vault acted upon to enter the given state(s).

Parameters:

• create_vault_details (oci.key_management.models.CreateVaultDetails) – (required) CreateVaultDetails
• 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_vault()
• 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

schedule_vault_deletion_and_wait_for_state(vault_id, schedule_vault_deletion_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls schedule_vault_deletion() and waits for the Vault acted upon to enter the given state(s).

Parameters:

• vault_id (str) – (required) The OCID of the vault.
• schedule_vault_deletion_details (oci.key_management.models.ScheduleVaultDeletionDetails) – (required) ScheduleVaultDeletionDetails
• 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 schedule_vault_deletion()
• 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_vault_and_wait_for_state(vault_id, update_vault_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_vault() and waits for the Vault acted upon to enter the given state(s).

Parameters:

• vault_id (str) – (required) The OCID of the vault.
• update_vault_details (oci.key_management.models.UpdateVaultDetails) – (required) UpdateVaultDetails
• 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_vault()
• 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