EventsClientCompositeOperations

class oci.events.EventsClientCompositeOperations(client, **kwargs)

This class provides a wrapper around EventsClient 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 EventsClientCompositeOperations object
create_rule_and_wait_for_state(…[, …])	Calls create_rule() and waits for the Rule acted upon to enter the given state(s).
delete_rule_and_wait_for_state(rule_id[, …])	Calls delete_rule() and waits for the Rule acted upon to enter the given state(s).
update_rule_and_wait_for_state(rule_id, …)	Calls update_rule() and waits for the Rule acted upon to enter the given state(s).

__init__(client, **kwargs)

Creates a new EventsClientCompositeOperations object

Parameters:client (EventsClient) – The service client which will be wrapped by this object

create_rule_and_wait_for_state(create_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_rule() and waits for the Rule acted upon to enter the given state(s).

Parameters:

• create_rule_details (oci.events.models.CreateRuleDetails) – (required) Specification of the rule to create
• 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_rule()
• 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_rule_and_wait_for_state(rule_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_rule() and waits for the Rule acted upon to enter the given state(s).

Parameters:

• rule_id (str) –

  (required) The OCID of this rule.

• 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_rule()
• 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_rule_and_wait_for_state(rule_id, update_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_rule() and waits for the Rule acted upon to enter the given state(s).

Parameters:

• rule_id (str) –

  (required) The OCID of this rule.

• update_rule_details (oci.events.models.UpdateRuleDetails) – (required) The new rule spec to apply
• 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_rule()
• 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