airflow.providers.atlassian.jira.hooks.jira¶

Hook for JIRA.

Classes¶

`JiraHook`	Jira interaction hook, a Wrapper around Atlassian Jira Python SDK.
`JiraAsyncHook`	Async Jira interaction hook, interacts with Jira with HTTP.

Module Contents¶

class airflow.providers.atlassian.jira.hooks.jira.JiraHook(jira_conn_id=default_conn_name, proxies=None, api_root='rest/api', api_version='2')[source]¶

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

Jira interaction hook, a Wrapper around Atlassian Jira Python SDK.

Parameters:

jira_conn_id (str) – reference to a pre-defined Jira Connection
proxies (Any | None) – Proxies to make the Jira REST API call. Optional
api_root (str) – root for the api requests. Optional
api_version (str | int) – Jira api version to use. Optional

default_conn_name = 'jira_default'[source]¶

conn_type = 'jira'[source]¶

conn_name_attr = 'jira_conn_id'[source]¶

hook_name = 'JIRA'[source]¶

jira_conn_id = 'jira_default'[source]¶

proxies = None[source]¶

api_root = 'rest/api'[source]¶

api_version = '2'[source]¶

client: atlassian.Jira | None = None[source]¶

get_conn()[source]¶

Return connection for the hook.

classmethod get_connection_form_widgets()[source]¶

Return connection widgets to add to Atlassian Jira Connection form.

classmethod get_ui_field_behaviour()[source]¶

Return custom UI field behaviour for Atlassian Jira Connection.

class airflow.providers.atlassian.jira.hooks.jira.JiraAsyncHook(jira_conn_id=default_conn_name, api_root='rest/api', api_version='2', proxies=None)[source]¶

Bases: airflow.providers.http.hooks.http.HttpAsyncHook

Async Jira interaction hook, interacts with Jira with HTTP.

Parameters:

jira_conn_id (str) – reference to a pre-defined Jira Connection
api_root (str) – root for the api requests
api_version (str | int) – api version to use
proxies (Any | None) – Specify proxies to use. Defaults to None.

default_headers[source]¶

default_conn_name = 'jira_default'[source]¶

conn_type = 'jira'[source]¶

conn_name_attr = 'jira_conn_id'[source]¶

hook_name = 'Async HTTP JIRA'[source]¶

method = 'POST'[source]¶

api_root = 'rest/api'[source]¶

api_version = '2'[source]¶

http_conn_id = 'jira_default'[source]¶

proxies = None[source]¶

get_resource_url(resource, api_root=None, api_version=None)[source]¶

Create the resource url.

Parameters:

resource (str) – Jira resource
api_root (str | None) – root for the api requests
api_version (str | int | None) – request payload

Returns:

resource URL

Return type:

str

async create_issue(fields)[source]¶

Create an issue or a sub-task from a JSON representation.

Parameters:: fields (str | dict) – JSON data. mandatory keys are issue type, summary and project
Returns:: client response
Return type:: aiohttp.client_reqrep.ClientResponse