GCSToSFTPOperator

Google

Transfer files from a Google Cloud Storage bucket to SFTP server.

View on GitHub

Last Updated: Jan. 23, 2023

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

Documentation

Connections

Parameters

source_bucketRequiredThe source Google Cloud Storage bucket where the object is. (templated)

source_objectRequiredThe source name of the object to copy in the Google cloud storage bucket. (templated) You can use only one wildcard for objects (filenames) within your bucket. The wildcard can appear inside the object name or at the end of the object name. Appending a wildcard to the bucket name is unsupported.

destination_pathRequiredThe sftp remote path. This is the specified directory path for uploading to the SFTP server.

keep_directory_structure(Optional) When set to False the path of the file on the bucket is recreated within path passed in destination_path.

move_objectWhen move object is True, the object is moved instead of copied to the new location. This is the equivalent of a mv command as opposed to a cp command.

gcp_conn_id(Optional) The connection ID used to connect to Google Cloud.

sftp_conn_idThe sftp connection id. The name or identifier for establishing a connection to the SFTP server.

delegate_toThe 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_chainOptional 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).

Documentation

Transfer files from a Google Cloud Storage bucket to SFTP server.

Example:

with models.DAG(
    "example_gcs_to_sftp",
    start_date=datetime(2020, 6, 19),
    schedule=None,
) as dag:
    # downloads file to /tmp/sftp/folder/subfolder/file.txt
    copy_file_from_gcs_to_sftp = GCSToSFTPOperator(
        task_id="file-copy-gsc-to-sftp",
        source_bucket="test-gcs-sftp-bucket-name",
        source_object="folder/subfolder/file.txt",
        destination_path="/tmp/sftp",
    )

    # moves file to /tmp/data.txt
    move_file_from_gcs_to_sftp = GCSToSFTPOperator(
        task_id="file-move-gsc-to-sftp",
        source_bucket="test-gcs-sftp-bucket-name",
        source_object="folder/subfolder/data.txt",
        destination_path="/tmp",
        move_object=True,
        keep_directory_structure=False,
    )