airflow.providers.slack.operators.slack_webhook¶

类¶

SlackWebhookOperator

此操作符允许您使用 Incoming Webhook 向 Slack 发送消息。

模块内容¶

class airflow.providers.slack.operators.slack_webhook.SlackWebhookOperator(*, slack_webhook_conn_id, message='', attachments=None, blocks=None, channel=None, username=None, icon_emoji=None, icon_url=None, proxy=None, timeout=None, retry_handlers=None, **kwargs)[source]¶

继承自: airflow.models.BaseOperator

此操作符允许您使用 Incoming Webhook 向 Slack 发送消息。

注意

使用 Incoming Webhook 发送消息时，您无法覆盖默认频道（由安装您应用的用户选择）、用户名或图标。相反，这些值将始终继承自关联的 Slack App 配置（链接）。只有在 Legacy Slack Integration Incoming Webhook 中才可能更改这些值。

参数:

slack_webhook_conn_id – Slack Incoming Webhook 连接 ID，其密码字段中包含 Incoming Webhook token。
message (str) – 要发布的格式化消息文本。如果包含 blocks，则此文本将成为通知中使用的备用文本。
attachments (list | None) – 要在 Slack 上发送的附件。应是表示 Slack 附件的字典列表。
blocks (list | None) – 要在 Slack 上发送的块。应是表示 Slack 块的字典列表。
channel (str | None) – 消息应发布到的频道
username (str | None) – 发送到 Slack 时使用的用户名
icon_emoji (str | None) – 用作发送到 Slack 的用户图标的表情符号
icon_url (str | None) – 用于替代默认图标的图标图片 URL 字符串。
proxy (str | None) – 用于进行 Slack Incoming Webhook 调用的代理。可选
timeout (int | None) – 客户端等待连接并接收来自 Slack 响应的最大秒数。可选
retry_handlers (list[slack_sdk.http_retry.RetryHandler] | None) – slack_sdk.WebhookClient 中用于自定义重试逻辑的处理程序列表。可选

template_fields: collections.abc.Sequence[str] = ('message', 'attachments', 'blocks', 'channel', 'username', 'proxy')[source]¶

slack_webhook_conn_id[source]¶

proxy = None[source]¶

message = ''[source]¶

attachments = None[source]¶

blocks = None[source]¶

channel = None[source]¶

username = None[source]¶

icon_emoji = None[source]¶

icon_url = None[source]¶

timeout : int | None = None[source]¶

retry_handlers : list[slack_sdk.http_retry.RetryHandler] | None = None[source]¶

property hook: airflow.providers.slack.hooks.slack_webhook.SlackWebhookHook[source]¶

创建并返回一个 SlackWebhookHook（已缓存）。

execute(context)[source]¶

调用 SlackWebhookHook 发布提供的 Slack 消息。