abacusai.monitor_alert
Module Contents
Classes
A Monitor Alert |
- class abacusai.monitor_alert.MonitorAlert(client, name=None, monitorAlertId=None, createdAt=None, projectId=None, modelMonitorId=None, conditionConfig=None, actionConfig=None, conditionDescription=None, actionDescription=None, latestMonitorAlertVersion={})
Bases:
abacusai.return_class.AbstractApiClass
A Monitor Alert
- Parameters:
client (ApiClient) – An authenticated API Client instance
name (str) – The user-friendly name for the alert.
monitorAlertId (str) – The unique identifier of the monitor alert.
createdAt (str) – Date and time at which the monitor alert was created.
projectId (str) – The project this alert belongs to.
modelMonitorId (str) – The monitor id that this alert is associated with
conditionConfig (dict) – The condition configuration for this alert.
actionConfig (dict) – The action configuration for this alert.
conditionDescription (str) – User friendly description of the condition
actionDescription (str) – User friendly description of the action
latestMonitorAlertVersion (MonitorAlertVersion) – The latest monitor alert version.
- __repr__()
Return repr(self).
- to_dict()
Get a dict representation of the parameters in this class
- Returns:
The dict value representation of the class parameters
- Return type:
- update(alert_name=None, condition_config=None, action_config=None)
Update monitor alert
- Parameters:
alert_name (str) – Name of the alert.
condition_config (AlertConditionConfig) – Condition to run the actions for the alert.
action_config (AlertActionConfig) – Configuration for the action of the alert.
- Returns:
Object describing the monitor alert.
- Return type:
- refresh()
Calls describe and refreshes the current object’s fields
- Returns:
The current object
- Return type:
- describe()
Describes a given monitor alert id
- Parameters:
monitor_alert_id (str) – Unique identifier of the monitor alert.
- Returns:
Object containing information about the monitor alert.
- Return type: