airflow.providers.google.cloud.hooks.cloud_build
¶
Hook for Google Cloud Build service.
Module Contents¶
Classes¶
Hook for the Google Cloud Build Service. |
Attributes¶
- class airflow.providers.google.cloud.hooks.cloud_build.CloudBuildHook(gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None)[source]¶
Bases:
airflow.providers.google.common.hooks.base_google.GoogleBaseHook
Hook for the Google Cloud Build Service.
- Parameters
gcp_conn_id (str) – The connection ID to use when fetching connection info.
delegate_to (Optional[str]) – 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.
impersonation_chain (Optional[Union[str, Sequence[str]]]) – 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.
- get_conn()[source]¶
Retrieves the connection to Google Cloud Build.
- Returns
Google Cloud Build client object.
- Return type
google.cloud.devtools.cloudbuild_v1.CloudBuildClient
- cancel_build(id_, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶
Cancels a build in progress.
- Parameters
id – The ID of the build.
project_id (str) – 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 (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (Optional[float]) – 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.
- Return type
google.cloud.devtools.cloudbuild_v1.types.Build
- create_build(build, project_id=PROVIDE_PROJECT_ID, wait=True, retry=DEFAULT, timeout=None, metadata=())[source]¶
Starts a build with the specified configuration.
- Parameters
build (Union[Dict, google.cloud.devtools.cloudbuild_v1.types.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) – 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 (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (Optional[float]) – 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.
- Return type
google.cloud.devtools.cloudbuild_v1.types.Build
- create_build_trigger(trigger, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶
Creates a new BuildTrigger.
- Parameters
trigger (Union[dict, google.cloud.devtools.cloudbuild_v1.types.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) – 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 (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (Optional[float]) – 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.
- Return type
google.cloud.devtools.cloudbuild_v1.types.BuildTrigger
- delete_build_trigger(trigger_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶
Deletes a BuildTrigger by its project ID and trigger ID.
- Parameters
trigger_id (str) – The ID of the BuildTrigger to delete.
project_id (str) – 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 (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (Optional[float]) – 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.
- get_build(id_, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶
Returns information about a previously requested build.
- Parameters
id – The ID of the build.
project_id (str) – 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 (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (Optional[float]) – 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.
- Return type
google.cloud.devtools.cloudbuild_v1.types.Build
- get_build_trigger(trigger_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]¶
Returns information about a BuildTrigger.
- Parameters
trigger_id (str) – The ID of the BuildTrigger to get.
project_id (str) – 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 (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (Optional[float]) – 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.
- Return type
google.cloud.devtools.cloudbuild_v1.types.BuildTrigger
- list_build_triggers(location, project_id=PROVIDE_PROJECT_ID, page_size=None, page_token=None, retry=DEFAULT, timeout=None, metadata=())[source]¶
Lists existing BuildTriggers.
- Parameters
project_id (str) – 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.
location (str) – The location of the project.
page_size (Optional[int]) – Optional, number of results to return in the list.
page_token (Optional[str]) – Optional, token to provide to skip to a particular spot in the list.
retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (Optional[float]) – 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.
- Return type
google.cloud.devtools.cloudbuild_v1.types.BuildTrigger
- list_builds(location, project_id=PROVIDE_PROJECT_ID, page_size=None, page_token=None, filter_=None, retry=DEFAULT, timeout=None, metadata=())[source]¶
Lists previously requested builds.
- Parameters
project_id (str) – Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the Google Cloud connection is used.
location (str) – The location of the project.
page_size (Optional[int]) – Optional, number of results to return in the list.
page_token (Optional[int]) – Optional, token to provide to skip to a particular spot in the list.
filter – Optional, the raw filter text to constrain the results.
retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (Optional[float]) – 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.
- Return type
List[google.cloud.devtools.cloudbuild_v1.types.Build]
- retry_build(id_, project_id=PROVIDE_PROJECT_ID, wait=True, retry=DEFAULT, timeout=None, metadata=())[source]¶
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.
- Parameters
id – Build ID of the original build.
project_id (str) – 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 (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (Optional[float]) – 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.
- Return type
google.cloud.devtools.cloudbuild_v1.types.Build
- run_build_trigger(trigger_id, source, project_id=PROVIDE_PROJECT_ID, wait=True, retry=DEFAULT, timeout=None, metadata=())[source]¶
Runs a BuildTrigger at a particular source revision.
- Parameters
trigger_id (str) – The ID of the trigger.
source (Union[dict, google.cloud.devtools.cloudbuild_v1.types.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) – 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 (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (Optional[float]) – 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.
- Return type
google.cloud.devtools.cloudbuild_v1.types.Build
- update_build_trigger(trigger_id, trigger, project_id, retry=DEFAULT, timeout=None, metadata=())[source]¶
Updates a BuildTrigger by its project ID and trigger ID.
- Parameters
trigger_id (str) – The ID of the trigger.
trigger (Union[dict, google.cloud.devtools.cloudbuild_v1.types.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) – 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 (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) – Optional, a retry object used to retry requests. If None is specified, requests will not be retried.
timeout (Optional[float]) – 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.
- Return type
google.cloud.devtools.cloudbuild_v1.types.BuildTrigger