airflow.providers.apprise.notifications.apprise¶
Attributes¶
Classes¶
Apprise BaseNotifier. |
Module Contents¶
- class airflow.providers.apprise.notifications.apprise.AppriseNotifier(*, body, title=None, notify_type=NotifyType.INFO, body_format=NotifyFormat.TEXT, tag='all', attach=None, interpret_escapes=None, config=None, apprise_conn_id=AppriseHook.default_conn_name)[source]¶
Bases:
airflow.providers.common.compat.notifier.BaseNotifier
Apprise BaseNotifier.
- Parameters:
body (str) – Specify the message body
title (str | None) – Specify the message title. This field is complete optional
notify_type (apprise.NotifyType) – Specify the message type (default=info). Possible values are “info”, “success”, “failure”, and “warning”
body_format (apprise.NotifyFormat) – Specify the input message format (default=text). Possible values are “text”, “html”, and “markdown”.
tag (str | collections.abc.Iterable[str]) – Specify one or more tags to filter which services to notify
attach (str | None) – Specify one or more file attachment locations
interpret_escapes (bool | None) – Enable interpretation of backslash escapes. For example, this would convert sequences such as n and r to their respected ascii new-line and carriage
config (apprise.AppriseConfig | None) – Specify one or more configuration
apprise_conn_id (str) – connection that has Apprise configs setup
- property hook: airflow.providers.apprise.hooks.apprise.AppriseHook[source]¶
Apprise Hook.