`airflow.providers.google.cloud.operators.tasks`¶

Google Cloud Tasks 運算子，讓您可以使用 Cloud Tasks 佇列/任務執行基本操作。

模組內容¶

類別¶

`CloudTasksQueueCreateOperator`	在 Cloud Tasks 中建立佇列。
`CloudTasksQueueUpdateOperator`	在 Cloud Tasks 中更新佇列。
`CloudTasksQueueGetOperator`	從 Cloud Tasks 取得佇列。
`CloudTasksQueuesListOperator`	從 Cloud Tasks 列出佇列。
`CloudTasksQueueDeleteOperator`	從 Cloud Tasks 刪除佇列，即使其中有任務。
`CloudTasksQueuePurgeOperator`	透過從 Cloud Tasks 刪除佇列的所有任務來清除佇列。
`CloudTasksQueuePauseOperator`	在 Cloud Tasks 中暫停佇列。
`CloudTasksQueueResumeOperator`	在 Cloud Tasks 中恢復佇列。
`CloudTasksTaskCreateOperator`	在 Cloud Tasks 中建立任務。
`CloudTasksTaskGetOperator`	從 Cloud Tasks 取得任務。
`CloudTasksTasksListOperator`	列出 Cloud Tasks 中的任務。
`CloudTasksTaskDeleteOperator`	從 Cloud Tasks 刪除任務。
`CloudTasksTaskRunOperator`	強制在 Cloud Tasks 中執行任務。

屬性¶

MetaData

airflow.providers.google.cloud.operators.tasks.MetaData[原始碼]¶

