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

Google Cloud Tasks Operator，允許您使用 Cloud Tasks 佇列/任務執行基本操作。

屬性¶

MetaData

類¶

`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 中的任務。

模組內容¶

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 中建立佇列。

另請參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：建立佇列

引數:

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) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予“服務帳號令牌建立者”IAM 角色，列表中的第一個帳號將此角色授予源帳號（模板化）。

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

operator_extra_links[源]¶

location[源]¶

task_queue[源]¶

project_id = None[源]¶

queue_name = None[源]¶

retry[源]¶

timeout = None[源]¶

metadata = ()[源]¶

gcp_conn_id = 'google_cloud_default'[源]¶

impersonation_chain = None[源]¶

execute(context)[源]¶

建立 Operator 時派生。

Context 是渲染 jinja 模板時使用的相同字典。

有關更多 Context，請參閱 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 中的佇列。

另請參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：更新佇列

引數:

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) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予“服務帳號令牌建立者”IAM 角色，列表中的第一個帳號將此角色授予源帳號（模板化）。

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

operator_extra_links[源]¶

task_queue[源]¶

project_id = None[源]¶

location = None[源]¶

queue_name = None[源]¶

update_mask = None[源]¶

retry[源]¶

timeout = None[源]¶

metadata = ()[源]¶

gcp_conn_id = 'google_cloud_default'[源]¶

impersonation_chain = None[源]¶

execute(context)[源]¶

建立 Operator 時派生。

Context 是渲染 jinja 模板時使用的相同字典。

有關更多 Context，請參閱 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 獲取佇列。

另請參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：獲取佇列

引數:

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) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予“服務帳號令牌建立者”IAM 角色，列表中的第一個帳號將此角色授予源帳號（模板化）。

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

operator_extra_links[源]¶

location[源]¶

queue_name[源]¶

project_id = None[源]¶

retry[源]¶

timeout = None[源]¶

metadata = ()[源]¶

gcp_conn_id = 'google_cloud_default'[源]¶

impersonation_chain = None[源]¶

execute(context)[源]¶

建立 Operator 時派生。

Context 是渲染 jinja 模板時使用的相同字典。

有關更多 Context，請參閱 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 中的佇列。

另請參閱

有關如何使用此 Operator 的更多資訊，請參閱指南：列出佇列

引數:

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) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予“服務帳號令牌建立者”IAM 角色，列表中的第一個帳號將此角色授予源帳號（模板化）。

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

operator_extra_links[source]¶

location[source]¶

project_id = None[source]¶

results_filter = None[source]¶

page_size = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立 Operator 時派生。

Context 是渲染 jinja 模板時使用的相同字典。

有關更多 Context，請參閱 get_template_context。

類 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)[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) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予“服務帳號令牌建立者”IAM 角色，列表中的第一個帳號將此角色授予源帳號（模板化）。

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

location[source]¶

queue_name[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立 Operator 時派生。

Context 是渲染 jinja 模板時使用的相同字典。

有關更多 Context，請參閱 get_template_context。

類 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)[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) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予“服務帳號令牌建立者”IAM 角色，列表中的第一個帳號將此角色授予源帳號（模板化）。

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

operator_extra_links[source]¶

location[source]¶

queue_name[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立 Operator 時派生。

Context 是渲染 jinja 模板時使用的相同字典。

有關更多 Context，請參閱 get_template_context。

類 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)[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) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予“服務帳號令牌建立者”IAM 角色，列表中的第一個帳號將此角色授予源帳號（模板化）。

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

operator_extra_links[source]¶

location[source]¶

queue_name[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立 Operator 時派生。

Context 是渲染 jinja 模板時使用的相同字典。

有關更多 Context，請參閱 get_template_context。

類 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) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予“服務帳號令牌建立者”IAM 角色，列表中的第一個帳號將此角色授予源帳號（模板化）。

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

operator_extra_links[source]¶

location[source]¶

queue_name[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立 Operator 時派生。

Context 是渲染 jinja 模板時使用的相同字典。

有關更多 Context，請參閱 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 中建立任務。

另請參閱

有關如何使用此 operator 的更多資訊，請參閱指南：建立任務

引數:

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) – (可選) 此欄位指定將返回的任務子集。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可選) 用於重試請求的重試物件。如果指定為 None，則不會重試請求。
timeout (float | None) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”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]¶

location[source]¶

queue_name[source]¶

task[source]¶

project_id = None[source]¶

task_name = None[source]¶

response_view = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立 Operator 時派生。

Context 是渲染 jinja 模板時使用的相同字典。

有關更多 Context，請參閱 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 獲取任務。

另請參閱

有關如何使用此 operator 的更多資訊，請參閱指南：獲取任務

引數:

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) – (可選) 此欄位指定將返回的任務子集。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可選) 用於重試請求的重試物件。如果指定為 None，則不會重試請求。
timeout (float | None) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”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]¶

location[source]¶

queue_name[source]¶

task_name[source]¶

project_id = None[source]¶

response_view = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立 Operator 時派生。

Context 是渲染 jinja 模板時使用的相同字典。

有關更多 Context，請參閱 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 中的任務。

另請參閱

有關如何使用此 operator 的更多資訊，請參閱指南：列出任務

引數:

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) – (可選) 此欄位指定將返回的任務子集。
page_size (int | None) – (可選) 基礎 API 響應中包含的最大資源數量。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可選) 用於重試請求的重試物件。如果指定為 None，則不會重試請求。
timeout (float | None) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予“服務帳號令牌建立者”IAM 角色，列表中的第一個帳號將此角色授予源帳號（模板化）。

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

operator_extra_links[source]¶

location[source]¶

queue_name[source]¶

project_id = None[source]¶

response_view = None[source]¶

page_size = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立 Operator 時派生。

Context 是渲染 jinja 模板時使用的相同字典。

有關更多 Context，請參閱 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 中刪除任務。

另請參閱

有關如何使用此 operator 的更多資訊，請參閱指南：刪除任務

引數:

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) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予“服務帳號令牌建立者”IAM 角色，列表中的第一個帳號將此角色授予源帳號（模板化）。

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

location[source]¶

queue_name[source]¶

task_name[source]¶

project_id = None[source]¶

retry[source]¶

timeout = None[source]¶

metadata = ()[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

建立 Operator 時派生。

Context 是渲染 jinja 模板時使用的相同字典。

有關更多 Context，請參閱 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) – (可選) 此欄位指定將返回的任務子集。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可選) 用於重試請求的重試物件。如果指定為 None，則不會重試請求。
timeout (float | None) – (可選) 等待請求完成的時間（秒）。請注意，如果指定了重試，則超時適用於每次嘗試。
metadata (MetaData) – (可選) 提供給方法的附加元資料。
gcp_conn_id (str) – (可選) 用於連線到 Google Cloud 的連線 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – (可選) 使用短期憑證模擬的服務帳號，或獲取列表中最後一個帳號（將被請求模擬）訪問令牌所需的一系列鏈式帳號。如果設定為字串，則該帳號必須授予源帳號“服務帳號令牌建立者”IAM 角色。如果設定為序列，則列表中的身份必須向直接前一個身份授予“服務帳號令牌建立者”IAM 角色，列表中的第一個帳號將此角色授予源帳號（模板化）。