| :py:mod:`airflow.providers.apache.livy.sensors.livy` |
| ==================================================== |
| |
| .. py:module:: airflow.providers.apache.livy.sensors.livy |
| |
| .. autoapi-nested-parse:: |
| |
| This module contains the Apache Livy sensor. |
| |
| |
| |
| Module Contents |
| --------------- |
| |
| Classes |
| ~~~~~~~ |
| |
| .. autoapisummary:: |
| |
| airflow.providers.apache.livy.sensors.livy.LivySensor |
| |
| |
| |
| |
| .. py:class:: LivySensor(*, batch_id, livy_conn_id = 'livy_default', extra_options = None, **kwargs) |
| |
| Bases: :py:obj:`airflow.sensors.base.BaseSensorOperator` |
| |
| Monitor a Livy sessions for termination. |
| |
| :param livy_conn_id: reference to a pre-defined Livy connection |
| :param batch_id: identifier of the monitored batch |
| depends on the option that's being modified. |
| |
| .. py:attribute:: template_fields |
| :annotation: :Sequence[str] = ['batch_id'] |
| |
| |
| |
| .. py:method:: get_hook(self) |
| |
| Get valid hook. |
| |
| :return: hook |
| :rtype: LivyHook |
| |
| |
| .. py:method:: poke(self, context) |
| |
| Function that the sensors defined while deriving this class should |
| override. |
| |
| |
| |
