airflow.providers.google.cloud.hooks.stackdriver

此模組包含 Google Cloud Stackdriver 運算子。

類

StackdriverHook

用於連線 Google Cloud Stackdriver 的 Stackdriver Hook。

模組內容

class airflow.providers.google.cloud.hooks.stackdriver.StackdriverHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

基類: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

用於連線 Google Cloud Stackdriver 的 Stackdriver Hook。

list_alert_policies(project_id=PROVIDE_PROJECT_ID, format_=None, filter_=None, order_by=None, page_size=None, retry=DEFAULT, timeout=None, metadata=())[source]

根據作為 filter 引數傳遞的過濾器，獲取所有 Alert Policies。

期望的返回型別可以透過 format 引數指定，支援的格式有“dict”、“json”和 None，分別返回 python 字典、字串化 JSON 和 protobuf。

引數:

  • format – （可選）結果的期望輸出格式。支援的格式有“dict”、“json”和 None，分別返回 python 字典、字串化 JSON 和 protobuf。

  • filter – 如果提供，此欄位指定警報策略必須滿足的標準，以便包含在響應中。有關更多詳細資訊，請參閱 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • order_by (str | None) – 用於對結果進行排序的欄位的逗號分隔列表。支援與 filter 欄位相同的欄位引用集。條目可以以減號作為字首，以按降序排列欄位。有關更多詳細資訊，請參閱 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • page_size (int | None) – 基礎 API 響應中包含的最大資源數量。如果每資源執行頁面流式傳輸，此引數不影響返回值。如果每頁執行頁面流式傳輸，此引數確定一頁中的最大資源數量。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，將使用預設配置重試請求。

  • timeout (float | None) – 等待請求完成的時間，以秒為單位。請注意，如果指定了 retry，則超時應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的額外元資料。

  • project_id (str) – 要從中獲取警報的專案。

enable_alert_policies(project_id=PROVIDE_PROJECT_ID, filter_=None, retry=DEFAULT, timeout=None, metadata=())[source]

啟用一個或多個由 filter 引數標識的已停用警報策略。

如果策略已啟用，則此操作無效。

引數:

  • project_id (str) – 需要啟用警報的專案。

  • filter – 如果提供，此欄位指定警報策略必須滿足的標準，以便啟用。有關更多詳細資訊，請參閱 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，將使用預設配置重試請求。

  • timeout (float | None) – 等待請求完成的時間，以秒為單位。請注意，如果指定了 retry，則超時應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的額外元資料。

disable_alert_policies(project_id=PROVIDE_PROJECT_ID, filter_=None, retry=DEFAULT, timeout=None, metadata=())[source]

停用一個或多個由 filter 引數標識的已啟用警報策略。

如果策略已停用，則此操作無效。

引數:

  • project_id (str) – 需要停用警報的專案。

  • filter – 如果提供，此欄位指定警報策略必須滿足的標準，以便停用。有關更多詳細資訊，請參閱 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，將使用預設配置重試請求。

  • timeout (float | None) – 等待請求完成的時間，以秒為單位。請注意，如果指定了 retry，則超時應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的額外元資料。

upsert_alert(alerts, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

建立一個新警報或更新由 alerts 引數中的 name 欄位標識的現有策略。

引數:
delete_alert_policy(name, retry=DEFAULT, timeout=None, metadata=())[source]

刪除警報策略。

引數:

  • name (str) – 要刪除的警報策略。格式為：projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，將使用預設配置重試請求。

  • timeout (float | None) – 等待請求完成的時間，以秒為單位。請注意，如果指定了 retry，則超時應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的額外元資料。

list_notification_channels(project_id=PROVIDE_PROJECT_ID, format_=None, filter_=None, order_by=None, page_size=None, retry=DEFAULT, timeout=None, metadata=())[source]

根據作為 filter 引數傳遞的過濾器，獲取所有 Notification Channels。

期望的返回型別可以透過 format 引數指定，支援的格式有“dict”、“json”和 None，分別返回 python 字典、字串化 JSON 和 protobuf。

引數:

  • format – （可選）結果的期望輸出格式。支援的格式有“dict”、“json”和 None，分別返回 python 字典、字串化 JSON 和 protobuf。

  • filter – 如果提供，此欄位指定通知渠道必須滿足的標準，以便包含在響應中。有關更多詳細資訊，請參閱 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • order_by (str | None) – 用於對結果進行排序的欄位的逗號分隔列表。支援與 filter 欄位相同的欄位引用集。條目可以以減號作為字首，以按降序排列欄位。有關更多詳細資訊，請參閱 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • page_size (int | None) – 基礎 API 響應中包含的最大資源數量。如果每資源執行頁面流式傳輸，此引數不影響返回值。如果每頁執行頁面流式傳輸，此引數確定一頁中的最大資源數量。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，將使用預設配置重試請求。

  • timeout (float | None) – 等待請求完成的時間，以秒為單位。請注意，如果指定了 retry，則超時應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的額外元資料。

  • project_id (str) – 要從中獲取通知渠道的專案。

enable_notification_channels(project_id=PROVIDE_PROJECT_ID, filter_=None, retry=DEFAULT, timeout=None, metadata=())[source]

啟用一個或多個由 filter 引數標識的已停用警報策略。

如果策略已啟用，則此操作無效。

引數:

  • project_id (str) – 需要啟用通知渠道的專案。

  • filter – 如果提供，此欄位指定通知渠道必須滿足的標準，以便啟用。有關更多詳細資訊，請參閱 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，將使用預設配置重試請求。

  • timeout (float | None) – 等待請求完成的時間，以秒為單位。請注意，如果指定了 retry，則超時應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的額外元資料。

disable_notification_channels(project_id, filter_=None, retry=DEFAULT, timeout=None, metadata=())[source]

停用一個或多個由 filter 引數標識的已啟用通知渠道。

如果策略已停用，則此操作無效。

引數:

  • project_id (str) – 需要啟用通知渠道的專案。

  • filter – 如果提供，此欄位指定警報策略必須滿足的標準，以便停用。有關更多詳細資訊，請參閱 https://cloud.google.com/monitoring/api/v3/sorting-and-filtering。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，將使用預設配置重試請求。

  • timeout (float | None) – 等待請求完成的時間，以秒為單位。請注意，如果指定了 retry，則超時應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的額外元資料。

upsert_channel(channels, project_id, retry=DEFAULT, timeout=None, metadata=())[source]

建立新通知或更新現有通知渠道。

渠道由 alerts 引數中的 name 欄位標識。

引數:
delete_notification_channel(name, retry=DEFAULT, timeout=None, metadata=())[source]

刪除通知渠道。

引數:

  • name (str) – 要刪除的警報策略。格式為：projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]。

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用於重試請求的重試物件。如果指定 None，將使用預設配置重試請求。

  • timeout (float | None) – 等待請求完成的時間，以秒為單位。請注意，如果指定了 retry，則超時應用於每個單獨的嘗試。

  • metadata (collections.abc.Sequence[tuple[str, str]]) – 提供給方法的額外元資料。

此條目有幫助嗎？