class airflow.providers.google.cloud.operators.tasks.CloudTasksQueueCreateOperator(*, location, task_queue, project_id=PROVIDE_PROJECT_ID, queue_name=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[原始碼]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

在 Cloud Tasks 中建立佇列。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：建立佇列

參數

location (str) – 將在其中建立佇列的位置名稱。
task_queue (google.cloud.tasks_v2.types.Queue) – 要建立的任務佇列。佇列名稱不能與現有佇列相同。如果提供字典，則其格式必須與 protobuf 訊息 Queue 相同。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
queue_name (str | None) – (選用) 佇列的名稱。如果提供，將用於建構完整的佇列路徑。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('task_queue', 'project_id', 'location', 'queue_name', 'gcp_conn_id', 'impersonation_chain')[原始碼]¶

operator_extra_links = ()[原始碼]¶

execute(context)[原始碼]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.tasks.CloudTasksQueueUpdateOperator(*, task_queue, project_id=PROVIDE_PROJECT_ID, location=None, queue_name=None, update_mask=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[原始碼]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

在 Cloud Tasks 中更新佇列。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：更新佇列

參數

task_queue (google.cloud.tasks_v2.types.Queue) – 要更新的任務佇列。如果佇列不存在，此方法會建立佇列，如果佇列存在，則會更新佇列。必須指定佇列的名稱。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
location (str | None) – (選用) 將在其中更新佇列的位置名稱。如果提供，將用於建構完整的佇列路徑。
queue_name (str | None) – (選用) 佇列的名稱。如果提供，將用於建構完整的佇列路徑。
update_mask (google.protobuf.field_mask_pb2.FieldMask | None) – 用於指定正在更新佇列的哪些欄位的遮罩。如果為空，則將更新所有欄位。如果提供字典，則其格式必須與 protobuf 訊息相同。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('task_queue', 'project_id', 'location', 'queue_name', 'update_mask', 'gcp_conn_id',...[原始碼]¶

operator_extra_links = ()[原始碼]¶

execute(context)[原始碼]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.tasks.CloudTasksQueueGetOperator(*, location, queue_name, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[原始碼]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

從 Cloud Tasks 取得佇列。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：取得佇列

參數

location (str) – 佇列建立所在的位置名稱。
queue_name (str) – 佇列的名稱。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('location', 'queue_name', 'project_id', 'gcp_conn_id', 'impersonation_chain')[原始碼]¶

operator_extra_links = ()[原始碼]¶

execute(context)[原始碼]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.tasks.CloudTasksQueuesListOperator(*, location, project_id=PROVIDE_PROJECT_ID, results_filter=None, page_size=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[原始碼]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

從 Cloud Tasks 列出佇列。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：列出佇列

參數

location (str) – 佇列建立所在的位置名稱。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
results_filter (str | None) – (選用) 用於指定佇列子集的篩選器。
page_size (int | None) – (選用) 基礎 API 回應中包含的資源最大數量。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('location', 'project_id', 'gcp_conn_id', 'impersonation_chain')[原始碼]¶

operator_extra_links = ()[原始碼]¶

execute(context)[原始碼]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.tasks.CloudTasksQueueDeleteOperator(*, location, queue_name, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[原始碼]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

從 Cloud Tasks 刪除佇列，即使其中有任務。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：刪除佇列

參數

location (str) – 將在其中刪除佇列的位置名稱。
queue_name (str) – 佇列的名稱。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('location', 'queue_name', 'project_id', 'gcp_conn_id', 'impersonation_chain')[原始碼]¶

execute(context)[原始碼]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.tasks.CloudTasksQueuePurgeOperator(*, location, queue_name, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[原始碼]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

透過從 Cloud Tasks 刪除佇列的所有任務來清除佇列。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：清除佇列

參數

location (str) – 將在其中清除佇列的位置名稱。
queue_name (str) – 佇列的名稱。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('location', 'queue_name', 'project_id', 'gcp_conn_id', 'impersonation_chain')[原始碼]¶

operator_extra_links = ()[原始碼]¶

execute(context)[原始碼]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.tasks.CloudTasksQueuePauseOperator(*, location, queue_name, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[原始碼]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

在 Cloud Tasks 中暫停佇列。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：暫停佇列

參數

location (str) – 佇列將在其中暫停的位置名稱。
queue_name (str) – 佇列的名稱。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('location', 'queue_name', 'project_id', 'gcp_conn_id', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.tasks.CloudTasksQueueResumeOperator(*, location, queue_name, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

在 Cloud Tasks 中恢復佇列。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：恢復佇列

參數

location (str) – 佇列將在其中恢復的位置名稱。
queue_name (str) – 佇列的名稱。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('location', 'queue_name', 'project_id', 'gcp_conn_id', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.tasks.CloudTasksTaskCreateOperator(*, location, queue_name, task, project_id=PROVIDE_PROJECT_ID, task_name=None, response_view=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

在 Cloud Tasks 中建立任務。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：建立任務

參數

location (str) – 將在其中建立任務的位置名稱。
queue_name (str) – 佇列的名稱。
task (dict | google.cloud.tasks_v2.types.Task) – 要新增的任務。如果提供字典，則其格式必須與protobuf訊息 Task 相同。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
task_name (str | None) – (選用) 任務的名稱。如果提供，將用於建構完整的任務路徑。
response_view (google.cloud.tasks_v2.types.Task.View | None) – (選用) 此欄位指定將傳回 Task 的哪個子集。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('task', 'project_id', 'location', 'queue_name', 'task_name', 'gcp_conn_id', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.tasks.CloudTasksTaskGetOperator(*, location, queue_name, task_name, project_id=PROVIDE_PROJECT_ID, response_view=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

從 Cloud Tasks 取得任務。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：取得任務

參數

location (str) – 任務建立所在位置的名稱。
queue_name (str) – 佇列的名稱。
task_name (str) – 任務的名稱。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
response_view (google.cloud.tasks_v2.types.Task.View | None) – (選用) 此欄位指定將傳回 Task 的哪個子集。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('location', 'queue_name', 'task_name', 'project_id', 'gcp_conn_id', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.tasks.CloudTasksTasksListOperator(*, location, queue_name, project_id=PROVIDE_PROJECT_ID, response_view=None, page_size=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

列出 Cloud Tasks 中的任務。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：列出任務

參數

location (str) – 任務建立所在位置的名稱。
queue_name (str) – 佇列的名稱。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
response_view (google.cloud.tasks_v2.types.Task.View | None) – (選用) 此欄位指定將傳回 Task 的哪個子集。
page_size (int | None) – (選用) 基礎 API 回應中包含的資源最大數量。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('location', 'queue_name', 'project_id', 'gcp_conn_id', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.tasks.CloudTasksTaskDeleteOperator(*, location, queue_name, task_name, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

從 Cloud Tasks 刪除任務。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：刪除任務

參數

location (str) – 任務將在其中刪除的位置名稱。
queue_name (str) – 佇列的名稱。
task_name (str) – 任務的名稱。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('location', 'queue_name', 'task_name', 'project_id', 'gcp_conn_id', 'impersonation_chain')[source]¶

execute(context)[source]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.tasks.CloudTasksTaskRunOperator(*, location, queue_name, task_name, project_id=PROVIDE_PROJECT_ID, response_view=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基底類別： airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

強制在 Cloud Tasks 中執行任務。

另請參閱

如需更多關於如何使用此運算子的資訊，請參閱指南：執行任務

參數

location (str) – 任務建立所在位置的名稱。
queue_name (str) – 佇列的名稱。
task_name (str) – 任務的名稱。
project_id (str) – (選用) 擁有 Cloud Tasks 的 Google Cloud 專案 ID。如果設定為 None 或遺失，則會使用 Google Cloud 連線中的預設 project_id。
response_view (google.cloud.tasks_v2.types.Task.View | None) – (選用) 此欄位指定將傳回 Task 的哪個子集。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (選用) 用於重試請求的重試物件。如果指定 None，則不會重試請求。
timeout (float | None) – (選用) 等待請求完成的時間量（以秒為單位）。請注意，如果指定 retry，則逾時適用於每個個別嘗試。
metadata (MetaData) – (選用) 提供給方法的其他中繼資料。
gcp_conn_id (str) – (選用) 用於連線至 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 選用的服務帳戶，用於使用短期憑證模擬身分，或取得清單中最後一個帳戶的 access_token 所需的鏈結帳戶清單，該帳戶將在請求中被模擬身分。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則清單中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊接在前的身分，清單中的第一個帳戶將此角色授予原始帳戶 (可使用範本)。

template_fields: collections.abc.Sequence[str] = ('location', 'queue_name', 'task_name', 'project_id', 'gcp_conn_id', 'impersonation_chain')[source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

Context 是與呈現 jinja 範本時使用的相同字典。

請參閱 get_template_context 以取得更多上下文。

airflow.providers.google.cloud.operators.tasks¶

模組內容¶

類別¶

屬性¶

`airflow.providers.google.cloud.operators.tasks`¶