airflow.providers.google.cloud.operators.stackdriver
¶
模組內容¶
類別¶
擷取所有以篩選器參數傳遞的篩選條件識別的警示政策。 |
|
啟用一個或多個由篩選器參數識別的已停用警示政策。 |
|
停用一個或多個由篩選器參數識別的已啟用警示政策。 |
|
建立新的警示或更新警示參數中名稱欄位識別的現有政策。 |
|
刪除警示政策。 |
|
擷取所有以篩選器參數傳遞的篩選條件識別的通知管道。 |
|
啟用一個或多個由篩選器參數識別的已停用警示政策。 |
|
停用一個或多個由篩選器參數識別的已啟用通知管道。 |
|
建立新的通知或更新現有的通知管道。 |
|
刪除通知管道。 |
- 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]¶
基底類別:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
擷取所有以篩選器參數傳遞的篩選條件識別的警示政策。
所需的傳回類型可以由 format 參數指定,支援的格式為 "dict"、"json" 和 None,分別傳回 Python 字典、字串化的 JSON 和 protobuf。
參見
有關如何使用此運算子的更多資訊,請參閱指南: 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 所需的鏈結帳戶列表,該帳戶將在請求中被模擬。如果設定為字串,則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列,則列表中的身分必須授予緊鄰前一個身分「服務帳戶權杖建立者」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]¶
基底類別:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
啟用一個或多個由篩選器參數識別的已停用警示政策。
如果政策已啟用,則不執行任何操作。
參見
有關如何使用此運算子的更多資訊,請參閱指南: 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 所需的鏈結帳戶列表,該帳戶將在請求中被模擬。如果設定為字串,則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列,則列表中的身分必須授予緊鄰前一個身分「服務帳戶權杖建立者」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]¶
基底類別:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
停用一個或多個由篩選器參數識別的已啟用警示政策。
如果政策已停用,則不執行任何操作。
參見
有關如何使用此運算子的更多資訊,請參閱指南: 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 所需的鏈結帳戶列表,該帳戶將在請求中被模擬。如果設定為字串,則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列,則列表中的身分必須授予緊鄰前一個身分「服務帳戶權杖建立者」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]¶
基底類別:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
建立新的警示或更新警示參數中名稱欄位識別的現有政策。
參見
有關如何使用此運算子的更多資訊,請參閱指南: 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 所需的鏈結帳戶列表,該帳戶將在請求中被模擬。如果設定為字串,則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列,則列表中的身分必須授予緊鄰前一個身分「服務帳戶權杖建立者」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]¶
基底類別:
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 所需的鏈結帳戶列表,該帳戶將在請求中被模擬。如果設定為字串,則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列,則列表中的身分必須授予緊鄰前一個身分「服務帳戶權杖建立者」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]¶
基底類別:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
擷取所有以篩選器參數傳遞的篩選條件識別的通知管道。
所需的傳回類型可以由 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 所需的鏈結帳戶列表,該帳戶將在請求中被模擬。如果設定為字串,則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列,則列表中的身分必須授予緊鄰前一個身分「服務帳戶權杖建立者」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]¶
基底類別:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
啟用一個或多個由篩選器參數識別的已停用警示政策。
如果政策已啟用,則不執行任何操作。
參見
如需更多關於如何使用此運算子的資訊,請參閱指南: 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 所需的鏈結帳戶列表,該帳戶將在請求中被模擬。如果設定為字串,則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列,則列表中的身分必須授予緊鄰前一個身分「服務帳戶權杖建立者」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]¶
基底類別:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
停用一個或多個由篩選器參數識別的已啟用通知管道。
如果政策已停用,則不執行任何操作。
參見
如需更多關於如何使用此運算子的資訊,請參閱指南: 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 所需的鏈結帳戶列表,該帳戶將在請求中被模擬。如果設定為字串,則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列,則列表中的身分必須授予緊鄰前一個身分「服務帳戶權杖建立者」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]¶
基底類別:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
建立新的通知或更新現有的通知管道。
管道是透過警示參數中的名稱欄位來識別。
參見
如需更多關於如何使用此運算子的資訊,請參閱指南: 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 所需的鏈結帳戶列表,該帳戶將在請求中被模擬。如果設定為字串,則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列,則列表中的身分必須授予緊鄰前一個身分「服務帳戶權杖建立者」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]¶
基底類別:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
刪除通知管道。
參見
如需更多關於如何使用此運算子的資訊,請參閱指南: 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 所需的鏈結帳戶列表,該帳戶將在請求中被模擬。如果設定為字串,則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列,則列表中的身分必須授予緊鄰前一個身分「服務帳戶權杖建立者」IAM 角色,列表中的第一個帳戶將此角色授予原始帳戶 (已範本化)。
- template_fields: collections.abc.Sequence[str] = ('name', 'impersonation_chain')[source]¶