leaf_engine.io.gdrive.find
==========================

.. py:module:: leaf_engine.io.gdrive.find


Functions
---------

.. autoapisummary::

   leaf_engine.io.gdrive.find.find_drive_id
   leaf_engine.io.gdrive.find.find_file_id
   leaf_engine.io.gdrive.find.find_folder_id
   leaf_engine.io.gdrive.find.find_resource


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

.. py:function:: find_drive_id(name: str) -> str

   Finds the ID of a shared Google Drive by name.


.. py:function:: find_file_id(path: str, trashed: bool = False) -> Optional[str]

   Finds the ID of a file by Google Drive path.

   :param path: Google Drive path. First part of the path must be the name of a shared
                Google Drive.
   :type path: str
   :param trashed: Search Trash. Defaults to False.
   :type trashed: bool, optional

   :returns: Google Drive ID of file described by path.
   :rtype: str


.. py:function:: find_folder_id(name: str, parent_folder_id: Optional[str], drive_id: str, trashed: bool = False) -> Optional[str]

   Find the Google Drive ID of an existing folder in given parent.

   :param name: Folder name.
   :type name: str
   :param parent_folder_id: Optional. Where to look for the folder. Parent folder
                            ID can be found in the parent folder URL or by using this method and searching for
                            the parent folder name.
   :type parent_folder_id: Optional[str]

   :returns: Folder ID. Returns `None` if no folder is found.
   :rtype: Optional[str]


.. py:function:: find_resource(name: str, parent_folder_id: Optional[str], drive_id: str, mime_type: Optional[str] = None, trashed: bool = False) -> Optional[dict]

   Finds resource (file, folder) on Google Drive.

   :param name: Resource name.
   :type name: str
   :param drive_id: Drive ID to search in.
   :type drive_id: str
   :param parent_folder_id: What folder to search for resource. Optional.
   :type parent_folder_id: Optional[str]
   :param mime_type: Type of resource to look for. Defaults to None.
   :type mime_type: Optional[str]
   :param trashed: Search trash. Defaults to False.
   :type trashed: bool

   :raises LeafGoogleDriveException: Raised when more than one resource matches the provided
   :raises query parameters.:

   :returns: Dictionary containing resource `name` and `id`.
   :rtype: dict