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