airflow.providers.google.cloud.sensors.dataplex

This module contains Google Dataplex sensors.

Module Contents

Classes

TaskState

Dataplex Task states

DataplexTaskStateSensor

Check the status of the Dataplex task
class airflow.providers.google.cloud.sensors.dataplex.TaskState[source]

Dataplex Task states

STATE_UNSPECIFIED = 0[source]
ACTIVE = 1[source]
CREATING = 2[source]
DELETING = 3[source]
ACTION_REQUIRED = 4[source]
class airflow.providers.google.cloud.sensors.dataplex.DataplexTaskStateSensor(project_id, region, lake_id, dataplex_task_id, api_version='v1', retry=DEFAULT, metadata=(), gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None, *args, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Check the status of the Dataplex task

Parameters

  • project_id (str) – Required. The ID of the Google Cloud project that the task belongs to.

  • region (str) – Required. The ID of the Google Cloud region that the task belongs to.

  • lake_id (str) – Required. The ID of the Google Cloud lake that the task belongs to.

  • dataplex_task_id (str) – Required. Task identifier.

  • api_version (str) – The version of the api that will be requested for example ‘v3’.

  • retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • metadata (Sequence[Tuple[str, str]]) – Additional metadata that is provided to the method.

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

  • delegate_to (Optional[str]) – The account to impersonate, if any. For this to work, the service accountmaking the request must have domain-wide delegation enabled.

  • impersonation_chain (Optional[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 (templated).

template_fields = ['dataplex_task_id'][source]
poke(self, context)[source]

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

Was this entry helpful?