airflow.providers.google.cloud.operators.cloud_build¶
与 Google Cloud Build 服务集成的操作符。
属性¶
类¶
取消正在进行的构建。 |
|
使用指定的配置启动构建。 |
|
创建新的 BuildTrigger。 |
|
按项目 ID 和触发器 ID 删除 BuildTrigger。 |
|
返回先前请求的构建信息。 |
|
返回 BuildTrigger 信息。 |
|
列出现有的 BuildTrigger。 |
|
列出先前请求的构建。 |
|
使用原始构建请求创建新构建,这可能导致或不导致相同的构建。 |
|
在特定的源修订版本上运行 BuildTrigger。 |
|
按项目 ID 和触发器 ID 更新 BuildTrigger。 |
|
处理构建配置以添加额外功能,从而支持操作符的使用。 |
模块内容¶
- class airflow.providers.google.cloud.operators.cloud_build.CloudBuildCancelBuildOperator(*, id_, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, location='global', **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
取消正在进行的构建。
另请参阅
有关如何使用此操作符的更多信息,请参阅指南: CloudBuildCancelBuildOperator
- 参数:
id – 构建的 ID。
project_id (str) – 可选,函数所属的 Google Cloud Project project_id。如果设置为 None 或缺失,则使用 GCP 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选,用于重试请求的重试对象。如果指定 None,则不会重试请求。
timeout (float | None) – 可选,等待请求完成的时间量(秒)。请注意,如果指定了 retry,则超时应用于每个单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选,提供给方法的额外元数据。
gcp_conn_id (str) – 可选,用于连接 Google Cloud Platform 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭证进行身份模拟,或者获取列表中最后一个账号 access_token 所需的链式账号列表,该账号将在请求中进行身份模拟。如果设置为字符串,则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予紧前身份,列表中第一个账号将此角色授予发起账号(模板化)。
location (str) – 项目的位置。
- template_fields: collections.abc.Sequence[str] = ('project_id', 'id_', 'gcp_conn_id', 'location')[source]¶
- class airflow.providers.google.cloud.operators.cloud_build.CloudBuildCreateBuildOperator(*, build, project_id=PROVIDE_PROJECT_ID, wait=True, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, poll_interval=4.0, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), location='global', **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
使用指定的配置启动构建。
另请参阅
有关如何使用此操作符的更多信息,请参阅指南: CloudBuildCreateBuildOperator
- 参数:
build (dict | google.cloud.devtools.cloudbuild_v1.types.Build) – 要创建的构建资源。如果提供 dict,其形式必须与 protobuf 消息 google.cloud.devtools.cloudbuild_v1.types.Build 的形式相同。
project_id (str) – 可选,函数所属的 Google Cloud Project project_id。如果设置为 None 或缺失,则使用 GCP 连接中的默认 project_id。
wait (bool) – 可选,等待操作完成。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选,用于重试请求的重试对象。如果指定 None,则不会重试请求。
timeout (float | None) – 可选,等待请求完成的时间量(秒)。请注意,如果指定了 retry,则超时应用于每个单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选,提供给方法的额外元数据。
gcp_conn_id (str) – 可选,用于连接 Google Cloud Platform 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭证进行身份模拟,或者获取列表中最后一个账号 access_token 所需的链式账号列表,该账号将在请求中进行身份模拟。如果设置为字符串,则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予紧前身份,列表中第一个账号将此角色授予发起账号(模板化)。
retry – 指定哪些错误(如果有)应被重试。
timeout – 此请求的超时时间。
metadata – 应随请求作为元数据发送的字符串。
deferrable (bool) – 在可推迟模式下运行操作符
location (str) – 项目的位置。
- template_fields: collections.abc.Sequence[str] = ('project_id', 'build', 'gcp_conn_id', 'impersonation_chain', 'location')[source]¶
- class airflow.providers.google.cloud.operators.cloud_build.CloudBuildCreateBuildTriggerOperator(*, trigger, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, location='global', **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
创建新的 BuildTrigger。
另请参阅
有关如何使用此操作符的更多信息,请参阅指南: CloudBuildCreateBuildTriggerOperator
- 参数:
trigger (dict | google.cloud.devtools.cloudbuild_v1.types.BuildTrigger) – 要创建的 BuildTrigger。如果提供 dict,其形式必须与 protobuf 消息 google.cloud.devtools.cloudbuild_v1.types.BuildTrigger 的形式相同
project_id (str) – 可选,函数所属的 Google Cloud Project project_id。如果设置为 None 或缺失,则使用 GCP 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选,用于重试请求的重试对象。如果指定 None,则不会重试请求。
timeout (float | None) – 可选,等待请求完成的时间量(秒)。请注意,如果指定了 retry,则超时应用于每个单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选,提供给方法的额外元数据。
gcp_conn_id (str) – 可选,用于连接 Google Cloud Platform 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭证进行身份模拟,或者获取列表中最后一个账号 access_token 所需的链式账号列表,该账号将在请求中进行身份模拟。如果设置为字符串,则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予紧前身份,列表中第一个账号将此角色授予发起账号(模板化)。
location (str) – 项目的位置。
- template_fields: collections.abc.Sequence[str] = ('project_id', 'trigger', 'gcp_conn_id', 'location')[source]¶
- 类 airflow.providers.google.cloud.operators.cloud_build.CloudBuildDeleteBuildTriggerOperator(*, trigger_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, location='global', **kwargs)[源]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
按项目 ID 和触发器 ID 删除 BuildTrigger。
另请参阅
有关如何使用此 operator 的更多信息,请参阅指南: CloudBuildDeleteBuildTriggerOperator
- 参数:
trigger_id (str) – 要删除的 BuildTrigger 的 ID。
project_id (str) – 可选,函数所属的 Google Cloud Project project_id。如果设置为 None 或缺失,则使用 GCP 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选,用于重试请求的重试对象。如果指定 None,则不会重试请求。
timeout (float | None) – 可选,等待请求完成的时间量(秒)。请注意,如果指定了 retry,则超时应用于每个单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选,提供给方法的额外元数据。
gcp_conn_id (str) – 可选,用于连接 Google Cloud Platform 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭证进行身份模拟,或者获取列表中最后一个账号 access_token 所需的链式账号列表,该账号将在请求中进行身份模拟。如果设置为字符串,则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予紧前身份,列表中第一个账号将此角色授予发起账号(模板化)。
location (str) – 项目的位置。
- template_fields: collections.abc.Sequence[str] = ('project_id', 'trigger_id', 'gcp_conn_id', 'location')[源]¶
- 类 airflow.providers.google.cloud.operators.cloud_build.CloudBuildGetBuildOperator(*, id_, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, location='global', **kwargs)[源]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
返回先前请求的构建信息。
另请参阅
有关如何使用此 operator 的更多信息,请参阅指南: CloudBuildGetBuildOperator
- 参数:
id – 构建的 ID。
project_id (str) – 可选,函数所属的 Google Cloud Project project_id。如果设置为 None 或缺失,则使用 GCP 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选,用于重试请求的重试对象。如果指定 None,则不会重试请求。
timeout (float | None) – 可选,等待请求完成的时间量(秒)。请注意,如果指定了 retry,则超时应用于每个单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选,提供给方法的额外元数据。
gcp_conn_id (str) – 可选,用于连接 Google Cloud Platform 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭证进行身份模拟,或者获取列表中最后一个账号 access_token 所需的链式账号列表,该账号将在请求中进行身份模拟。如果设置为字符串,则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予紧前身份,列表中第一个账号将此角色授予发起账号(模板化)。
location (str) – 项目的位置。
- template_fields: collections.abc.Sequence[str] = ('project_id', 'id_', 'gcp_conn_id', 'location')[源]¶
- 类 airflow.providers.google.cloud.operators.cloud_build.CloudBuildGetBuildTriggerOperator(*, trigger_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, location='global', **kwargs)[源]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
返回 BuildTrigger 信息。
另请参阅
有关如何使用此 operator 的更多信息,请参阅指南: CloudBuildGetBuildTriggerOperator
- 参数:
trigger_id (str) – 要获取的 BuildTrigger 的 ID。
project_id (str) – 可选,函数所属的 Google Cloud Project project_id。如果设置为 None 或缺失,则使用 GCP 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选,用于重试请求的重试对象。如果指定 None,则不会重试请求。
timeout (float | None) – 可选,等待请求完成的时间量(秒)。请注意,如果指定了 retry,则超时应用于每个单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选,提供给方法的额外元数据。
gcp_conn_id (str) – 可选,用于连接 Google Cloud Platform 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭证进行身份模拟,或者获取列表中最后一个账号 access_token 所需的链式账号列表,该账号将在请求中进行身份模拟。如果设置为字符串,则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予紧前身份,列表中第一个账号将此角色授予发起账号(模板化)。
location (str) – 项目的位置。
- template_fields: collections.abc.Sequence[str] = ('project_id', 'trigger_id', 'gcp_conn_id', 'location')[源]¶
- 类 airflow.providers.google.cloud.operators.cloud_build.CloudBuildListBuildTriggersOperator(*, location='global', project_id=PROVIDE_PROJECT_ID, page_size=None, page_token=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[源]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
列出现有的 BuildTrigger。
另请参阅
有关如何使用此 operator 的更多信息,请参阅指南: CloudBuildListBuildTriggersOperator
- 参数:
location (str) – 项目的位置。
project_id (str) – 可选,函数所属的 Google Cloud Project project_id。如果设置为 None 或缺失,则使用 GCP 连接中的默认 project_id。
page_size (int | None) – 可选,列表中返回的结果数量。
page_token (str | None) – 可选,用于跳转到列表中特定位置的令牌。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选,用于重试请求的重试对象。如果指定 None,则不会重试请求。
timeout (float | None) – 可选,等待请求完成的时间量(秒)。请注意,如果指定了 retry,则超时应用于每个单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选,提供给方法的额外元数据。
gcp_conn_id (str) – 可选,用于连接 Google Cloud Platform 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭证进行身份模拟,或者获取列表中最后一个账号 access_token 所需的链式账号列表,该账号将在请求中进行身份模拟。如果设置为字符串,则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予紧前身份,列表中第一个账号将此角色授予发起账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'project_id', 'gcp_conn_id')[源]¶
- 类 airflow.providers.google.cloud.operators.cloud_build.CloudBuildListBuildsOperator(*, location='global', project_id=PROVIDE_PROJECT_ID, page_size=None, filter_=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[源]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
列出先前请求的构建。
另请参阅
有关如何使用此 operator 的更多信息,请参阅指南: CloudBuildListBuildsOperator
- 参数:
location (str) – 项目的位置。
project_id (str) – 可选,函数所属的 Google Cloud Project project_id。如果设置为 None 或缺失,则使用 GCP 连接中的默认 project_id。
page_size (int | None) – 可选,列表中返回的结果数量。
filter – 可选,用于限制结果的原始过滤文本。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选,用于重试请求的重试对象。如果指定 None,则不会重试请求。
timeout (float | None) – 可选,等待请求完成的时间量(秒)。请注意,如果指定了 retry,则超时应用于每个单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选,提供给方法的额外元数据。
gcp_conn_id (str) – 可选,用于连接 Google Cloud Platform 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭证进行身份模拟,或者获取列表中最后一个账号 access_token 所需的链式账号列表,该账号将在请求中进行身份模拟。如果设置为字符串,则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予紧前身份,列表中第一个账号将此角色授予发起账号(模板化)。
- template_fields: collections.abc.Sequence[str] = ('location', 'project_id', 'gcp_conn_id')[源]¶
- class airflow.providers.google.cloud.operators.cloud_build.CloudBuildRetryBuildOperator(*, id_, project_id=PROVIDE_PROJECT_ID, wait=True, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, location='global', **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
使用原始构建请求创建新构建,这可能导致或不导致相同的构建。
另请参阅
有关如何使用此运算符的更多信息,请参阅指南: CloudBuildRetryBuildOperator
- 参数:
id – 原始构建的构建 ID。
project_id (str) – 可选,函数所属的 Google Cloud Project project_id。如果设置为 None 或缺失,则使用 GCP 连接中的默认 project_id。
wait (bool) – 可选,等待操作完成。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选,用于重试请求的重试对象。如果指定 None,则不会重试请求。
timeout (float | None) – 可选,等待请求完成的时间量(秒)。请注意,如果指定了 retry,则超时应用于每个单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选,提供给方法的额外元数据。
gcp_conn_id (str) – 可选,用于连接 Google Cloud Platform 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭证进行身份模拟,或者获取列表中最后一个账号 access_token 所需的链式账号列表,该账号将在请求中进行身份模拟。如果设置为字符串,则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予紧前身份,列表中第一个账号将此角色授予发起账号(模板化)。
location (str) – 项目的位置。
- template_fields: collections.abc.Sequence[str] = ('project_id', 'id_', 'gcp_conn_id', 'location')[source]¶
- class airflow.providers.google.cloud.operators.cloud_build.CloudBuildRunBuildTriggerOperator(*, trigger_id, source, project_id=PROVIDE_PROJECT_ID, wait=True, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, location='global', **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
在特定的源修订版本上运行 BuildTrigger。
另请参阅
有关如何使用此运算符的更多信息,请参阅指南: CloudBuildRunBuildTriggerOperator
- 参数:
trigger_id (str) – 触发器的 ID。
source (dict | google.cloud.devtools.cloudbuild_v1.types.RepoSource) – 针对此触发器构建的源。如果提供字典,则其形式必须与 protobuf 消息 google.cloud.devtools.cloudbuild_v1.types.RepoSource 相同
project_id (str) – 可选,函数所属的 Google Cloud Project project_id。如果设置为 None 或缺失,则使用 GCP 连接中的默认 project_id。
wait (bool) – 可选,等待操作完成。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选,用于重试请求的重试对象。如果指定 None,则不会重试请求。
timeout (float | None) – 可选,等待请求完成的时间量(秒)。请注意,如果指定了 retry,则超时应用于每个单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选,提供给方法的额外元数据。
gcp_conn_id (str) – 可选,用于连接 Google Cloud Platform 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭证进行身份模拟,或者获取列表中最后一个账号 access_token 所需的链式账号列表,该账号将在请求中进行身份模拟。如果设置为字符串,则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予紧前身份,列表中第一个账号将此角色授予发起账号(模板化)。
location (str) – 项目的位置。
- template_fields: collections.abc.Sequence[str] = ('project_id', 'trigger_id', 'source', 'gcp_conn_id', 'location')[source]¶
- class airflow.providers.google.cloud.operators.cloud_build.CloudBuildUpdateBuildTriggerOperator(*, trigger_id, trigger, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, location=None, **kwargs)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
按项目 ID 和触发器 ID 更新 BuildTrigger。
另请参阅
有关如何使用此运算符的更多信息,请参阅指南: CloudBuildUpdateBuildTriggerOperator
- 参数:
trigger_id (str) – 触发器的 ID。
trigger (dict | google.cloud.devtools.cloudbuild_v1.types.BuildTrigger) – 要创建的 BuildTrigger。如果提供 dict,其形式必须与 protobuf 消息 google.cloud.devtools.cloudbuild_v1.types.BuildTrigger 的形式相同
project_id (str) – 可选,函数所属的 Google Cloud Project project_id。如果设置为 None 或缺失,则使用 GCP 连接中的默认 project_id。
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 可选,用于重试请求的重试对象。如果指定 None,则不会重试请求。
timeout (float | None) – 可选,等待请求完成的时间量(秒)。请注意,如果指定了 retry,则超时应用于每个单独的尝试。
metadata (collections.abc.Sequence[tuple[str, str]]) – 可选,提供给方法的额外元数据。
gcp_conn_id (str) – 可选,用于连接 Google Cloud Platform 的连接 ID。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务账号,用于使用短期凭证进行身份模拟,或者获取列表中最后一个账号 access_token 所需的链式账号列表,该账号将在请求中进行身份模拟。如果设置为字符串,则该账号必须授予发起账号 Service Account Token Creator IAM 角色。如果设置为序列,则列表中的身份必须将 Service Account Token Creator IAM 角色授予紧前身份,列表中第一个账号将此角色授予发起账号(模板化)。
location (str) – 项目的位置。
- template_fields: collections.abc.Sequence[str] = ('project_id', 'trigger_id', 'trigger', 'gcp_conn_id', 'location')[source]¶
- class airflow.providers.google.cloud.operators.cloud_build.BuildProcessor(build)[source]¶
处理构建配置以添加额外功能,从而支持操作符的使用。
进行了以下改进:* 需要提供源,且只能提供一种类型;* 可以将源提供为 URL 地址而非字典。
- 参数:
build (dict | google.cloud.devtools.cloudbuild_v1.types.Build) – 构建的请求体。参见: https://cloud.google.com/cloud-build/docs/api/reference/rest/Shared.Types/Build