airflow.providers.google.cloud.sensors.dataform

This module contains a Google Cloud Dataform sensor.

Module Contents

Classes

DataformWorkflowInvocationStateSensor

Checks for the status of a Workflow Invocation in Google Cloud Dataform.
class airflow.providers.google.cloud.sensors.dataform.DataformWorkflowInvocationStateSensor(*, project_id, region, repository_id, workflow_invocation_id, expected_statuses, failure_statuses=None, gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Checks for the status of a Workflow Invocation in Google Cloud Dataform.

Parameters

  • project_id (str) – Required, the Google Cloud project ID in which to start a job. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • region (str) – Required, The location of the Dataform workflow invocation (for example europe-west1).

  • repository_id (str) – Required. The ID of the Dataform repository that the task belongs to.

  • workflow_invocation_id (str) – Required, ID of the workflow invocation to be checked.

  • expected_statuses (set[int] | int) – The expected state of the operation. See: https://cloud.google.com/python/docs/reference/dataform/latest/google.cloud.dataform_v1beta1.types.WorkflowInvocation.State

  • failure_statuses (Iterable[int] | None) – State that will terminate the sensor with an exception

  • gcp_conn_id (str) – The connection ID to use connecting to Google Cloud.

  • delegate_to (str | None) – 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. See: https://developers.google.com/identity/protocols/oauth2/service-account#delegatingauthority

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

template_fields :Sequence[str] = ['workflow_invocation_id'][source]
poke(context)[source]

Function that the sensors defined while deriving this class should override.

Was this entry helpful?