blob: eb606cfdbd75f14d1caa7d964158a133bc187d2b [file] [log] [blame]
:py:mod:`airflow.providers.google.suite.sensors.drive`
======================================================
.. py:module:: airflow.providers.google.suite.sensors.drive
.. autoapi-nested-parse::
This module contains Google Drive sensors.
Module Contents
---------------
Classes
~~~~~~~
.. autoapisummary::
airflow.providers.google.suite.sensors.drive.GoogleDriveFileExistenceSensor
.. py:class:: GoogleDriveFileExistenceSensor(*, folder_id, file_name, drive_id = None, gcp_conn_id = 'google_cloud_default', delegate_to = None, impersonation_chain = None, **kwargs)
Bases: :py:obj:`airflow.sensors.base.BaseSensorOperator`
Checks for the existence of a file in Google Cloud Storage.
:param folder_id: The Google drive folder where the file is.
:param file_name: The name of the file to check in Google Drive
:param drive_id: Optional. The id of the shared Google Drive in which the file resides.
:param gcp_conn_id: The connection ID to use when
connecting to Google Cloud Storage.
: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.
: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).
.. py:attribute:: template_fields
:annotation: :Sequence[str] = ['folder_id', 'file_name', 'drive_id', 'impersonation_chain']
.. py:attribute:: ui_color
:annotation: = #f0eee4
.. py:method:: poke(context)
Function that the sensors defined while deriving this class should
override.