:py:mod:`airflow.providers.tableau.sensors.tableau`
===================================================

.. py:module:: airflow.providers.tableau.sensors.tableau


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   airflow.providers.tableau.sensors.tableau.TableauJobStatusSensor


.. py:class:: TableauJobStatusSensor(*, job_id, site_id = None, tableau_conn_id = 'tableau_default', **kwargs)

   Bases: :py:obj:`airflow.sensors.base.BaseSensorOperator`

   Watches the status of a Tableau Server Job.

   .. seealso:: https://tableau.github.io/server-client-python/docs/api-ref#jobs

   :param job_id: Id of the job to watch.
   :param site_id: The id of the site where the workbook belongs to.
   :param tableau_conn_id: The :ref:`Tableau Connection id <howto/connection:tableau>`
       containing the credentials to authenticate to the Tableau Server.

   .. py:attribute:: template_fields
      :annotation: :Sequence[str] = ['job_id']

      
   .. py:method:: poke(self, context)

      Pokes until the job has successfully finished.

      :param context: The task context during execution.
      :return: True if it succeeded and False if not.
      :rtype: bool