EmailClientCompositeOperations

class oci.email.EmailClientCompositeOperations(client, **kwargs)

This class provides a wrapper around EmailClient 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 EmailClientCompositeOperations object
create_sender_and_wait_for_state(…[, …]) Calls create_sender() and waits for the Sender acted upon to enter the given state(s).
delete_sender_and_wait_for_state(sender_id) Calls delete_sender() and waits for the Sender acted upon to enter the given state(s).
update_sender_and_wait_for_state(sender_id, …) Calls update_sender() and waits for the Sender acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new EmailClientCompositeOperations object

Parameters:client (EmailClient) – The service client which will be wrapped by this object
create_sender_and_wait_for_state(create_sender_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_sender() and waits for the Sender acted upon to enter the given state(s).

Parameters:
  • create_sender_details (CreateSenderDetails) – (required) Create a sender.
  • 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_sender()
  • 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
delete_sender_and_wait_for_state(sender_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_sender() and waits for the Sender acted upon to enter the given state(s).

Parameters:
  • sender_id (str) – (required) The unique OCID of the sender.
  • 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_sender()
  • 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_sender_and_wait_for_state(sender_id, update_sender_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_sender() and waits for the Sender acted upon to enter the given state(s).

Parameters:
  • sender_id (str) – (required) The unique OCID of the sender.
  • update_sender_details (UpdateSenderDetails) – (required) update details for sender.
  • 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()
  • 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