RecipientInvitationClientCompositeOperations¶
-
class
oci.tenant_manager_control_plane.
RecipientInvitationClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
RecipientInvitationClient
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 RecipientInvitationClientCompositeOperations object accept_recipient_invitation_and_wait_for_state
(…)Calls accept_recipient_invitation()
and waits for theWorkRequest
to enter the given state(s).ignore_recipient_invitation_and_wait_for_state
(…)Calls ignore_recipient_invitation()
and waits for theRecipientInvitation
acted upon to enter the given state(s).update_recipient_invitation_and_wait_for_state
(…)Calls update_recipient_invitation()
and waits for theRecipientInvitation
acted upon to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new RecipientInvitationClientCompositeOperations object
Parameters: client (RecipientInvitationClient) – The service client which will be wrapped by this object
-
accept_recipient_invitation_and_wait_for_state
(recipient_invitation_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
accept_recipient_invitation()
and waits for theWorkRequest
to enter the given state(s).Parameters: - recipient_invitation_id (str) – (required) OCID of recipient invitation to accept.
- 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
accept_recipient_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
-
ignore_recipient_invitation_and_wait_for_state
(recipient_invitation_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
ignore_recipient_invitation()
and waits for theRecipientInvitation
acted upon to enter the given state(s).Parameters: - recipient_invitation_id (str) – (required) OCID of recipient invitation to ignore.
- 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
ignore_recipient_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_recipient_invitation_and_wait_for_state
(recipient_invitation_id, update_recipient_invitation_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_recipient_invitation()
and waits for theRecipientInvitation
acted upon to enter the given state(s).Parameters: - recipient_invitation_id (str) – (required) OCID of the recipient invitation to update.
- update_recipient_invitation_details (oci.tenant_manager_control_plane.models.UpdateRecipientInvitationDetails) – (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_recipient_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
-