MonitoringClientCompositeOperations

class oci.monitoring.MonitoringClientCompositeOperations(client, **kwargs)

This class provides a wrapper around MonitoringClient 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 MonitoringClientCompositeOperations object
create_alarm_and_wait_for_state(…[, …])	Calls create_alarm() and waits for the Alarm acted upon to enter the given state(s).
delete_alarm_and_wait_for_state(alarm_id[, …])	Calls delete_alarm() and waits for the Alarm acted upon to enter the given state(s).
update_alarm_and_wait_for_state(alarm_id, …)	Calls update_alarm() and waits for the Alarm acted upon to enter the given state(s).

__init__(client, **kwargs)

Creates a new MonitoringClientCompositeOperations object

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

create_alarm_and_wait_for_state(create_alarm_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_alarm() and waits for the Alarm acted upon to enter the given state(s).

Parameters:

• create_alarm_details (oci.monitoring.models.CreateAlarmDetails) – (required) Document for creating an alarm.
• 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_alarm()
• 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_alarm_and_wait_for_state(alarm_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_alarm() and waits for the Alarm acted upon to enter the given state(s).

Parameters:

• alarm_id (str) –

  (required) The OCID of an alarm.

• 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_alarm()
• 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_alarm_and_wait_for_state(alarm_id, update_alarm_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_alarm() and waits for the Alarm acted upon to enter the given state(s).

Parameters:

• alarm_id (str) –

  (required) The OCID of an alarm.

• update_alarm_details (oci.monitoring.models.UpdateAlarmDetails) – (required) Document for updating an alarm.
• 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_alarm()
• 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