airflow.providers.google.cloud.operators.cloud_run¶

类¶

`CloudRunCreateJobOperator`	创建一个作业而不执行它。将创建的作业推送到 xcom。
`CloudRunUpdateJobOperator`	更新作业并等待操作完成。将更新后的作业推送到 xcom。
`CloudRunDeleteJobOperator`	删除作业并等待操作完成。将删除的作业推送到 xcom。
`CloudRunListJobsOperator`	列出作业。
`CloudRunExecuteJobOperator`	执行作业并等待操作完成。将执行的作业推送到 xcom。
`CloudRunCreateServiceOperator`	创建服务而不执行它。将创建的服务推送到 xcom。
`CloudRunDeleteServiceOperator`	删除服务而不执行它。将删除的服务推送到 xcom。

模块内容¶

class airflow.providers.google.cloud.operators.cloud_run.CloudRunCreateJobOperator(project_id, region, job_name, job, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基础: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

创建一个作业而不执行它。将创建的作业推送到 xcom。

参数:

project_id (str) – 必填。服务所属的 Google Cloud 项目 ID。
region (str) – 必填。服务所属的 Google Cloud 区域 ID。
job_name (str) – 必填。要创建的作业名称。
job (dict | google.cloud.run_v2.Job) – 必填。包含要提交的作业配置的作业描述符。
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 使用短期凭据模拟的可选服务帐号，或者获取列表中最后一个帐号的 access_token 所需的帐号链列表，该帐号将在请求中被模拟。如果设置为字符串，则该帐号必须向原始帐号授予 Service Account Token Creator IAM 角色。如果设置为序列，则列表中的身份必须向直接前一个身份授予 Service Account Token Creator IAM 角色，列表中第一个帐号将此角色授予原始帐号（模板化）。

template_fields = ('project_id', 'region', 'gcp_conn_id', 'impersonation_chain', 'job_name')[source]¶

project_id[source]¶

region[source]¶

job_name[source]¶

job[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

创建操作符时派生。

Context 与渲染 Jinja 模板时使用的字典相同。

有关更多 context，请参阅 get_template_context。

class airflow.providers.google.cloud.operators.cloud_run.CloudRunUpdateJobOperator(project_id, region, job_name, job, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基础: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

更新作业并等待操作完成。将更新后的作业推送到 xcom。

参数:

project_id (str) – 必填。服务所属的 Google Cloud 项目 ID。
region (str) – 必填。服务所属的 Google Cloud 区域 ID。
job_name (str) – 必填。要更新的作业名称。
job (dict | google.cloud.run_v2.Job) – 必填。包含要更新的作业的新配置的作业描述符。name 字段将被 job_name 替换
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 使用短期凭据模拟的可选服务帐号，或者获取列表中最后一个帐号的 access_token 所需的帐号链列表，该帐号将在请求中被模拟。如果设置为字符串，则该帐号必须向原始帐号授予 Service Account Token Creator IAM 角色。如果设置为序列，则列表中的身份必须向直接前一个身份授予 Service Account Token Creator IAM 角色，列表中第一个帐号将此角色授予原始帐号（模板化）。

template_fields = ('project_id', 'region', 'gcp_conn_id', 'impersonation_chain', 'job_name')[source]¶

project_id[source]¶

region[source]¶

job_name[source]¶

job[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

创建操作符时派生。

Context 与渲染 Jinja 模板时使用的字典相同。

有关更多 context，请参阅 get_template_context。

class airflow.providers.google.cloud.operators.cloud_run.CloudRunDeleteJobOperator(project_id, region, job_name, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基础: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

删除作业并等待操作完成。将删除的作业推送到 xcom。

参数:

project_id (str) – 必填。服务所属的 Google Cloud 项目 ID。
region (str) – 必填。服务所属的 Google Cloud 区域 ID。
job_name (str) – 必填。要删除的作业名称。
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 使用短期凭据模拟的可选服务帐号，或者获取列表中最后一个帐号的 access_token 所需的帐号链列表，该帐号将在请求中被模拟。如果设置为字符串，则该帐号必须向原始帐号授予 Service Account Token Creator IAM 角色。如果设置为序列，则列表中的身份必须向直接前一个身份授予 Service Account Token Creator IAM 角色，列表中第一个帐号将此角色授予原始帐号（模板化）。

template_fields = ('project_id', 'region', 'gcp_conn_id', 'impersonation_chain', 'job_name')[source]¶

project_id[source]¶

region[source]¶

job_name[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

创建操作符时派生。

Context 与渲染 Jinja 模板时使用的字典相同。

有关更多 context，请参阅 get_template_context。

class airflow.providers.google.cloud.operators.cloud_run.CloudRunListJobsOperator(project_id, region, show_deleted=False, limit=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基础: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

列出作业。

参数:

project_id (str) – 必填。服务所属的 Google Cloud 项目 ID。
region (str) – 必填。服务所属的 Google Cloud 区域 ID。
show_deleted (bool) – 如果为 true，则返回已删除（但未过期）的资源以及活动的资源。
limit (int | None) – 要列出的作业数量。如果留空，则返回所有作业。
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 使用短期凭据模拟的可选服务帐号，或者获取列表中最后一个帐号的 access_token 所需的帐号链列表，该帐号将在请求中被模拟。如果设置为字符串，则该帐号必须向原始帐号授予 Service Account Token Creator IAM 角色。如果设置为序列，则列表中的身份必须向直接前一个身份授予 Service Account Token Creator IAM 角色，列表中第一个帐号将此角色授予原始帐号（模板化）。

template_fields = ('project_id', 'region', 'gcp_conn_id', 'impersonation_chain')[source]¶

project_id[source]¶

region[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

show_deleted = False[source]¶

limit = None[source]¶

execute(context)[source]¶

创建操作符时派生。

Context 与渲染 Jinja 模板时使用的字典相同。

有关更多 context，请参阅 get_template_context。

class airflow.providers.google.cloud.operators.cloud_run.CloudRunExecuteJobOperator(project_id, region, job_name, overrides=None, polling_period_seconds=10, timeout_seconds=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)[source]¶

基础: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

执行作业并等待操作完成。将执行的作业推送到 xcom。

参数:

project_id (str) – 必填。服务所属的 Google Cloud 项目 ID。
region (str) – 必填。服务所属的 Google Cloud 区域 ID。
job_name (str) – 必填。要更新的作业名称。
overrides (dict[str, Any] | None) – 可选的覆盖值映射。
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
polling_period_seconds (float) – 可选。控制可推迟运行结果的轮询频率。默认情况下，触发器每 10 秒轮询一次。
timeout_seconds (float | None) – 可选。此请求的超时时间（秒）。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 使用短期凭据模拟的可选服务帐号，或者获取列表中最后一个帐号的 access_token 所需的帐号链列表，该帐号将在请求中被模拟。如果设置为字符串，则该帐号必须向原始帐号授予 Service Account Token Creator IAM 角色。如果设置为序列，则列表中的身份必须向直接前一个身份授予 Service Account Token Creator IAM 角色，列表中第一个帐号将此角色授予原始帐号（模板化）。
deferrable (bool) – 在可推迟模式下运行操作符。

template_fields = ('project_id', 'region', 'gcp_conn_id', 'impersonation_chain', 'job_name', 'overrides')[source]¶

project_id[source]¶

region[source]¶

job_name[source]¶

overrides = None[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

polling_period_seconds = 10[source]¶

timeout_seconds : float | None = None[source]¶

deferrable : bool = True[source]¶

operation: google.api_core.operation.Operation | None = None[source]¶

execute(context)[source]¶

创建操作符时派生。

Context 与渲染 Jinja 模板时使用的字典相同。

有关更多 context，请参阅 get_template_context。

execute_complete(context, event)[source]¶

class airflow.providers.google.cloud.operators.cloud_run.CloudRunCreateServiceOperator(project_id, region, service_name, service, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基础: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

创建服务而不执行它。将创建的服务推送到 xcom。

参数:

project_id (str) – 必填。服务所属的 Google Cloud 项目 ID。
region (str) – 必填。服务所属的 Google Cloud 区域 ID。
service_name (str) – 必填。要创建的服务名称。
service (dict | google.cloud.run_v2.Service) – 包含要提交的服务配置的服务描述符。
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 使用短期凭据模拟的可选服务帐号，或者获取列表中最后一个帐号的 access_token 所需的帐号链列表，该帐号将在请求中被模拟。如果设置为字符串，则该帐号必须向原始帐号授予 Service Account Token Creator IAM 角色。如果设置为序列，则列表中的身份必须向直接前一个身份授予 Service Account Token Creator IAM 角色，列表中第一个帐号将此角色授予原始帐号（模板化）。

template_fields = ('project_id', 'region', 'gcp_conn_id', 'impersonation_chain', 'service_name')[source]¶

project_id[source]¶

region[source]¶

service[source]¶

service_name[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

创建操作符时派生。

Context 与渲染 Jinja 模板时使用的字典相同。

有关更多 context，请参阅 get_template_context。

类 airflow.providers.google.cloud.operators.cloud_run.CloudRunDeleteServiceOperator(project_id, region, service_name, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

基础: airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

删除服务而不执行它。将删除的服务推送到 xcom。

参数:

project_id (str) – 必填。服务所属的 Google Cloud 项目 ID。
region (str) – 必填。服务所属的 Google Cloud 区域 ID。
service_name (str) – 必填。要创建的服务名称。
gcp_conn_id (str) – 用于连接到 Google Cloud 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 使用短期凭据模拟的可选服务帐号，或者获取列表中最后一个帐号的 access_token 所需的帐号链列表，该帐号将在请求中被模拟。如果设置为字符串，则该帐号必须向原始帐号授予 Service Account Token Creator IAM 角色。如果设置为序列，则列表中的身份必须向直接前一个身份授予 Service Account Token Creator IAM 角色，列表中第一个帐号将此角色授予原始帐号（模板化）。

template_fields = ('project_id', 'region', 'gcp_conn_id', 'impersonation_chain', 'service_name')[source]¶

project_id[source]¶

region[source]¶

service_name[source]¶

gcp_conn_id = 'google_cloud_default'[source]¶

impersonation_chain = None[source]¶

execute(context)[source]¶

创建操作符时派生。

Context 与渲染 Jinja 模板时使用的字典相同。

有关更多 context，请参阅 get_template_context。