MonitoringClientCompositeOperations¶
- class oci.monitoring.MonitoringClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
MonitoringClientand 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 MonitoringClientCompositeOperations object
create_alarm_and_wait_for_state(...[, ...])Calls
create_alarm()and waits for theAlarmacted upon to enter the given state(s).Calls
create_alarm_suppression()and waits for theAlarmSuppressionacted upon to enter the given state(s).delete_alarm_and_wait_for_state(alarm_id[, ...])Calls
delete_alarm()and waits for theAlarmacted upon to enter the given state(s).Calls
delete_alarm_suppression()and waits for theAlarmSuppressionacted upon to enter the given state(s).update_alarm_and_wait_for_state(alarm_id, ...)Calls
update_alarm()and waits for theAlarmacted 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 theAlarmacted 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_stateoperation_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 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
- create_alarm_suppression_and_wait_for_state(create_alarm_suppression_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_alarm_suppression()and waits for theAlarmSuppressionacted upon to enter the given state(s).- Parameters
create_alarm_suppression_details (oci.monitoring.models.CreateAlarmSuppressionDetails) – (required) The details of the alarm suppression to be created
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_alarm_suppression()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
- delete_alarm_and_wait_for_state(alarm_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_alarm()and waits for theAlarmacted 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_stateoperation_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 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
- delete_alarm_suppression_and_wait_for_state(alarm_suppression_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_alarm_suppression()and waits for theAlarmSuppressionacted upon to enter the given state(s).- Parameters
alarm_suppression_id (str) –
(required) The OCID of the alarm suppression.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_alarm_suppression()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
- update_alarm_and_wait_for_state(alarm_id, update_alarm_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_alarm()and waits for theAlarmacted 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_stateoperation_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 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