blob: d7dcae4b80fd25e364e1a4b7a92bf241a26a80df [file] [log] [blame]
:py:mod:`airflow.providers.jira.operators.jira`
===============================================
.. py:module:: airflow.providers.jira.operators.jira
Module Contents
---------------
Classes
~~~~~~~
.. autoapisummary::
airflow.providers.jira.operators.jira.JiraOperator
.. py:class:: JiraOperator(*, jira_method, jira_conn_id = 'jira_default', jira_method_args = None, result_processor = None, get_jira_resource_method = None, **kwargs)
Bases: :py:obj:`airflow.models.BaseOperator`
JiraOperator to interact and perform action on Jira issue tracking system.
This operator is designed to use Jira Python SDK: http://jira.readthedocs.io
:param jira_conn_id: reference to a pre-defined Jira Connection
:param jira_method: method name from Jira Python SDK to be called
:param jira_method_args: required method parameters for the jira_method. (templated)
:param result_processor: function to further process the response from Jira
:param get_jira_resource_method: function or operator to get jira resource
on which the provided jira_method will be executed
.. py:attribute:: template_fields
:annotation: :Sequence[str] = ['jira_method_args']
.. py:method:: execute(self, context)
This is the main method to derive when creating an operator.
Context is the same dictionary used as when rendering jinja templates.
Refer to get_template_context for more context.