blob: 1c4acfd580fbedc9ae62aa1d70987385245923b4 [file] [log] [blame]
:mod:`airflow.providers.google.cloud.transfers.gdrive_to_gcs`
=============================================================
.. py:module:: airflow.providers.google.cloud.transfers.gdrive_to_gcs
Module Contents
---------------
.. py:class:: GoogleDriveToGCSOperator(*, bucket_name: Optional[str] = None, object_name: Optional[str] = None, destination_bucket: Optional[str] = None, destination_object: Optional[str] = None, file_name: str, folder_id: str, drive_id: Optional[str] = None, gcp_conn_id: str = 'google_cloud_default', delegate_to: Optional[str] = None, impersonation_chain: Optional[Union[str, Sequence[str]]] = None, **kwargs)
Bases: :class:`airflow.models.BaseOperator`
Writes a Google Drive file into Google Cloud Storage.
.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:GoogleDriveToGCSOperator`
:param bucket_name: The destination Google cloud storage bucket where the
file should be written to
:type bucket_name: str
:param object_name: The Google Cloud Storage object name for the object created by the operator.
For example: ``path/to/my/file/file.txt``.
:type object_name: str
:param destination_bucket: Same as bucket_name, but for backward compatibly
:type destination_bucket: str
:param destination_object: Same as object_name, but for backward compatibly
:type destination_object: str
:param folder_id: The folder id of the folder in which the Google Drive file resides
:type folder_id: str
:param file_name: The name of the file residing in Google Drive
:type file_name: str
:param drive_id: Optional. The id of the shared Google Drive in which the file resides.
:type drive_id: str
:param gcp_conn_id: The GCP connection ID to use when fetching connection info.
:type gcp_conn_id: str
:param delegate_to: The 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.
:type delegate_to: str
:param impersonation_chain: 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).
:type impersonation_chain: Union[str, Sequence[str]]
.. attribute:: template_fields
:annotation: = ['bucket_name', 'object_name', 'destination_bucket', 'destination_object', 'folder_id', 'file_name', 'drive_id', 'impersonation_chain']
.. method:: execute(self, context)