LockboxClientCompositeOperations¶
-
class
oci.lockbox.
LockboxClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
LockboxClient
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 LockboxClientCompositeOperations object create_access_request_and_wait_for_state
(…)Calls create_access_request()
and waits for theWorkRequest
to enter the given state(s).create_approval_template_and_wait_for_state
(…)Calls create_approval_template()
and waits for theApprovalTemplate
acted upon to enter the given state(s).create_lockbox_and_wait_for_state
(…[, …])Calls create_lockbox()
and waits for theLockbox
acted upon to enter the given state(s).delete_approval_template_and_wait_for_state
(…)Calls delete_approval_template()
and waits for theApprovalTemplate
acted upon to enter the given state(s).delete_lockbox_and_wait_for_state
(lockbox_id)Calls delete_lockbox()
and waits for theLockbox
acted upon to enter the given state(s).handle_access_request_and_wait_for_state
(…)Calls handle_access_request()
and waits for theWorkRequest
to enter the given state(s).update_approval_template_and_wait_for_state
(…)Calls update_approval_template()
and waits for theApprovalTemplate
acted upon to enter the given state(s).update_lockbox_and_wait_for_state
(…[, …])Calls update_lockbox()
and waits for theLockbox
acted upon to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new LockboxClientCompositeOperations object
Parameters: client (LockboxClient) – The service client which will be wrapped by this object
-
create_access_request_and_wait_for_state
(create_access_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_access_request()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_access_request_details (oci.lockbox.models.CreateAccessRequestDetails) – (required) Details for the new access request.
- 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_access_request()
- 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
-
create_approval_template_and_wait_for_state
(create_approval_template_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_approval_template()
and waits for theApprovalTemplate
acted upon to enter the given state(s).Parameters: - create_approval_template_details (oci.lockbox.models.CreateApprovalTemplateDetails) – (required) Details for the new approval template.
- 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_approval_template()
- 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
-
create_lockbox_and_wait_for_state
(create_lockbox_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_lockbox()
and waits for theLockbox
acted upon to enter the given state(s).Parameters: - create_lockbox_details (oci.lockbox.models.CreateLockboxDetails) – (required) Details for the new Lockbox.
- 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_lockbox()
- 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
-
delete_approval_template_and_wait_for_state
(approval_template_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_approval_template()
and waits for theApprovalTemplate
acted upon to enter the given state(s).Parameters: - approval_template_id (str) – (required) The unique identifier (OCID) of the approval template.
- 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
delete_approval_template()
- 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
-
delete_lockbox_and_wait_for_state
(lockbox_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_lockbox()
and waits for theLockbox
acted upon to enter the given state(s).Parameters: - lockbox_id (str) – (required) unique Lockbox identifier
- 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
delete_lockbox()
- 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
-
handle_access_request_and_wait_for_state
(access_request_id, handle_access_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
handle_access_request()
and waits for theWorkRequest
to enter the given state(s).Parameters: - access_request_id (str) – (required) The unique identifier (OCID) of the access request.
- handle_access_request_details (oci.lockbox.models.HandleAccessRequestDetails) – (required) The details of handling access request
- 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
handle_access_request()
- 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_approval_template_and_wait_for_state
(approval_template_id, update_approval_template_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_approval_template()
and waits for theApprovalTemplate
acted upon to enter the given state(s).Parameters: - approval_template_id (str) – (required) The unique identifier (OCID) of the approval template.
- update_approval_template_details (oci.lockbox.models.UpdateApprovalTemplateDetails) – (required) The information to be updated.
- 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_approval_template()
- 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_lockbox_and_wait_for_state
(lockbox_id, update_lockbox_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_lockbox()
and waits for theLockbox
acted upon to enter the given state(s).Parameters: - lockbox_id (str) – (required) unique Lockbox identifier
- update_lockbox_details (oci.lockbox.models.UpdateLockboxDetails) – (required) The information to be updated.
- 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_lockbox()
- 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
-