Source code for airflow.providers.google.cloud.operators.cloud_storage_transfer_service

#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
"""This module contains Google Cloud Transfer operators."""
from __future__ import annotations

from copy import deepcopy
from datetime import date, time
from typing import TYPE_CHECKING, Sequence

from airflow.exceptions import AirflowException
from airflow.models import BaseOperator
from airflow.providers.amazon.aws.hooks.base_aws import AwsBaseHook
from airflow.providers.google.cloud.hooks.cloud_storage_transfer_service import (
    ACCESS_KEY_ID,
    AWS_ACCESS_KEY,
    AWS_S3_DATA_SOURCE,
    BUCKET_NAME,
    DAY,
    DESCRIPTION,
    GCS_DATA_SINK,
    GCS_DATA_SOURCE,
    HOURS,
    HTTP_DATA_SOURCE,
    MINUTES,
    MONTH,
    NAME,
    OBJECT_CONDITIONS,
    PATH,
    PROJECT_ID,
    SCHEDULE,
    SCHEDULE_END_DATE,
    SCHEDULE_START_DATE,
    SECONDS,
    SECRET_ACCESS_KEY,
    START_TIME_OF_DAY,
    STATUS,
    TRANSFER_OPTIONS,
    TRANSFER_SPEC,
    YEAR,
    CloudDataTransferServiceHook,
    GcpTransferJobsStatus,
)
from airflow.providers.google.cloud.links.cloud_storage_transfer import (
    CloudStorageTransferDetailsLink,
    CloudStorageTransferJobLink,
    CloudStorageTransferListLink,
)
from airflow.providers.google.cloud.utils.helpers import normalize_directory_path

if TYPE_CHECKING:
    from airflow.utils.context import Context


