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

Operators that integrates with Google Cloud Build service.

Module Contents¶

Classes¶

`CloudBuildCancelBuildOperator`	Cancels a build in progress.
`CloudBuildCreateBuildOperator`	Starts a build with the specified configuration.
`CloudBuildCreateBuildTriggerOperator`	Creates a new BuildTrigger.
`CloudBuildDeleteBuildTriggerOperator`	Deletes a BuildTrigger by its project ID and trigger ID.
`CloudBuildGetBuildOperator`	Returns information about a previously requested build.
`CloudBuildGetBuildTriggerOperator`	Returns information about a BuildTrigger.
`CloudBuildListBuildTriggersOperator`	Lists existing BuildTriggers.
`CloudBuildListBuildsOperator`	Lists previously requested builds.
`CloudBuildRetryBuildOperator`	Creates a new build based on the specified build. This method creates a new build
`CloudBuildRunBuildTriggerOperator`	Runs a BuildTrigger at a particular source revision.
`CloudBuildUpdateBuildTriggerOperator`	Updates a BuildTrigger by its project ID and trigger ID.
`BuildProcessor`	Processes build configurations to add additional functionality to support the use of operators.

Attributes¶

REGEX_REPO_PATH

airflow.providers.google.cloud.operators.cloud_build.REGEX_REPO_PATH[source]¶

