Source code for airflow.providers.apache.livy.sensors.livy

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

"""This module contains the Apache Livy sensor."""
from typing import TYPE_CHECKING, Any, Dict, Optional, Sequence, Union

from airflow.providers.apache.livy.hooks.livy import LivyHook
from airflow.sensors.base import BaseSensorOperator

    from airflow.utils.context import Context

[docs]class LivySensor(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. """
[docs] template_fields: Sequence[str] = ('batch_id',)
def __init__( self, *, batch_id: Union[int, str], livy_conn_id: str = 'livy_default', extra_options: Optional[Dict[str, Any]] = None, **kwargs: Any, ) -> None: super().__init__(**kwargs) self.batch_id = batch_id self._livy_conn_id = livy_conn_id self._livy_hook: Optional[LivyHook] = None self._extra_options = extra_options or {}
[docs] def get_hook(self) -> LivyHook: """ Get valid hook. :return: hook :rtype: LivyHook """ if self._livy_hook is None or not isinstance(self._livy_hook, LivyHook): self._livy_hook = LivyHook(livy_conn_id=self._livy_conn_id, extra_options=self._extra_options) return self._livy_hook
[docs] def poke(self, context: "Context") -> bool: batch_id = self.batch_id status = self.get_hook().get_batch_state(batch_id) return status in self.get_hook().TERMINAL_STATES

Was this entry helpful?