GCSObjectsWithPrefixExistenceSensor

Google

Checks for the existence of GCS objects at a given prefix, passing matches via XCom.

View Source

Last Updated: Feb. 12, 2021

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

bucketstrThe Google Cloud Storage bucket where the object is.
prefixstrThe name of the prefix to check in the Google cloud storage bucket.
google_cloud_conn_idstrThe connection ID to use when connecting to Google Cloud Storage.
delegate_tostrThe 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_chainUnion[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 (templated).

Documentation

Checks for the existence of GCS objects at a given prefix, passing matches via XCom.

When files matching the given prefix are found, the poke method’s criteria will be fulfilled and the matching objects will be returned from the operator and passed through XCom for downstream tasks.

Example DAGs

Improve this module by creating an example DAG.

View Source
  1. Add an `example_dags` directory to the top-level source of the provider package with an empty `__init__.py` file.
  2. Add your DAG to this directory. Be sure to include a well-written and descriptive docstring
  3. Create a pull request against the source code. Once the package gets released, your DAG will show up on the Registry.

Was this page helpful?