blob: 83375bec44bb420fe8062838174fd3cad9ac1d0e [file] [log] [blame]
:py:mod:`airflow.providers.celery.sensors.celery_queue`
=======================================================
.. py:module:: airflow.providers.celery.sensors.celery_queue
Module Contents
---------------
Classes
~~~~~~~
.. autoapisummary::
airflow.providers.celery.sensors.celery_queue.CeleryQueueSensor
.. py:class:: CeleryQueueSensor(*, celery_queue, target_task_id = None, **kwargs)
Bases: :py:obj:`airflow.sensors.base.BaseSensorOperator`
Waits for a Celery queue to be empty. By default, in order to be considered
empty, the queue must not have any tasks in the ``reserved``, ``scheduled``
or ``active`` states.
:param celery_queue: The name of the Celery queue to wait for.
:param target_task_id: Task id for checking
.. py:method:: poke(self, context)
Function that the sensors defined while deriving this class should
override.