airflow.providers.google.cloud.sensors.bigquery_dts

This module contains a Google BigQuery Data Transfer Service sensor.

Module Contents

Classes

BigQueryDataTransferServiceTransferRunSensor

Waits for Data Transfer Service run to complete.
class airflow.providers.google.cloud.sensors.bigquery_dts.BigQueryDataTransferServiceTransferRunSensor(*, run_id, transfer_config_id, expected_statuses=TransferState.SUCCEEDED, project_id=None, gcp_conn_id='google_cloud_default', retry=None, request_timeout=None, metadata=(), impersonation_chain=None, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Waits for Data Transfer Service run to complete.

See also

For more information on how to use this sensor, take a look at the guide: Manually starting transfer runs

Parameters

  • expected_statuses (Union[Set[Union[str, google.cloud.bigquery_datatransfer_v1.TransferState, int]], str, google.cloud.bigquery_datatransfer_v1.TransferState, int]) -- The expected state of the operation. See: https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations#Status

  • run_id (str) -- ID of the transfer run.

  • transfer_config_id (str) -- ID of transfer config to be used.

  • project_id (Optional[str]) -- The BigQuery project id where the transfer configuration should be created. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • retry (Optional[google.api_core.retry.Retry]) -- A retry object used to retry requests. If None is specified, requests will not be retried.

  • request_timeout (Optional[float]) -- The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

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

  • 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).

Returns

An google.cloud.bigquery_datatransfer_v1.types.TransferRun instance.

template_fields :Sequence[str] = ['run_id', 'transfer_config_id', 'expected_statuses', 'project_id', 'impersonation_chain'][source]
poke(self, context)[source]

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

Was this entry helpful?