airflow.providers.slack.operators.slack_webhook

模組內容

類別

SlackWebhookOperator

此運算子允許您使用傳入 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)[原始碼]

基類:airflow.models.BaseOperator

此運算子允許您使用傳入 Webhook 將訊息發佈到 Slack。

注意

當您使用傳入 Webhook 發佈訊息時,您無法覆寫預設頻道(由安裝您應用程式的使用者選擇)、使用者名稱或圖示。相反地,這些值將始終繼承自相關聯的 Slack 應用程式配置 (連結)。只有在 舊版 Slack 整合傳入 Webhook 中才能變更這些值。

參數
  • slack_webhook_conn_idSlack 傳入 Webhook 連線 ID,密碼欄位中包含傳入 Webhook 權杖。

  • 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 使用者圖示的 emoji

  • icon_url (str | None) – 用於取代預設圖示的圖示圖片 URL 字串。

  • proxy (str | None) – 用於進行 Slack 傳入 Webhook 呼叫的 Proxy。選填

  • 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')[原始碼]
hook()[原始碼]

建立並傳回 SlackWebhookHook (已快取)。

execute(context)[原始碼]

呼叫 SlackWebhookHook 以發佈提供的 Slack 訊息。

此條目是否有幫助?