abacusai.monitor_alert
======================

.. py:module:: abacusai.monitor_alert


Classes
-------

.. autoapisummary::

   abacusai.monitor_alert.MonitorAlert


Module Contents
---------------

.. py:class:: MonitorAlert(client, name=None, monitorAlertId=None, createdAt=None, projectId=None, modelMonitorId=None, realtimeMonitorId=None, conditionConfig=None, actionConfig=None, conditionDescription=None, actionDescription=None, alertType=None, deploymentId=None, latestMonitorAlertVersion={})

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`


   A Monitor Alert

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param name: The user-friendly name for the alert.
   :type name: str
   :param monitorAlertId: The unique identifier of the monitor alert.
   :type monitorAlertId: str
   :param createdAt: Date and time at which the monitor alert was created.
   :type createdAt: str
   :param projectId: The project this alert belongs to.
   :type projectId: str
   :param modelMonitorId: The monitor id that this alert is associated with
   :type modelMonitorId: str
   :param realtimeMonitorId: The realtime monitor id that this alert is associated with
   :type realtimeMonitorId: str
   :param conditionConfig: The condition configuration for this alert.
   :type conditionConfig: dict
   :param actionConfig: The action configuration for this alert.
   :type actionConfig: dict
   :param conditionDescription: User friendly description of the condition
   :type conditionDescription: str
   :param actionDescription: User friendly description of the action
   :type actionDescription: str
   :param alertType: The type of the alert
   :type alertType: str
   :param deploymentId: The deployment ID this alert is associated with
   :type deploymentId: str
   :param latestMonitorAlertVersion: The latest monitor alert version.
   :type latestMonitorAlertVersion: MonitorAlertVersion


   .. py:attribute:: name
      :value: None



   .. py:attribute:: monitor_alert_id
      :value: None



   .. py:attribute:: created_at
      :value: None



   .. py:attribute:: project_id
      :value: None



   .. py:attribute:: model_monitor_id
      :value: None



   .. py:attribute:: realtime_monitor_id
      :value: None



   .. py:attribute:: condition_config
      :value: None



   .. py:attribute:: action_config
      :value: None



   .. py:attribute:: condition_description
      :value: None



   .. py:attribute:: action_description
      :value: None



   .. py:attribute:: alert_type
      :value: None



   .. py:attribute:: deployment_id
      :value: None



   .. py:attribute:: latest_monitor_alert_version


   .. py:attribute:: deprecated_keys


   .. py:method:: __repr__()


   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict



   .. py:method:: update(alert_name = None, condition_config = None, action_config = None)

      Update monitor alert

      :param alert_name: Name of the alert.
      :type alert_name: str
      :param condition_config: Condition to run the actions for the alert.
      :type condition_config: AlertConditionConfig
      :param action_config: Configuration for the action of the alert.
      :type action_config: AlertActionConfig

      :returns: Object describing the monitor alert.
      :rtype: MonitorAlert



   .. py:method:: refresh()

      Calls describe and refreshes the current object's fields

      :returns: The current object
      :rtype: MonitorAlert



   .. py:method:: describe()

      Describes a given monitor alert id

      :param monitor_alert_id: Unique identifier of the monitor alert.
      :type monitor_alert_id: str

      :returns: Object containing information about the monitor alert.
      :rtype: MonitorAlert



   .. py:method:: run()

      Reruns a given monitor alert from latest monitor instance

      :param monitor_alert_id: Unique identifier of a monitor alert.
      :type monitor_alert_id: str

      :returns: Object describing the monitor alert.
      :rtype: MonitorAlert



   .. py:method:: delete()

      Delets a monitor alert

      :param monitor_alert_id: The unique string identifier of the alert to delete.
      :type monitor_alert_id: str