airflow.providers.google.cloud.transfers.local_to_gcs¶
This module contains operator for uploading local file(s) to GCS.
Module Contents¶
Classes¶
Uploads a file or list of files to Google Cloud Storage; optionally can compress the file for upload. |
- 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, impersonation_chain=None, **kwargs)[source]¶
Bases:
airflow.models.BaseOperatorUploads a file or list of files to Google Cloud Storage; optionally can compress the file for upload.
See also
For more information on how to use this operator, take a look at the guide: LocalFilesystemToGCSOperator
- Parameters
src – 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 – 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 – The bucket to upload to. (templated)
gcp_conn_id – (Optional) The connection ID used to connect to Google Cloud.
mime_type – The mime-type string
gzip – Allows for file to be compressed and uploaded as gzip
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).