airflow.providers.google.cloud.transfers.local_to_gcs

This module contains operator for uploading local file(s) to GCS.

Module Contents

Classes

LocalFilesystemToGCSOperator

Uploads a file or list of files to Google Cloud Storage; optionally can compress the file for upload; optionally can upload the data in multiple chunks.
class airflow.providers.google.cloud.transfers.local_to_gcs.LocalFilesystemToGCSOperator(*, src, dst, bucket, gcp_conn_id='google_cloud_default', mime_type='application/octet-stream', gzip=False, chunk_size=None, impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Uploads a file or list of files to Google Cloud Storage; optionally can compress the file for upload; optionally can upload the data in multiple chunks.

See also

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

Parameters

  • src (str | list[str]) – Path to the local file, or list of local files. Path can be either absolute (e.g. /path/to/file.ext) or relative (e.g. ../../foo//.csv). (templated)

  • dst (str) – Destination path within the specified bucket on GCS (e.g. /path/to/file.ext). If multiple files are being uploaded, specify object prefix with trailing backslash (e.g. /path/to/directory/) (templated)

  • bucket (str) – The bucket to upload to. (templated)

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

  • mime_type (str) – The mime-type string

  • gzip (bool) – Allows for file to be compressed and uploaded as gzip

  • chunk_size (int | None) – Blob chunk size in bytes. This must be a multiple of 262144 bytes (256 KiB)

  • impersonation_chain (str | collections.abc.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: collections.abc.Sequence[str] = ('src', 'dst', 'bucket', 'impersonation_chain')[source]
execute(context)[source]

Upload a file or list of files to Google Cloud Storage.

get_openlineage_facets_on_start()[source]

Was this entry helpful?