`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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 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)[源代码]¶

在创建操作符时派生。

上下文与渲染 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)[source]¶

基类：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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 access_token 将在请求中被模拟。如果设置为字符串，则该帐户必须授予发起帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的标识必须将“服务帐户令牌创建者”IAM 角色授予紧接在前的标识，列表中的第一个帐户将此角色授予发起帐户（可模板化）。

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

operator_extra_links = ()[source]¶

execute(context)[source]¶

在创建操作符时派生。

上下文与渲染 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)[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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 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]¶

在创建操作符时派生。

上下文与渲染 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)[source]¶

基类：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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 access_token 将在请求中被模拟。如果设置为字符串，则该帐户必须授予发起帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的标识必须将“服务帐户令牌创建者”IAM 角色授予紧接在前的标识，列表中的第一个帐户将此角色授予发起帐户（可模板化）。

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

operator_extra_links = ()[source]¶

execute(context)[source]¶

在创建操作符时派生。

上下文与渲染 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)[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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 access_token 将在请求中被模拟。如果设置为字符串，则该帐户必须授予发起帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的标识必须将“服务帐户令牌创建者”IAM 角色授予紧接在前的标识，列表中的第一个帐户将此角色授予发起帐户（可模板化）。

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

execute(context)[source]¶

在创建操作符时派生。

上下文与渲染 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)[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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 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]¶

在创建操作符时派生。

上下文与渲染 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)[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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 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]¶

在创建操作符时派生。

上下文与渲染 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 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]¶

在创建操作符时派生。

上下文与渲染 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) – (可选) 此字段指定将返回的任务子集。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 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]¶

在创建操作符时派生。

上下文与渲染 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) – (可选) 此字段指定将返回的任务子集。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 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]¶

在创建操作符时派生。

上下文与渲染 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) – (可选) 此字段指定将返回的任务子集。
page_size (int | None) – (可选) 底层 API 响应中包含的最大资源数。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 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]¶

在创建操作符时派生。

上下文与渲染 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) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 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]¶

在创建操作符时派生。

上下文与渲染 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) – (可选) 此字段指定将返回的任务子集。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (可选) 用于重试请求的重试对象。如果未指定，则不会重试请求。
timeout (float | None) – (可选) 等待请求完成的时间（以秒为单位）。请注意，如果指定了重试，则超时应用于每个单独的尝试。
metadata (MetaData) – (可选) 提供给方法的其他元数据。
gcp_conn_id (str) – (可选) 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链式列表，该 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]¶

在创建操作符时派生。

上下文与渲染 jinja 模板时使用的字典相同。

有关更多上下文，请参阅 get_template_context。

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

模块内容¶

类¶

属性¶

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