docs-archive/1.10.13/_sources/_api/airflow/contrib/sensors/jira_sensor/index.rst.txt

:mod:`airflow.contrib.sensors.jira_sensor`
==========================================

.. py:module:: airflow.contrib.sensors.jira_sensor


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

.. py:class:: JiraSensor(jira_conn_id='jira_default', method_name=None, method_params=None, result_processor=None, *args, **kwargs)

   Bases: :class:`airflow.sensors.base_sensor_operator.BaseSensorOperator`

   Monitors a jira ticket for any change.

   :param jira_conn_id: reference to a pre-defined Jira Connection
   :type jira_conn_id: str
   :param method_name: method name from jira-python-sdk to be execute
   :type method_name: str
   :param method_params: parameters for the method method_name
   :type method_params: dict
   :param result_processor: function that return boolean and act as a sensor response
   :type result_processor: function

   
   .. method:: poke(self, context)




.. py:class:: JiraTicketSensor(jira_conn_id='jira_default', ticket_id=None, field=None, expected_value=None, field_checker_func=None, *args, **kwargs)

   Bases: :class:`airflow.contrib.sensors.jira_sensor.JiraSensor`

   Monitors a jira ticket for given change in terms of function.

   :param jira_conn_id: reference to a pre-defined Jira Connection
   :type jira_conn_id: str
   :param ticket_id: id of the ticket to be monitored
   :type ticket_id: str
   :param field: field of the ticket to be monitored
   :type field: str
   :param expected_value: expected value of the field
   :type expected_value: str
   :param result_processor: function that return boolean and act as a sensor response
   :type result_processor: function

   .. attribute:: template_fields
      :annotation: = ['ticket_id']

      

   
   .. method:: poke(self, context)



   
   .. method:: issue_field_checker(self, context, issue)