airflow.providers.atlassian.jira.notifications.jira¶

Attributes¶

send_jira_notification

Classes¶

JiraNotifier

Jira notifier for creating Jira issues upon failures.

Module Contents¶

class airflow.providers.atlassian.jira.notifications.jira.JiraNotifier(*, jira_conn_id=JiraHook.default_conn_name, proxies=None, api_version='2', api_root='rest/api', description, summary, project_id, issue_type_id, labels=None, **kwargs)[source]¶

Bases: airflow.providers.common.compat.sdk.BaseNotifier

Jira notifier for creating Jira issues upon failures.

Parameters:

jira_conn_id (str) – The HTTP connection ID for the Jira instance.
proxies (Any | None) – Proxies to make the Jira REST API call. Optional
api_version (str | int) – Jira api version to use. Optional
api_root (str) – root for the api requests. Optional
description (str) – The content for the body of the issue
summary (str) – The title of the issue
project_id (int) – The ID of the project under which the issue will be created
issue_type_id (int) – The ID of the issue category
labels (list[str] | None) – The labels to be applied to the issue

template_fields = ('description', 'summary', 'project_id', 'issue_type_id', 'labels')[source]¶

jira_conn_id = 'jira_default'[source]¶

proxies = None[source]¶

api_version = '2'[source]¶

api_root = 'rest/api'[source]¶

description[source]¶

summary[source]¶

project_id[source]¶

issue_type_id[source]¶

labels = [][source]¶

property hook: airflow.providers.atlassian.jira.hooks.jira.JiraHook[source]¶

property async_hook: airflow.providers.atlassian.jira.hooks.jira.JiraAsyncHook[source]¶

notify(context)[source]¶

Send a notification (sync).

Implementing this is a requirement for running this notifier in the Dag processor, which is where the on_success_callback and on_failure_callback run.

Parameters:: context – The airflow context

async async_notify(context)[source]¶

Create a Jira issue (async).

airflow.providers.atlassian.jira.notifications.jira.send_jira_notification[source]¶