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 角色，列表中的第一个帐号将此角色授予源帐号（模板化）。