airflow.providers.google.suite.hooks.drive

Hook for Google Drive service

Module Contents

class airflow.providers.google.suite.hooks.drive.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)[source]

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

Hook for the Google Drive APIs.

Parameters
  • api_version (str) -- API version used (for example v3).

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

  • delegate_to (str) -- 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.

  • impersonation_chain (Union[str, Sequence[str]]) -- 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.

_conn :Optional[Resource][source]
get_conn(self)[source]

Retrieves the connection to Google Drive.

Returns

Google Drive services object.

_ensure_folders_exists(self, path: str)[source]
upload_file(self, local_location: str, remote_location: str)[source]

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

Parameters
  • local_location (str) -- The path where the file is available.

  • remote_location (str) -- The path where the file will be send

Returns

File ID

Return type

str

Was this entry helpful?