SenderInvitationClientCompositeOperations¶
-
class
oci.tenant_manager_control_plane.
SenderInvitationClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
SenderInvitationClient
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 SenderInvitationClientCompositeOperations object cancel_sender_invitation_and_wait_for_state
(…)Calls cancel_sender_invitation()
and waits for theWorkRequest
to enter the given state(s).create_sender_invitation_and_wait_for_state
(…)Calls create_sender_invitation()
and waits for theWorkRequest
to enter the given state(s).update_sender_invitation_and_wait_for_state
(…)Calls update_sender_invitation()
and waits for theSenderInvitation
acted upon to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new SenderInvitationClientCompositeOperations object
Parameters: client (SenderInvitationClient) – The service client which will be wrapped by this object
-
cancel_sender_invitation_and_wait_for_state
(sender_invitation_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
cancel_sender_invitation()
and waits for theWorkRequest
to enter the given state(s).Parameters: - sender_invitation_id (str) – (required) OCID of the sender invitation to cancel.
- 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
cancel_sender_invitation()
- 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_sender_invitation_and_wait_for_state
(create_sender_invitation_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_sender_invitation()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_sender_invitation_details (oci.tenant_manager_control_plane.models.CreateSenderInvitationDetails) – (required) Parameters for sender invitation creation.
- 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_sender_invitation()
- 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_sender_invitation_and_wait_for_state
(sender_invitation_id, update_sender_invitation_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_sender_invitation()
and waits for theSenderInvitation
acted upon to enter the given state(s).Parameters: - sender_invitation_id (str) – (required) OCID of the sender invitation to update.
- update_sender_invitation_details (oci.tenant_manager_control_plane.models.UpdateSenderInvitationDetails) – (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_sender_invitation()
- 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
-