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]

擷取所有通過篩選器參數傳遞的篩選條件所識別的警示政策。

期望的回傳類型可以通過 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]

啟用一個或多個通過篩選器參數識別的已停用警示政策。

如果政策已啟用，則無效。

參數

  • 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]

停用一個或多個通過篩選器參數識別的已啟用警示政策。

如果政策已停用，則無效。

參數

  • 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 參數中名稱欄位識別的現有政策。

參數
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]

擷取所有通過篩選器參數傳遞的篩選條件所識別的通知管道。

期望的回傳類型可以通過 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]

啟用一個或多個通過篩選器參數識別的已停用警示政策。

如果政策已啟用，則無效。

參數

  • 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]

停用一個或多個通過篩選器參數識別的已啟用通知管道。

如果政策已停用，則無效。

參數

  • 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]

建立新的通知或更新現有的通知管道。

管道通過 channels 參數中的名稱欄位識別。

參數
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]]) – 提供給方法的額外元數據。

此條目是否有幫助？