airflow.providers.tableau.sensors.tableau¶

Classes¶

TableauJobStatusSensor

Watches the status of a Tableau Server Job.

Module Contents¶

class airflow.providers.tableau.sensors.tableau.TableauJobStatusSensor(*, job_id, site_id=None, tableau_conn_id='tableau_default', max_status_retries=0, **kwargs)[source]¶

Bases: airflow.providers.common.compat.sdk.BaseSensorOperator

Watches the status of a Tableau Server Job.

Parameters:

job_id (str) – Id of the job to watch.
site_id (str | None) – The id of the site where the workbook belongs to.
tableau_conn_id (str) – The Tableau Connection id containing the credentials to authenticate to the Tableau Server.
max_status_retries (int) – How often to rerun get_job_status in case of an error or cancellation, to account for transient errors.

template_fields: collections.abc.Sequence[str] = ('job_id',)[source]¶

tableau_conn_id = 'tableau_default'[source]¶

job_id[source]¶

site_id = None[source]¶

max_status_retries = 0[source]¶

poke(context)[source]¶

Pokes until the job has successfully finished.

When max_status_retries is set, the Sensor will retry in case of a TableauJobFinishCode.ERROR, TableauJobFinishCode.CANCELED before raising an Error.

Parameters:: context (airflow.providers.common.compat.sdk.Context) – The task context during execution.
Returns:: True if it succeeded and False if not.
Return type:: bool