[docs]class TransferJobPreprocessor: """Helper class for preprocess of transfer job body.""" def __init__(self, body: dict, aws_conn_id: str = "aws_default", default_schedule: bool = False) -> None: self.body = body self.aws_conn_id = aws_conn_id self.default_schedule = default_schedule def _inject_aws_credentials(self) -> None: if TRANSFER_SPEC in self.body and AWS_S3_DATA_SOURCE in self.body[TRANSFER_SPEC]: aws_hook = AwsBaseHook(self.aws_conn_id, resource_type="s3") aws_credentials = aws_hook.get_credentials() aws_access_key_id = aws_credentials.access_key # type: ignore[attr-defined] aws_secret_access_key = aws_credentials.secret_key # type: ignore[attr-defined] self.body[TRANSFER_SPEC][AWS_S3_DATA_SOURCE][AWS_ACCESS_KEY] = { ACCESS_KEY_ID: aws_access_key_id, SECRET_ACCESS_KEY: aws_secret_access_key, } def _reformat_date(self, field_key: str) -> None: schedule = self.body[SCHEDULE] if field_key not in schedule: return if isinstance(schedule[field_key], date): schedule[field_key] = self._convert_date_to_dict(schedule[field_key]) def _reformat_time(self, field_key: str) -> None: schedule = self.body[SCHEDULE] if field_key not in schedule: return if isinstance(schedule[field_key], time): schedule[field_key] = self._convert_time_to_dict(schedule[field_key]) def _reformat_schedule(self) -> None: if SCHEDULE not in self.body: if self.default_schedule: self.body[SCHEDULE] = {SCHEDULE_START_DATE: date.today(), SCHEDULE_END_DATE: date.today()} else: return self._reformat_date(SCHEDULE_START_DATE) self._reformat_date(SCHEDULE_END_DATE) self._reformat_time(START_TIME_OF_DAY)
[docs] def process_body(self) -> dict: """ Injects AWS credentials into body if needed and reformats schedule information. :return: Preprocessed body """ self._inject_aws_credentials() self._reformat_schedule() return self.body
@staticmethod def _convert_date_to_dict(field_date: date) -> dict: """Convert native python ``datetime.date`` object to a format supported by the API""" return {DAY: field_date.day, MONTH: field_date.month, YEAR: field_date.year} @staticmethod def _convert_time_to_dict(time_object: time) -> dict: """Convert native python ``datetime.time`` object to a format supported by the API""" return {HOURS: time_object.hour, MINUTES: time_object.minute, SECONDS: time_object.second}
[docs]class TransferJobValidator: """Helper class for validating transfer job body.""" def __init__(self, body: dict) -> None: if not body: raise AirflowException("The required parameter 'body' is empty or None") self.body = body def _verify_data_source(self) -> None: is_gcs = GCS_DATA_SOURCE in self.body[TRANSFER_SPEC] is_aws_s3 = AWS_S3_DATA_SOURCE in self.body[TRANSFER_SPEC] is_http = HTTP_DATA_SOURCE in self.body[TRANSFER_SPEC] sources_count = sum([is_gcs, is_aws_s3, is_http]) if sources_count > 1: raise AirflowException( "More than one data source detected. Please choose exactly one data source from: " "gcsDataSource, awsS3DataSource and httpDataSource." ) def _restrict_aws_credentials(self) -> None: aws_transfer = AWS_S3_DATA_SOURCE in self.body[TRANSFER_SPEC] if aws_transfer and AWS_ACCESS_KEY in self.body[TRANSFER_SPEC][AWS_S3_DATA_SOURCE]: raise AirflowException( "AWS credentials detected inside the body parameter (awsAccessKey). This is not allowed, " "please use Airflow connections to store credentials." )
[docs] def validate_body(self) -> None: """ Validates the body. Checks if body specifies `transferSpec` if yes, then check if AWS credentials are passed correctly and no more than 1 data source was selected. :raises: AirflowException """ if TRANSFER_SPEC in self.body: self._restrict_aws_credentials() self._verify_data_source()
[docs]class CloudDataTransferServiceCreateJobOperator(BaseOperator): """ Creates a transfer job that runs periodically. .. warning:: This operator is NOT idempotent in the following cases: * `name` is not passed in body param * transfer job `name` has been soft deleted. In this case, each new task will receive a unique suffix If you run it many times, many transfer jobs will be created in the Google Cloud. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:CloudDataTransferServiceCreateJobOperator` :param body: (Required) The request body, as described in https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs#TransferJob With three additional improvements: * dates can be given in the form :class:`datetime.date` * times can be given in the form :class:`datetime.time` * credentials to Amazon Web Service should be stored in the connection and indicated by the aws_conn_id parameter :param aws_conn_id: The connection ID used to retrieve credentials to Amazon Web Service. :param gcp_conn_id: The connection ID used to connect to Google Cloud. :param api_version: API version used (e.g. v1). :param google_impersonation_chain: Optional Google 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). """ # [START gcp_transfer_job_create_template_fields]
[docs] template_fields: Sequence[str] = ( "body", "gcp_conn_id", "aws_conn_id", "google_impersonation_chain",
) # [END gcp_transfer_job_create_template_fields] def __init__( self, *, body: dict, aws_conn_id: str = "aws_default", gcp_conn_id: str = "google_cloud_default", api_version: str = "v1", project_id: str | None = None, google_impersonation_chain: str | Sequence[str] | None = None, **kwargs, ) -> None: super().__init__(**kwargs) self.body = deepcopy(body) self.aws_conn_id = aws_conn_id self.gcp_conn_id = gcp_conn_id self.api_version = api_version self.project_id = project_id self.google_impersonation_chain = google_impersonation_chain self._validate_inputs() def _validate_inputs(self) -> None: TransferJobValidator(body=self.body).validate_body()
[docs] def execute(self, context: Context) -> dict: TransferJobPreprocessor(body=self.body, aws_conn_id=self.aws_conn_id).process_body() hook = CloudDataTransferServiceHook( api_version=self.api_version, gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.google_impersonation_chain, ) result = hook.create_transfer_job(body=self.body) project_id = self.project_id or hook.project_id if project_id: CloudStorageTransferJobLink.persist( context=context, task_instance=self, project_id=project_id, job_name=result[NAME], ) return result
[docs]class CloudDataTransferServiceUpdateJobOperator(BaseOperator): """ Updates a transfer job that runs periodically. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:CloudDataTransferServiceUpdateJobOperator` :param job_name: (Required) Name of the job to be updated :param body: (Required) The request body, as described in https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/patch#request-body With three additional improvements: * dates can be given in the form :class:`datetime.date` * times can be given in the form :class:`datetime.time` * credentials to Amazon Web Service should be stored in the connection and indicated by the aws_conn_id parameter :param aws_conn_id: The connection ID used to retrieve credentials to Amazon Web Service. :param gcp_conn_id: The connection ID used to connect to Google Cloud. :param api_version: API version used (e.g. v1). :param google_impersonation_chain: Optional Google 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). """ # [START gcp_transfer_job_update_template_fields]
[docs] template_fields: Sequence[str] = ( "job_name", "body", "gcp_conn_id", "aws_conn_id", "google_impersonation_chain",
) # [END gcp_transfer_job_update_template_fields] def __init__( self, *, job_name: str, body: dict, aws_conn_id: str = "aws_default", gcp_conn_id: str = "google_cloud_default", api_version: str = "v1", project_id: str | None = None, google_impersonation_chain: str | Sequence[str] | None = None, **kwargs, ) -> None: super().__init__(**kwargs) self.job_name = job_name self.body = body self.project_id = project_id self.gcp_conn_id = gcp_conn_id self.api_version = api_version self.aws_conn_id = aws_conn_id self.google_impersonation_chain = google_impersonation_chain self._validate_inputs() def _validate_inputs(self) -> None: TransferJobValidator(body=self.body).validate_body() if not self.job_name: raise AirflowException("The required parameter 'job_name' is empty or None")
[docs] def execute(self, context: Context) -> dict: TransferJobPreprocessor(body=self.body, aws_conn_id=self.aws_conn_id).process_body() hook = CloudDataTransferServiceHook( api_version=self.api_version, gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.google_impersonation_chain, ) project_id = self.project_id or hook.project_id if project_id: CloudStorageTransferJobLink.persist( context=context, task_instance=self, project_id=project_id, job_name=self.job_name, ) return hook.update_transfer_job(job_name=self.job_name, body=self.body)
[docs]class CloudDataTransferServiceDeleteJobOperator(BaseOperator): """ Delete a transfer job. This is a soft delete. After a transfer job is deleted, the job and all the transfer executions are subject to garbage collection. Transfer jobs become eligible for garbage collection 30 days after soft delete. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:CloudDataTransferServiceDeleteJobOperator` :param job_name: (Required) Name of the TRANSFER operation :param project_id: (Optional) the ID of the project that owns the Transfer Job. If set to None or missing, the default project_id from the Google Cloud connection is used. :param gcp_conn_id: The connection ID used to connect to Google Cloud. :param api_version: API version used (e.g. v1). :param google_impersonation_chain: Optional Google 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). """ # [START gcp_transfer_job_delete_template_fields]
[docs] template_fields: Sequence[str] = ( "job_name", "project_id", "gcp_conn_id", "api_version", "google_impersonation_chain",
) # [END gcp_transfer_job_delete_template_fields] def __init__( self, *, job_name: str, gcp_conn_id: str = "google_cloud_default", api_version: str = "v1", project_id: str | None = None, google_impersonation_chain: str | Sequence[str] | None = None, **kwargs, ) -> None: super().__init__(**kwargs) self.job_name = job_name self.project_id = project_id self.gcp_conn_id = gcp_conn_id self.api_version = api_version self.google_impersonation_chain = google_impersonation_chain self._validate_inputs() def _validate_inputs(self) -> None: if not self.job_name: raise AirflowException("The required parameter 'job_name' is empty or None")
[docs] def execute(self, context: Context) -> None: self._validate_inputs() hook = CloudDataTransferServiceHook( api_version=self.api_version, gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.google_impersonation_chain, ) hook.delete_transfer_job(job_name=self.job_name, project_id=self.project_id)
[docs]class CloudDataTransferServiceGetOperationOperator(BaseOperator): """ Gets the latest state of a long-running operation in Google Storage Transfer Service. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:CloudDataTransferServiceGetOperationOperator` :param operation_name: (Required) Name of the transfer operation. :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform. :param api_version: API version used (e.g. v1). :param google_impersonation_chain: Optional Google 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). """ # [START gcp_transfer_operation_get_template_fields]
[docs] template_fields: Sequence[str] = ( "operation_name", "gcp_conn_id", "google_impersonation_chain",
) # [END gcp_transfer_operation_get_template_fields] def __init__( self, *, project_id: str | None = None, operation_name: str, gcp_conn_id: str = "google_cloud_default", api_version: str = "v1", google_impersonation_chain: str | Sequence[str] | None = None, **kwargs, ) -> None: super().__init__(**kwargs) self.operation_name = operation_name self.project_id = project_id self.gcp_conn_id = gcp_conn_id self.api_version = api_version self.google_impersonation_chain = google_impersonation_chain self._validate_inputs() def _validate_inputs(self) -> None: if not self.operation_name: raise AirflowException("The required parameter 'operation_name' is empty or None")
[docs] def execute(self, context: Context) -> dict: hook = CloudDataTransferServiceHook( api_version=self.api_version, gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.google_impersonation_chain, ) operation = hook.get_transfer_operation(operation_name=self.operation_name) project_id = self.project_id or hook.project_id if project_id: CloudStorageTransferDetailsLink.persist( context=context, task_instance=self, project_id=project_id, operation_name=self.operation_name, ) return operation
[docs]class CloudDataTransferServiceListOperationsOperator(BaseOperator): """ Lists long-running operations in Google Storage Transfer Service that match the specified filter. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:CloudDataTransferServiceListOperationsOperator` :param request_filter: (Required) A request filter, as described in https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/list#body.QUERY_PARAMETERS.filter :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform. :param api_version: API version used (e.g. v1). :param google_impersonation_chain: Optional Google 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). """ # [START gcp_transfer_operations_list_template_fields]
[docs] template_fields: Sequence[str] = ( "filter", "gcp_conn_id", "google_impersonation_chain",
) # [END gcp_transfer_operations_list_template_fields] def __init__( self, request_filter: dict | None = None, project_id: str | None = None, gcp_conn_id: str = "google_cloud_default", api_version: str = "v1", google_impersonation_chain: str | Sequence[str] | None = None, **kwargs, ) -> None: # To preserve backward compatibility # TODO: remove one day if request_filter is None: if "filter" in kwargs: request_filter = kwargs["filter"] DeprecationWarning("Use 'request_filter' instead 'filter' to pass the argument.") else: TypeError("__init__() missing 1 required positional argument: 'request_filter'") super().__init__(**kwargs) self.filter = request_filter self.project_id = project_id self.gcp_conn_id = gcp_conn_id self.api_version = api_version self.google_impersonation_chain = google_impersonation_chain self._validate_inputs() def _validate_inputs(self) -> None: if not self.filter: raise AirflowException("The required parameter 'filter' is empty or None")
[docs] def execute(self, context: Context) -> list[dict]: hook = CloudDataTransferServiceHook( api_version=self.api_version, gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.google_impersonation_chain, ) operations_list = hook.list_transfer_operations(request_filter=self.filter) self.log.info(operations_list) project_id = self.project_id or hook.project_id if project_id: CloudStorageTransferListLink.persist( context=context, task_instance=self, project_id=project_id, ) return operations_list
[docs]class CloudDataTransferServicePauseOperationOperator(BaseOperator): """ Pauses a transfer operation in Google Storage Transfer Service. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:CloudDataTransferServicePauseOperationOperator` :param operation_name: (Required) Name of the transfer operation. :param gcp_conn_id: The connection ID used to connect to Google Cloud. :param api_version: API version used (e.g. v1). :param google_impersonation_chain: Optional Google 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). """ # [START gcp_transfer_operation_pause_template_fields]
[docs] template_fields: Sequence[str] = ( "operation_name", "gcp_conn_id", "api_version", "google_impersonation_chain",
) # [END gcp_transfer_operation_pause_template_fields] def __init__( self, *, operation_name: str, gcp_conn_id: str = "google_cloud_default", api_version: str = "v1", google_impersonation_chain: str | Sequence[str] | None = None, **kwargs, ) -> None: super().__init__(**kwargs) self.operation_name = operation_name self.gcp_conn_id = gcp_conn_id self.api_version = api_version self.google_impersonation_chain = google_impersonation_chain self._validate_inputs() def _validate_inputs(self) -> None: if not self.operation_name: raise AirflowException("The required parameter 'operation_name' is empty or None")
[docs] def execute(self, context: Context) -> None: hook = CloudDataTransferServiceHook( api_version=self.api_version, gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.google_impersonation_chain, ) hook.pause_transfer_operation(operation_name=self.operation_name)
[docs]class CloudDataTransferServiceResumeOperationOperator(BaseOperator): """ Resumes a transfer operation in Google Storage Transfer Service. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:CloudDataTransferServiceResumeOperationOperator` :param operation_name: (Required) Name of the transfer operation. :param gcp_conn_id: The connection ID used to connect to Google Cloud. :param api_version: API version used (e.g. v1). :param google_impersonation_chain: Optional Google 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). """ # [START gcp_transfer_operation_resume_template_fields]
[docs] template_fields: Sequence[str] = ( "operation_name", "gcp_conn_id", "api_version", "google_impersonation_chain",
) # [END gcp_transfer_operation_resume_template_fields] def __init__( self, *, operation_name: str, gcp_conn_id: str = "google_cloud_default", api_version: str = "v1", google_impersonation_chain: str | Sequence[str] | None = None, **kwargs, ) -> None: self.operation_name = operation_name self.gcp_conn_id = gcp_conn_id self.api_version = api_version self.google_impersonation_chain = google_impersonation_chain self._validate_inputs() super().__init__(**kwargs) def _validate_inputs(self) -> None: if not self.operation_name: raise AirflowException("The required parameter 'operation_name' is empty or None")
[docs] def execute(self, context: Context) -> None: hook = CloudDataTransferServiceHook( api_version=self.api_version, gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.google_impersonation_chain, ) hook.resume_transfer_operation(operation_name=self.operation_name)
[docs]class CloudDataTransferServiceCancelOperationOperator(BaseOperator): """ Cancels a transfer operation in Google Storage Transfer Service. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:CloudDataTransferServiceCancelOperationOperator` :param operation_name: (Required) Name of the transfer operation. :param api_version: API version used (e.g. v1). :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform. :param google_impersonation_chain: Optional Google 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). """ # [START gcp_transfer_operation_cancel_template_fields]
[docs] template_fields: Sequence[str] = ( "operation_name", "gcp_conn_id", "api_version", "google_impersonation_chain",
) # [END gcp_transfer_operation_cancel_template_fields] def __init__( self, *, operation_name: str, gcp_conn_id: str = "google_cloud_default", api_version: str = "v1", google_impersonation_chain: str | Sequence[str] | None = None, **kwargs, ) -> None: super().__init__(**kwargs) self.operation_name = operation_name self.api_version = api_version self.gcp_conn_id = gcp_conn_id self.google_impersonation_chain = google_impersonation_chain self._validate_inputs() def _validate_inputs(self) -> None: if not self.operation_name: raise AirflowException("The required parameter 'operation_name' is empty or None")
[docs] def execute(self, context: Context) -> None: hook = CloudDataTransferServiceHook( api_version=self.api_version, gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.google_impersonation_chain, ) hook.cancel_transfer_operation(operation_name=self.operation_name)
[docs]class CloudDataTransferServiceS3ToGCSOperator(BaseOperator): """ Synchronizes an S3 bucket with a Google Cloud Storage bucket using the Google Cloud Storage Transfer Service. .. warning:: This operator is NOT idempotent. If you run it many times, many transfer jobs will be created in the Google Cloud. **Example**: .. code-block:: python s3_to_gcs_transfer_op = S3ToGoogleCloudStorageTransferOperator( task_id="s3_to_gcs_transfer_example", s3_bucket="my-s3-bucket", project_id="my-gcp-project", gcs_bucket="my-gcs-bucket", dag=my_dag, ) :param s3_bucket: The S3 bucket where to find the objects. (templated) :param gcs_bucket: The destination Google Cloud Storage bucket where you want to store the files. (templated) :param s3_path: Optional root path where the source objects are. (templated) :param gcs_path: Optional root path for transferred objects. (templated) :param project_id: Optional ID of the Google Cloud Console project that owns the job :param aws_conn_id: The source S3 connection :param gcp_conn_id: The destination connection ID to use when connecting to Google Cloud Storage. :param delegate_to: Google 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. :param description: Optional transfer service job description :param schedule: Optional transfer service schedule; If not set, run transfer job once as soon as the operator runs The format is described https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs. With two additional improvements: * dates they can be passed as :class:`datetime.date` * times they can be passed as :class:`datetime.time` :param object_conditions: Optional transfer service object conditions; see https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec :param transfer_options: Optional transfer service transfer options; see https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec :param wait: Wait for transfer to finish. It must be set to True, if 'delete_job_after_completion' is set to True. :param timeout: Time to wait for the operation to end in seconds. Defaults to 60 seconds if not specified. :param google_impersonation_chain: Optional Google 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). :param delete_job_after_completion: If True, delete the job after complete. If set to True, 'wait' must be set to True. """
[docs] template_fields: Sequence[str] = ( "gcp_conn_id", "s3_bucket", "gcs_bucket", "s3_path", "gcs_path", "description", "object_conditions", "google_impersonation_chain",
)
[docs] ui_color = "#e09411"
def __init__( self, *, s3_bucket: str, gcs_bucket: str, s3_path: str | None = None, gcs_path: str | None = None, project_id: str | None = None, aws_conn_id: str = "aws_default", gcp_conn_id: str = "google_cloud_default", delegate_to: str | None = None, description: str | None = None, schedule: dict | None = None, object_conditions: dict | None = None, transfer_options: dict | None = None, wait: bool = True, timeout: float | None = None, google_impersonation_chain: str | Sequence[str] | None = None, delete_job_after_completion: bool = False, **kwargs, ) -> None: super().__init__(**kwargs) self.s3_bucket = s3_bucket self.gcs_bucket = gcs_bucket self.s3_path = s3_path self.gcs_path = gcs_path self.project_id = project_id self.aws_conn_id = aws_conn_id self.gcp_conn_id = gcp_conn_id self.delegate_to = delegate_to self.description = description self.schedule = schedule self.object_conditions = object_conditions self.transfer_options = transfer_options self.wait = wait self.timeout = timeout self.google_impersonation_chain = google_impersonation_chain self.delete_job_after_completion = delete_job_after_completion self._validate_inputs() def _validate_inputs(self) -> None: if self.delete_job_after_completion and not self.wait: raise AirflowException("If 'delete_job_after_completion' is True, then 'wait' must also be True.")
[docs] def execute(self, context: Context) -> None: hook = CloudDataTransferServiceHook( gcp_conn_id=self.gcp_conn_id, delegate_to=self.delegate_to, impersonation_chain=self.google_impersonation_chain, ) body = self._create_body() TransferJobPreprocessor(body=body, aws_conn_id=self.aws_conn_id, default_schedule=True).process_body() job = hook.create_transfer_job(body=body) if self.wait: hook.wait_for_transfer_job(job, timeout=self.timeout) if self.delete_job_after_completion: hook.delete_transfer_job(job_name=job[NAME], project_id=self.project_id)
def _create_body(self) -> dict: body = { DESCRIPTION: self.description, STATUS: GcpTransferJobsStatus.ENABLED, TRANSFER_SPEC: { AWS_S3_DATA_SOURCE: { BUCKET_NAME: self.s3_bucket, PATH: normalize_directory_path(self.s3_path), }, GCS_DATA_SINK: { BUCKET_NAME: self.gcs_bucket, PATH: normalize_directory_path(self.gcs_path), }, }, } if self.project_id is not None: body[PROJECT_ID] = self.project_id if self.schedule is not None: body[SCHEDULE] = self.schedule if self.object_conditions is not None: body[TRANSFER_SPEC][OBJECT_CONDITIONS] = self.object_conditions # type: ignore[index] if self.transfer_options is not None: body[TRANSFER_SPEC][TRANSFER_OPTIONS] = self.transfer_options # type: ignore[index] return body
[docs]class CloudDataTransferServiceGCSToGCSOperator(BaseOperator): """ Copies objects from a bucket to another using the Google Cloud Storage Transfer Service. .. warning:: This operator is NOT idempotent. If you run it many times, many transfer jobs will be created in the Google Cloud. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:GCSToGCSOperator` **Example**: .. code-block:: python gcs_to_gcs_transfer_op = GoogleCloudStorageToGoogleCloudStorageTransferOperator( task_id="gcs_to_gcs_transfer_example", source_bucket="my-source-bucket", destination_bucket="my-destination-bucket", project_id="my-gcp-project", dag=my_dag, ) :param source_bucket: The source Google Cloud Storage bucket where the object is. (templated) :param destination_bucket: The destination Google Cloud Storage bucket where the object should be. (templated) :param source_path: Optional root path where the source objects are. (templated) :param destination_path: Optional root path for transferred objects. (templated) :param project_id: The ID of the Google Cloud Console project that owns the job :param gcp_conn_id: Optional connection ID to use when connecting to Google Cloud Storage. :param delegate_to: Google 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. :param description: Optional transfer service job description :param schedule: Optional transfer service schedule; If not set, run transfer job once as soon as the operator runs See: https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs. With two additional improvements: * dates they can be passed as :class:`datetime.date` * times they can be passed as :class:`datetime.time` :param object_conditions: Optional transfer service object conditions; see https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec#ObjectConditions :param transfer_options: Optional transfer service transfer options; see https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec#TransferOptions :param wait: Wait for transfer to finish. It must be set to True, if 'delete_job_after_completion' is set to True. :param timeout: Time to wait for the operation to end in seconds. Defaults to 60 seconds if not specified. :param google_impersonation_chain: Optional Google 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). :param delete_job_after_completion: If True, delete the job after complete. If set to True, 'wait' must be set to True. """
[docs] template_fields: Sequence[str] = ( "gcp_conn_id", "source_bucket", "destination_bucket", "source_path", "destination_path", "description", "object_conditions", "google_impersonation_chain",
)
[docs] ui_color = "#e09411"
def __init__( self, *, source_bucket: str, destination_bucket: str, source_path: str | None = None, destination_path: str | None = None, project_id: str | None = None, gcp_conn_id: str = "google_cloud_default", delegate_to: str | None = None, description: str | None = None, schedule: dict | None = None, object_conditions: dict | None = None, transfer_options: dict | None = None, wait: bool = True, timeout: float | None = None, google_impersonation_chain: str | Sequence[str] | None = None, delete_job_after_completion: bool = False, **kwargs, ) -> None: super().__init__(**kwargs) self.source_bucket = source_bucket self.destination_bucket = destination_bucket self.source_path = source_path self.destination_path = destination_path self.project_id = project_id self.gcp_conn_id = gcp_conn_id self.delegate_to = delegate_to self.description = description self.schedule = schedule self.object_conditions = object_conditions self.transfer_options = transfer_options self.wait = wait self.timeout = timeout self.google_impersonation_chain = google_impersonation_chain self.delete_job_after_completion = delete_job_after_completion self._validate_inputs() def _validate_inputs(self) -> None: if self.delete_job_after_completion and not self.wait: raise AirflowException("If 'delete_job_after_completion' is True, then 'wait' must also be True.")
[docs] def execute(self, context: Context) -> None: hook = CloudDataTransferServiceHook( gcp_conn_id=self.gcp_conn_id, delegate_to=self.delegate_to, impersonation_chain=self.google_impersonation_chain, ) body = self._create_body() TransferJobPreprocessor(body=body, default_schedule=True).process_body() job = hook.create_transfer_job(body=body) if self.wait: hook.wait_for_transfer_job(job, timeout=self.timeout) if self.delete_job_after_completion: hook.delete_transfer_job(job_name=job[NAME], project_id=self.project_id)
def _create_body(self) -> dict: body = { DESCRIPTION: self.description, STATUS: GcpTransferJobsStatus.ENABLED, TRANSFER_SPEC: { GCS_DATA_SOURCE: { BUCKET_NAME: self.source_bucket, PATH: normalize_directory_path(self.source_path), }, GCS_DATA_SINK: { BUCKET_NAME: self.destination_bucket, PATH: normalize_directory_path(self.destination_path), }, }, } if self.project_id is not None: body[PROJECT_ID] = self.project_id if self.schedule is not None: body[SCHEDULE] = self.schedule if self.object_conditions is not None: body[TRANSFER_SPEC][OBJECT_CONDITIONS] = self.object_conditions # type: ignore[index] if self.transfer_options is not None: body[TRANSFER_SPEC][TRANSFER_OPTIONS] = self.transfer_options # type: ignore[index] return body

Was this entry helpful?