airflow.providers.google.cloud.transfers.gdrive_to_local

Module Contents

Classes

GoogleDriveToLocalOperator

Writes a Google Drive file into local Storage.
class airflow.providers.google.cloud.transfers.gdrive_to_local.GoogleDriveToLocalOperator(*, output_file, file_name, folder_id, drive_id=None, gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Writes a Google Drive file into local Storage.

See also

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

Parameters

  • output_file (str) – Path to downloaded file

  • folder_id (str) – The folder id of the folder in which the Google Drive file resides

  • file_name (str) – The name of the file residing in Google Drive

  • gcp_conn_id (str) – The GCP connection ID to use when fetching connection info.

  • drive_id (str | None) – Optional. The id of the shared Google Drive in which the file resides.

  • 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).

template_fields: Sequence[str] = ('output_file', 'folder_id', 'file_name', 'drive_id', 'impersonation_chain')[source]
execute(context)[source]

This is the main method to derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?