docs-archive/apache-airflow-providers-google/4.0.0/_sources/_api/airflow/providers/google/suite/hooks/drive/index.rst.txt

:mod:`airflow.providers.google.suite.hooks.drive`
=================================================

.. py:module:: airflow.providers.google.suite.hooks.drive

.. autoapi-nested-parse::

   Hook for Google Drive service



Module Contents
---------------

.. py:class:: GoogleDriveHook(api_version: str = 'v3', gcp_conn_id: str = 'google_cloud_default', delegate_to: Optional[str] = None, impersonation_chain: Optional[Union[str, Sequence[str]]] = None)

   Bases: :class:`airflow.providers.google.common.hooks.base_google.GoogleBaseHook`

   Hook for the Google Drive APIs.

   :param api_version: API version used (for example v3).
   :type api_version: str
   :param gcp_conn_id: The 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.
   :type impersonation_chain: Union[str, Sequence[str]]

   .. attribute:: _conn
      :annotation: :Optional[Resource]

      

   
   .. method:: get_conn(self)

      Retrieves the connection to Google Drive.

      :return: Google Drive services object.



   
   .. method:: _ensure_folders_exists(self, path: str)



   
   .. method:: get_media_request(self, file_id: str)

      Returns a get_media http request to a Google Drive object.

      :param file_id: The Google Drive file id
      :type file_id: str
      :return: request
      :rtype: HttpRequest



   
   .. method:: exists(self, folder_id: str, file_name: str, drive_id: Optional[str] = None)

      Checks to see if a file exists within a Google Drive folder

      :param folder_id: The id of the Google Drive folder in which the file resides
      :type folder_id: str
      :param file_name: The name of a file 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
      :return: True if the file exists, False otherwise
      :rtype: bool



   
   .. method:: get_file_id(self, folder_id: str, file_name: str, drive_id: Optional[str] = None)

      Returns the file id of a Google Drive file

      :param folder_id: The id of the Google Drive folder in which the file resides
      :type folder_id: str
      :param file_name: The name of a file 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
      :return: Google Drive file id if the file exists, otherwise None
      :rtype: str if file exists else None



   
   .. method:: upload_file(self, local_location: str, remote_location: str)

      Uploads a file that is available locally to a Google Drive service.

      :param local_location: The path where the file is available.
      :type local_location: str
      :param remote_location: The path where the file will be send
      :type remote_location: str
      :return: File ID
      :rtype: str



   
   .. method:: download_file(self, file_id: str, file_handle: TextIOWrapper, chunk_size: int = 104857600)

      Download a file from Google Drive.

      :param file_id: the id of the file
      :type file_id: str
      :param file_handle: file handle used to write the content to
      :type file_handle: io.TextIOWrapper