EventClientCompositeOperations¶
-
class
oci.os_management_hub.EventClientCompositeOperations(client, **kwargs)¶ This class provides a wrapper around
EventClientand 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 EventClientCompositeOperations object delete_event_and_wait_for_state(event_id[, …])Calls delete_event()and waits for theWorkRequestto enter the given state(s).import_event_content_and_wait_for_state(event_id)Calls import_event_content()and waits for theWorkRequestto enter the given state(s).update_event_and_wait_for_state(event_id, …)Calls update_event()and waits for theEventacted upon to enter the given state(s).-
__init__(client, **kwargs)¶ Creates a new EventClientCompositeOperations object
Parameters: client (EventClient) – The service client which will be wrapped by this object
-
delete_event_and_wait_for_state(event_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_event()and waits for theWorkRequestto enter the given state(s).Parameters: - event_id (str) –
(required) The OCID of the event.
- 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
delete_event() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- event_id (str) –
-
import_event_content_and_wait_for_state(event_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
import_event_content()and waits for theWorkRequestto enter the given state(s).Parameters: - event_id (str) –
(required) The OCID of the event.
- 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
import_event_content() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- event_id (str) –
-
update_event_and_wait_for_state(event_id, update_event_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_event()and waits for theEventacted upon to enter the given state(s).Parameters: - event_id (str) –
(required) The OCID of the event.
- update_event_details (oci.os_management_hub.models.UpdateEventDetails) – (required) Provides the information used to update the event tags.
- 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_event() - waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- event_id (str) –
-