airflow.providers.google.cloud.operators.stackdriver¶
類¶
獲取由 filter 引數傳遞的過濾器標識的所有警報策略。 |
|
啟用由 filter 引數標識的一個或多個已停用的警報策略。 |
|
停用由 filter 引數標識的一個或多個已啟用的警報策略。 |
|
建立新的警報或更新 alerts 引數中 name 欄位標識的現有策略。 |
|
刪除一個警報策略。 |
|
獲取由 filter 引數傳遞的過濾器標識的所有通知渠道。 |
|
啟用由 filter 引數標識的一個或多個已停用的警報策略。 |
|
停用由 filter 引數標識的一個或多個已啟用的通知渠道。 |
|
建立新的通知或更新現有通知渠道。 |
|
刪除一個通知渠道。 |
模組內容¶
- class airflow.providers.google.cloud.operators.stackdriver.StackdriverListAlertPoliciesOperator(*, format_=None, filter_=None, order_by=None, page_size=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator獲取由 filter 引數傳遞的過濾器標識的所有警報策略。
期望的返回型別可以透過 format 引數指定,支援的格式包括 “dict”、“json” 和 None,它們分別返回 Python 字典、JSON 字串和 protobuf。
另請參閱
有關如何使用此 operator 的更多資訊,請參閱指南:StackdriverListAlertPoliciesOperator
- 引數:
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]]) – 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線 Google Cloud Platform 的連線 ID。
project_id (str) – 從哪個專案獲取警報。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑據模擬的服務帳號,或獲取鏈中最後一個帳號 (將在請求中被模擬) 的 access_token 所需的鏈式帳號列表。如果設定為字串,則該帳號必須授予發起帳號 Service Account Token Creator IAM 角色。如果設定為序列,則列表中的身份必須向緊鄰的前一個身份授予 Service Account Token Creator IAM 角色,列表中第一個帳號將此角色授予發起帳號(模板化)。
- template_fields: collections.abc.Sequence[str] = ('filter_', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.stackdriver.StackdriverEnableAlertPoliciesOperator(*, filter_=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator啟用由 filter 引數標識的一個或多個已停用的警報策略。
如果策略已啟用,則此操作無效。
另請參閱
有關如何使用此 operator 的更多資訊,請參閱指南:StackdriverEnableAlertPoliciesOperator
- 引數:
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]]) – 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線 Google Cloud Platform 的連線 ID。
project_id (str) – 需要啟用警報的專案。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑據模擬的服務帳號,或獲取鏈中最後一個帳號 (將在請求中被模擬) 的 access_token 所需的鏈式帳號列表。如果設定為字串,則該帳號必須授予發起帳號 Service Account Token Creator IAM 角色。如果設定為序列,則列表中的身份必須向緊鄰的前一個身份授予 Service Account Token Creator IAM 角色,列表中第一個帳號將此角色授予發起帳號(模板化)。
- template_fields: collections.abc.Sequence[str] = ('filter_', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.stackdriver.StackdriverDisableAlertPoliciesOperator(*, filter_=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator停用由 filter 引數標識的一個或多個已啟用的警報策略。
如果策略已停用,則此操作無效。
另請參閱
有關如何使用此 operator 的更多資訊,請參閱指南:StackdriverDisableAlertPoliciesOperator
- 引數:
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]]) – 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線 Google Cloud Platform 的連線 ID。
project_id (str) – 需要停用警報的專案。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑據模擬的服務帳號,或獲取鏈中最後一個帳號 (將在請求中被模擬) 的 access_token 所需的鏈式帳號列表。如果設定為字串,則該帳號必須授予發起帳號 Service Account Token Creator IAM 角色。如果設定為序列,則列表中的身份必須向緊鄰的前一個身份授予 Service Account Token Creator IAM 角色,列表中第一個帳號將此角色授予發起帳號(模板化)。
- template_fields: collections.abc.Sequence[str] = ('filter_', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.stackdriver.StackdriverUpsertAlertOperator(*, alerts, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator建立新的警報或更新 alerts 引數中 name 欄位標識的現有策略。
另請參閱
有關如何使用此 operator 的更多資訊,請參閱指南:StackdriverUpsertAlertOperator
- 引數:
alerts (str) – 一個 JSON 字串或檔案,指定所有需要建立或更新的告警。更多詳細資訊,請參閱 https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.alertPolicies#AlertPolicy。(模板化)
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]]) – 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線 Google Cloud Platform 的連線 ID。
project_id (str) – 需要建立/更新告警的專案。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑據模擬的服務帳號,或獲取鏈中最後一個帳號 (將在請求中被模擬) 的 access_token 所需的鏈式帳號列表。如果設定為字串,則該帳號必須授予發起帳號 Service Account Token Creator IAM 角色。如果設定為序列,則列表中的身份必須向緊鄰的前一個身份授予 Service Account Token Creator IAM 角色,列表中第一個帳號將此角色授予發起帳號(模板化)。
- template_fields: collections.abc.Sequence[str] = ('alerts', 'impersonation_chain')[source]¶
- template_ext: collections.abc.Sequence[str] = ('.json',)[source]¶
- class airflow.providers.google.cloud.operators.stackdriver.StackdriverDeleteAlertOperator(*, name, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator刪除一個警報策略。
另請參閱
有關如何使用此運算子的更多資訊,請參閱指南: StackdriverDeleteAlertOperator
- 引數:
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]]) – 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線 Google Cloud Platform 的連線 ID。
project_id (str) – 需要刪除告警的專案。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑據模擬的服務帳號,或獲取鏈中最後一個帳號 (將在請求中被模擬) 的 access_token 所需的鏈式帳號列表。如果設定為字串,則該帳號必須授予發起帳號 Service Account Token Creator IAM 角色。如果設定為序列,則列表中的身份必須向緊鄰的前一個身份授予 Service Account Token Creator IAM 角色,列表中第一個帳號將此角色授予發起帳號(模板化)。
- template_fields: collections.abc.Sequence[str] = ('name', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.stackdriver.StackdriverListNotificationChannelsOperator(*, format_=None, filter_=None, order_by=None, page_size=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator獲取由 filter 引數傳遞的過濾器標識的所有通知渠道。
期望的返回型別可以透過 format 引數指定,支援的格式包括 “dict”、“json” 和 None,它們分別返回 Python 字典、JSON 字串和 protobuf。
另請參閱
有關如何使用此運算子的更多資訊,請參閱指南: StackdriverListNotificationChannelsOperator
- 引數:
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]]) – 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線 Google Cloud Platform 的連線 ID。
project_id (str) – 從中獲取通知渠道的專案。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑據模擬的服務帳號,或獲取鏈中最後一個帳號 (將在請求中被模擬) 的 access_token 所需的鏈式帳號列表。如果設定為字串,則該帳號必須授予發起帳號 Service Account Token Creator IAM 角色。如果設定為序列,則列表中的身份必須向緊鄰的前一個身份授予 Service Account Token Creator IAM 角色,列表中第一個帳號將此角色授予發起帳號(模板化)。
- template_fields: collections.abc.Sequence[str] = ('filter_', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.stackdriver.StackdriverEnableNotificationChannelsOperator(*, filter_=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator啟用由 filter 引數標識的一個或多個已停用的警報策略。
如果策略已啟用,則此操作無效。
另請參閱
有關如何使用此運算子的更多資訊,請參閱指南: StackdriverEnableNotificationChannelsOperator
- 引數:
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]]) – 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線 Google Cloud Platform 的連線 ID。
project_id (str) – 用於操作的位置。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑據模擬的服務帳號,或獲取鏈中最後一個帳號 (將在請求中被模擬) 的 access_token 所需的鏈式帳號列表。如果設定為字串,則該帳號必須授予發起帳號 Service Account Token Creator IAM 角色。如果設定為序列,則列表中的身份必須向緊鄰的前一個身份授予 Service Account Token Creator IAM 角色,列表中第一個帳號將此角色授予發起帳號(模板化)。
- template_fields: collections.abc.Sequence[str] = ('filter_', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.stackdriver.StackdriverDisableNotificationChannelsOperator(*, filter_=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator停用由 filter 引數標識的一個或多個已啟用的通知渠道。
如果策略已停用,則此操作無效。
另請參閱
有關如何使用此運算子的更多資訊,請參閱指南: StackdriverDisableNotificationChannelsOperator
- 引數:
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]]) – 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線 Google Cloud Platform 的連線 ID。
project_id (str) – 需要啟用通知渠道的專案。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑據模擬的服務帳號,或獲取鏈中最後一個帳號 (將在請求中被模擬) 的 access_token 所需的鏈式帳號列表。如果設定為字串,則該帳號必須授予發起帳號 Service Account Token Creator IAM 角色。如果設定為序列,則列表中的身份必須向緊鄰的前一個身份授予 Service Account Token Creator IAM 角色,列表中第一個帳號將此角色授予發起帳號(模板化)。
- template_fields: collections.abc.Sequence[str] = ('filter_', 'impersonation_chain')[source]¶
- class airflow.providers.google.cloud.operators.stackdriver.StackdriverUpsertNotificationChannelOperator(*, channels, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator建立新的通知或更新現有通知渠道。
通知通道透過 alerts 引數中的 name 欄位來標識。
另請參閱
有關如何使用此 Operator 的更多資訊,請參閱指南:StackdriverUpsertNotificationChannelOperator
- 引數:
channels (str) – 一個 JSON 字串或檔案,用於指定所有需要建立或更新的告警。更多詳情請參閱 https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannels。(模板化的)
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]]) – 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線 Google Cloud Platform 的連線 ID。
project_id (str) – 需要建立/更新通知通道的專案。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑據模擬的服務帳號,或獲取鏈中最後一個帳號 (將在請求中被模擬) 的 access_token 所需的鏈式帳號列表。如果設定為字串,則該帳號必須授予發起帳號 Service Account Token Creator IAM 角色。如果設定為序列,則列表中的身份必須向緊鄰的前一個身份授予 Service Account Token Creator IAM 角色,列表中第一個帳號將此角色授予發起帳號(模板化)。
- template_fields: collections.abc.Sequence[str] = ('channels', 'impersonation_chain')[source]¶
- template_ext: collections.abc.Sequence[str] = ('.json',)[source]¶
- class airflow.providers.google.cloud.operators.stackdriver.StackdriverDeleteNotificationChannelOperator(*, name, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', project_id=PROVIDE_PROJECT_ID, impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator刪除一個通知渠道。
另請參閱
有關如何使用此 Operator 的更多資訊,請參閱指南:StackdriverDeleteNotificationChannelOperator
- 引數:
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]]) – 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線 Google Cloud Platform 的連線 ID。
project_id (str) – 需要從中刪除通知通道的專案。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑據模擬的服務帳號,或獲取鏈中最後一個帳號 (將在請求中被模擬) 的 access_token 所需的鏈式帳號列表。如果設定為字串,則該帳號必須授予發起帳號 Service Account Token Creator IAM 角色。如果設定為序列,則列表中的身份必須向緊鄰的前一個身份授予 Service Account Token Creator IAM 角色,列表中第一個帳號將此角色授予發起帳號(模板化)。
- template_fields: collections.abc.Sequence[str] = ('name', 'impersonation_chain')[source]¶