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)[源代码]¶
基类:
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')[源代码]¶
- 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)[源代码]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
使用指定的配置启动构建。
参见
有关如何使用此操作符的更多信息,请查看指南: CloudBuildCreateBuildOperator
- 参数
build (dict | google.cloud.devtools.cloudbuild_v1.types.Build) – 要创建的构建资源。如果提供的是字典,则其格式必须与 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) – 项目的位置。
- 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。如果提供的是字典,则其格式必须与 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) – 项目的位置。
- class 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)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
通过项目 ID 和触发器 ID 删除 BuildTrigger。
参见
有关如何使用此操作符的更多信息,请查看指南: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) – 项目的位置。
- class 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)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
返回有关先前请求的构建的信息。
参见
有关如何使用此运算符的更多信息,请查看指南: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')[source]¶
- class 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)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
返回有关 BuildTrigger 的信息。
参见
有关如何使用此运算符的更多信息,请查看指南: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')[source]¶
- class 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)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
列出现有的 BuildTrigger。
参见
有关如何使用此运算符的更多信息,请查看指南: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')[source]¶
- class 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)[source]¶
基类:
airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator
列出先前请求的构建。
参见
有关如何使用此运算符的更多信息,请查看指南: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')[source]¶
- 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='global', **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。如果提供的是字典,则其格式必须与 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