class airflow.providers.google.cloud.operators.cloud_build.CloudBuildCancelBuildOperator(*, id_, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Cancels a build in progress.

See also

For more information on how to use this operator, take a look at the guide: CloudBuildCancelBuildOperator

Parameters

id – The ID of the build.
project_id (str | None) – Optional, Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the GCP connection is used.
retry (Retry | _MethodDefault) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (float | None) – Optional, the amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (Sequence[tuple[str, str]]) – Optional, additional metadata that is provided to the method.
gcp_conn_id (str) – Optional, the connection ID used to connect to Google Cloud Platform.
impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['project_id', 'id_', 'gcp_conn_id'][source]¶

operator_extra_links[source]¶

execute(context)[source]¶

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_build.CloudBuildCreateBuildOperator(*, build, project_id=None, wait=True, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, delegate_to=None, poll_interval=4.0, deferrable=False, **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Starts a build with the specified configuration.

See also

For more information on how to use this operator, take a look at the guide: CloudBuildCreateBuildOperator

Parameters

build (dict | Build) – The build resource to create. If a dict is provided, it must be of the same form as the protobuf message google.cloud.devtools.cloudbuild_v1.types.Build.
project_id (str | None) – Optional, Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the GCP connection is used.
wait (bool) – Optional, wait for operation to finish.
retry (Retry | _MethodDefault) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (float | None) – Optional, the amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (Sequence[tuple[str, str]]) – Optional, additional metadata that is provided to the method.
gcp_conn_id (str) – Optional, the connection ID used to connect to Google Cloud Platform.
impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).
delegate_to (str | None) – The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.
retry – Designation of what errors, if any, should be retried.
timeout – The timeout for this request.
metadata – Strings which should be sent along with the request as metadata.
deferrable (bool) – Run operator in the deferrable mode

template_fields :Sequence[str] = ['project_id', 'build', 'gcp_conn_id', 'impersonation_chain'][source]¶

operator_extra_links[source]¶

prepare_template()[source]¶

Hook triggered after the templated fields get replaced by their content.

If you need your object to alter the content of the file before the template is rendered, it should override this method to do so.

execute(context)[source]¶

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

execute_complete(context, event)[source]¶

class airflow.providers.google.cloud.operators.cloud_build.CloudBuildCreateBuildTriggerOperator(*, trigger, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Creates a new BuildTrigger.

See also

For more information on how to use this operator, take a look at the guide: CloudBuildCreateBuildTriggerOperator

Parameters

trigger (dict | BuildTrigger) – The BuildTrigger to create. If a dict is provided, it must be of the same form as the protobuf message google.cloud.devtools.cloudbuild_v1.types.BuildTrigger
project_id (str | None) – Optional, Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the GCP connection is used.
retry (Retry | _MethodDefault) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (float | None) – Optional, the amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (Sequence[tuple[str, str]]) – Optional, additional metadata that is provided to the method.
gcp_conn_id (str) – Optional, the connection ID used to connect to Google Cloud Platform.
impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['project_id', 'trigger', 'gcp_conn_id'][source]¶

operator_extra_links[source]¶

execute(context)[source]¶

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_build.CloudBuildDeleteBuildTriggerOperator(*, trigger_id, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Deletes a BuildTrigger by its project ID and trigger ID.

See also

For more information on how to use this operator, take a look at the guide: CloudBuildDeleteBuildTriggerOperator

Parameters

trigger_id (str) – The ID of the BuildTrigger to delete.
project_id (str | None) – Optional, Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the GCP connection is used.
retry (Retry | _MethodDefault) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (float | None) – Optional, the amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (Sequence[tuple[str, str]]) – Optional, additional metadata that is provided to the method.
gcp_conn_id (str) – Optional, the connection ID used to connect to Google Cloud Platform.
impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['project_id', 'trigger_id', 'gcp_conn_id'][source]¶

operator_extra_links[source]¶

execute(context)[source]¶

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_build.CloudBuildGetBuildOperator(*, id_, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Returns information about a previously requested build.

See also

For more information on how to use this operator, take a look at the guide: CloudBuildGetBuildOperator

Parameters

id – The ID of the build.
project_id (str | None) – Optional, Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the GCP connection is used.
retry (Retry | _MethodDefault) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (float | None) – Optional, the amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (Sequence[tuple[str, str]]) – Optional, additional metadata that is provided to the method.
gcp_conn_id (str) – Optional, the connection ID used to connect to Google Cloud Platform.
impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['project_id', 'id_', 'gcp_conn_id'][source]¶

operator_extra_links[source]¶

execute(context)[source]¶

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_build.CloudBuildGetBuildTriggerOperator(*, trigger_id, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Returns information about a BuildTrigger.

See also

For more information on how to use this operator, take a look at the guide: CloudBuildGetBuildTriggerOperator

Parameters

trigger_id (str) – The ID of the BuildTrigger to get.
project_id (str | None) – Optional, Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the GCP connection is used.
retry (Retry | _MethodDefault) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (float | None) – Optional, the amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (Sequence[tuple[str, str]]) – Optional, additional metadata that is provided to the method.
gcp_conn_id (str) – Optional, the connection ID used to connect to Google Cloud Platform.
impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['project_id', 'trigger_id', 'gcp_conn_id'][source]¶

operator_extra_links[source]¶

execute(context)[source]¶

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_build.CloudBuildListBuildTriggersOperator(*, location, project_id=None, page_size=None, page_token=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Lists existing BuildTriggers.

See also

For more information on how to use this operator, take a look at the guide: CloudBuildListBuildTriggersOperator

Parameters

location (str) – The location of the project.
project_id (str | None) – Optional, Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the GCP connection is used.
page_size (int | None) – Optional, number of results to return in the list.
page_token (str | None) – Optional, token to provide to skip to a particular spot in the list.
retry (Retry | _MethodDefault) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (float | None) – Optional, the amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (Sequence[tuple[str, str]]) – Optional, additional metadata that is provided to the method.
gcp_conn_id (str) – Optional, the connection ID used to connect to Google Cloud Platform.
impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['location', 'project_id', 'gcp_conn_id'][source]¶

operator_extra_links[source]¶

execute(context)[source]¶

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_build.CloudBuildListBuildsOperator(*, location, project_id=None, page_size=None, filter_=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Lists previously requested builds.

See also

For more information on how to use this operator, take a look at the guide: CloudBuildListBuildsOperator

Parameters

location (str) – The location of the project.
project_id (str | None) – Optional, Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the GCP connection is used.
page_size (int | None) – Optional, number of results to return in the list.
filter – Optional, the raw filter text to constrain the results.
retry (Retry | _MethodDefault) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (float | None) – Optional, the amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (Sequence[tuple[str, str]]) – Optional, additional metadata that is provided to the method.
gcp_conn_id (str) – Optional, the connection ID used to connect to Google Cloud Platform.
impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['location', 'project_id', 'gcp_conn_id'][source]¶

operator_extra_links[source]¶

execute(context)[source]¶

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_build.CloudBuildRetryBuildOperator(*, id_, project_id=None, wait=True, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build.

See also

For more information on how to use this operator, take a look at the guide: CloudBuildRetryBuildOperator

Parameters

id – Build ID of the original build.
project_id (str | None) – Optional, Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the GCP connection is used.
wait (bool) – Optional, wait for operation to finish.
retry (Retry | _MethodDefault) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (float | None) – Optional, the amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (Sequence[tuple[str, str]]) – Optional, additional metadata that is provided to the method.
gcp_conn_id (str) – Optional, the connection ID used to connect to Google Cloud Platform.
impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['project_id', 'id_', 'gcp_conn_id'][source]¶

operator_extra_links[source]¶

execute(context)[source]¶

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_build.CloudBuildRunBuildTriggerOperator(*, trigger_id, source, project_id=None, wait=True, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Runs a BuildTrigger at a particular source revision.

See also

For more information on how to use this operator, take a look at the guide: CloudBuildRunBuildTriggerOperator

Parameters

trigger_id (str) – The ID of the trigger.
source (dict | RepoSource) – Source to build against this trigger. If a dict is provided, it must be of the same form as the protobuf message google.cloud.devtools.cloudbuild_v1.types.RepoSource
project_id (str | None) – Optional, Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the GCP connection is used.
wait (bool) – Optional, wait for operation to finish.
retry (Retry | _MethodDefault) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (float | None) – Optional, the amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (Sequence[tuple[str, str]]) – Optional, additional metadata that is provided to the method.
gcp_conn_id (str) – Optional, the connection ID used to connect to Google Cloud Platform.
impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['project_id', 'trigger_id', 'source', 'gcp_conn_id'][source]¶

operator_extra_links[source]¶

execute(context)[source]¶

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_build.CloudBuildUpdateBuildTriggerOperator(*, trigger_id, trigger, project_id=None, retry=DEFAULT, timeout=None, metadata=(), gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Updates a BuildTrigger by its project ID and trigger ID.

See also

For more information on how to use this operator, take a look at the guide: CloudBuildUpdateBuildTriggerOperator

Parameters

trigger_id (str) – The ID of the trigger.
trigger (dict | BuildTrigger) – The BuildTrigger to create. If a dict is provided, it must be of the same form as the protobuf message google.cloud.devtools.cloudbuild_v1.types.BuildTrigger
project_id (str | None) – Optional, Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the GCP connection is used.
retry (Retry | _MethodDefault) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (float | None) – Optional, the amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata (Sequence[tuple[str, str]]) – Optional, additional metadata that is provided to the method.
gcp_conn_id (str) – Optional, the connection ID used to connect to Google Cloud Platform.
impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields :Sequence[str] = ['project_id', 'trigger_id', 'trigger', 'gcp_conn_id'][source]¶

operator_extra_links[source]¶

execute(context)[source]¶

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.google.cloud.operators.cloud_build.BuildProcessor(build)[source]¶

Processes build configurations to add additional functionality to support the use of operators. The following improvements are made: * It is required to provide the source and only one type can be given, * It is possible to provide the source as the URL address instead dict.

Parameters: build (dict | Build) – The request body of the build. See: https://cloud.google.com/cloud-build/docs/api/reference/rest/Shared.Types/Build

process_body()[source]¶

Processes the body passed in the constructor

Returns: the body.
Return type: google.cloud.devtools.cloudbuild_v1.types.Build

airflow.providers.google.cloud.operators.cloud_build¶

Module Contents¶

Classes¶

Attributes¶

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