blob: 89e7ca9c5eb1aa633502e2f74c339793202b6baa [file] [log] [blame]
Search.setIndex({"docnames": ["_api/airflow/providers/opsgenie/hooks/index", "_api/airflow/providers/opsgenie/hooks/opsgenie/index", "_api/airflow/providers/opsgenie/hooks/opsgenie_alert/index", "_api/airflow/providers/opsgenie/index", "_api/airflow/providers/opsgenie/operators/index", "_api/airflow/providers/opsgenie/operators/opsgenie/index", "_api/airflow/providers/opsgenie/operators/opsgenie_alert/index", "_api/tests/system/providers/opsgenie/example_opsgenie_alert/index", "_api/tests/system/providers/opsgenie/index", "commits", "index", "installing-providers-from-sources", "operators/index", "operators/opsgenie_alert"], "filenames": ["_api/airflow/providers/opsgenie/hooks/index.rst", "_api/airflow/providers/opsgenie/hooks/opsgenie/index.rst", "_api/airflow/providers/opsgenie/hooks/opsgenie_alert/index.rst", "_api/airflow/providers/opsgenie/index.rst", "_api/airflow/providers/opsgenie/operators/index.rst", "_api/airflow/providers/opsgenie/operators/opsgenie/index.rst", "_api/airflow/providers/opsgenie/operators/opsgenie_alert/index.rst", "_api/tests/system/providers/opsgenie/example_opsgenie_alert/index.rst", "_api/tests/system/providers/opsgenie/index.rst", "commits.rst", "index.rst", "installing-providers-from-sources.rst", "operators/index.rst", "operators/opsgenie_alert.rst"], "titles": ["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.opsgenie.hooks</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.opsgenie.hooks.opsgenie</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.opsgenie.hooks.opsgenie_alert</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.opsgenie</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.opsgenie.operators</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.opsgenie.operators.opsgenie</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.opsgenie.operators.opsgenie_alert</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.opsgenie.example_opsgenie_alert</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.opsgenie</span></code>", "Package apache-airflow-providers-opsgenie", "<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-opsgenie</span></code>", "Installing from sources", "Opsgenie Operators", "OpsgenieCreateAlertOperator"], "terms": {"opsgenie_alert": [0, 3, 4], "4": [0, 1, 2, 3, 4, 5, 6, 7, 8, 11, 12, 13], "0": [0, 1, 2, 3, 4, 5, 6, 7, 8, 11, 12, 13], "2": [0, 1, 2, 3, 4, 5, 6, 7, 8, 11, 12, 13], "5": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "dev0": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "an": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "experiment": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "featur": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13], "opsgeniealerthook": [1, 5, 9, 10], "opsgenie_conn_id": [1, 5], "opsgenie_default": [1, 5], "sourc": [1, 5, 6, 7, 10, 13], "base": [1, 5, 6], "basehook": 1, "allow": [1, 5], "you": [1, 5, 10, 11], "post": [1, 5], "alert": [1, 5, 9, 10, 13], "accept": [1, 5], "connect": [1, 5, 9, 10], "ha": [1, 5], "api": [1, 5, 10], "kei": [1, 5, 10, 11], "": [1, 5, 9, 11], "password": [1, 5], "set": [1, 5], "domain": [1, 5], "conn_id": [1, 5], "host": [1, 5], "default": [1, 5], "http": [1, 5, 9, 10, 11], "com": [1, 5, 10, 11], "each": [1, 5], "can": [1, 5, 10, 11], "pre": [1, 5], "configur": [1, 5], "team": [1, 5], "integr": [1, 5, 9], "overrid": [1, 5], "paramet": [1, 5, 9], "str": [1, 5], "The": [1, 5, 11], "name": [1, 5, 9], "us": [1, 2, 5, 6, 9, 11], "conn_name_attr": 1, "default_conn_nam": 1, "conn_typ": 1, "hook_nam": 1, "get_conn": [1, 10], "get": [1, 11], "underli": 1, "alertapi": [1, 10], "client": [1, 5], "return": [1, 10], "type": [1, 5, 9, 10], "opsgenie_sdk": [1, 10], "create_alert": [1, 10], "payload": [1, 10], "none": [1, 5, 11], "creat": [1, 5, 11], "dict": [1, 5], "valu": [1, 5, 9], "see": [1, 9, 10], "doc": [1, 9], "section": 1, "respons": 1, "successrespons": [1, 10], "close_alert": [1, 9, 10], "identifi": [1, 5, 13], "identifier_typ": [1, 5], "id": [1, 5, 11], "kwarg": [1, 5, 6, 9, 10], "close": [1, 5, 13], "which": [1, 5], "could": [1, 5], "tini": [1, 5], "alia": [1, 5], "line": [1, 5, 9], "possibl": [1, 5], "ar": [1, 5, 10, 11], "request": [1, 5, 10], "action": [1, 5], "github": [1, 10], "python": [1, 9, 10, 11], "sdk": [1, 9, 10], "blob": [1, 10], "master": 1, "md": [1, 9, 10], "param": [1, 5], "pass": [1, 5], "function": 1, "If": [1, 10, 11], "method": [1, 10], "call": [1, 5], "asynchron": 1, "thread": 1, "delete_alert": 1, "user": [1, 5, 11], "delet": [1, 5, 13], "displai": [1, 5], "owner": [1, 5, 11], "modul": 2, "deprec": [2, 6], "pleas": [2, 6, 11], "hook": [3, 9, 10], "oper": [3, 9, 10], "opsgeniecreatealertoper": [5, 6, 9, 10, 12], "messag": [5, 13], "descript": [5, 9], "respond": 5, "visible_to": [5, 10], "tag": 5, "detail": [5, 9, 10, 11], "entiti": 5, "prioriti": 5, "note": [5, 9], "model": 5, "baseoper": 5, "For": [5, 9, 11], "more": [5, 9], "inform": [5, 9], "how": [5, 11], "take": [5, 10], "look": 5, "guid": [5, 11], "templat": 5, "defin": 5, "field": 5, "list": [5, 9, 10], "escal": 5, "schedul": 5, "rout": 5, "send": [5, 9, 10, 13], "notif": 5, "becom": 5, "visibl": 5, "without": 5, "ani": [5, 10, 11], "custom": 5, "avail": [5, 10, 11], "map": 5, "pair": 5, "properti": 5, "gener": [5, 9], "specifi": 5, "relat": [5, 9, 10], "ip": 5, "address": 5, "incom": 5, "level": [5, 9], "p3": 5, "addit": [5, 10], "ad": [5, 9, 10], "while": 5, "template_field": [5, 9], "sequenc": [5, 9], "execut": [5, 10], "context": [5, 9], "opsgenieclosealertoper": [5, 9, 10, 12], "close_alert_kwarg": 5, "opsgeniedeletealertoper": [5, 9, 10, 12], "opsgeniealertoper": [6, 9, 10], "arg": [6, 9], "env_id": 7, "dag_id": 7, "opsgenie_alert_operator_dag": 7, "opsgenie_alert_oper": [7, 13], "test_run": 7, "example_opsgenie_alert": [8, 13], "commit": 9, "chang": 9, "version": [9, 10, 11], "high": 9, "changelog": 9, "includ": 9, "latest": 9, "2022": 9, "06": 9, "07": 9, "subject": 9, "717a7588bc": 9, "updat": [9, 10], "remov": [9, 10, 11], "doubl": 9, "min": 9, "specif": [9, 13], "24292": 9, "aeabe994b3": 9, "prepar": 9, "mai": 9, "releas": [9, 10], "24231": 9, "027b707d21": 9, "05": 9, "add": [9, 10], "explanatori": 9, "contributor": 9, "about": [9, 11], "24229": 9, "f8223348c5": 9, "03": 9, "migrat": [9, 10], "exampl": [9, 10, 11], "dag": [9, 10], "new": 9, "design": 9, "22455": 9, "24144": 9, "12": [9, 11], "75c60923e0": 9, "document": [9, 10], "11": [9, 11], "23631": 9, "ca3fbbbe14": 9, "08": 9, "fix": 9, "properli": [9, 10], "23442": [9, 10], "38860c1627": 9, "23405": [9, 10], "22": 9, "d7dbfb7e26": 9, "bugfix": 9, "22383": 9, "14": 9, "16adc035b1": 9, "classifi": [9, 10], "march": 9, "22226": 9, "f5b96315fe": 9, "feb": 9, "22056": 9, "d94fa37830": 9, "02": 9, "januari": 9, "delai": 9, "21439": 9, "6c3a67d4fc": 9, "2021": [9, 11], "21257": 9, "602abe8394": 9, "01": 9, "20": 9, "now": [9, 10], "sphinx": 9, "autoapi": 9, "support": [9, 10], "typehint": 9, "20951": 9, "31": 9, "f77417eb0d": 9, "k8": 9, "pypi": [9, 10], "compat": 9, "20614": 9, "97496ba2b4": 9, "decemb": 9, "20523": 9, "d56e7b56bb": 9, "30": 9, "have": [9, 10], "mypi": 9, "friendli": 9, "20571": 9, "a0821235fb": 9, "everywher": 9, "20565": 9, "a63753764b": 9, "28": 9, "renam": [9, 10], "20514": [9, 10], "1728e35e00": 9, "27": 9, "20488": [9, 10], "d57ebb7a": 9, "organ": [9, 10], "class": [9, 10], "20454": [9, 10], "46a6088e11": 9, "21": 9, "rewrit": [9, 10], "offici": [9, 10, 11], "issu": [9, 10], "18641": [9, 10], "20263": [9, 10], "0a68588479": 9, "august": 9, "17890": 9, "be75dcd39c": 9, "23": 9, "meta": 9, "data": 9, "76ed2a49c6": 9, "19": 9, "import": [9, 10, 11], "lazili": 9, "individu": 9, "manag": [9, 11], "17682": 9, "87f408b1e7": 9, "26": 9, "rc2": 9, "juli": 9, "17116": 9, "b916b75079": 9, "15": 9, "17015": 9, "866a601b76": 9, "pylint": 9, "from": [9, 10], "our": 9, "toolchain": 9, "16682": 9, "18": 9, "bbc627a3da": 9, "16501": 9, "cbf8001d76": 9, "16": 9, "synchron": 9, "after": 9, "buggfix": 9, "16464": 9, "1fba5402bb": 9, "june": 9, "16405": 9, "9c94b72d44": 9, "16294": 9, "10ed42a837": 9, "extend": [9, 10], "16109": [9, 10], "37681bca00": 9, "auto": [9, 10], "appli": [9, 10], "apply_default": [9, 10], "decor": [9, 10], "15667": [9, 10], "04": 9, "042be2e4e0": 9, "befor": 9, "april": 9, "15236": 9, "68e4c4dcb0": 9, "backport": 9, "14886": 9, "6e6526a0f6": 9, "13": 9, "broken": 9, "14734": 9, "e468b3156c": 9, "hint": [9, 10], "14637": [9, 10], "88bdcfa0df": 9, "wave": 9, "14013": 9, "ac2f72c98d": 9, "implement": 9, "tool": 9, "13767": 9, "a9ac2b040b": 9, "switch": 9, "f": 9, "string": 9, "flynt": 9, "13732": 9, "3fd5ef3555": 9, "miss": 9, "logo": 9, "13717": 9, "295d66f914": 9, "2020": 9, "grammar": 9, "pip": [9, 10, 11], "warn": [9, 11], "13380": 9, "6cf76d7ac0": 9, "typo": 9, "upgrad": [9, 10], "command": 9, "13148": 9, "09": 9, "32971a1a2d": 9, "12955": 9, "c34ef853c8": 9, "separ": 9, "out": 9, "build": [9, 11], "per": 9, "12444": 9, "0080354502": 9, "readm": [9, 10], "0b2": 9, "batch": 9, "12449": 9, "ae7cb4a1e2": 9, "17": 9, "wrong": 9, "hash": 9, "12390": 9, "6889a333cf": 9, "improv": 9, "ref": 9, "12366": 9, "7825e8f590": 9, "instal": 9, "12304": 9, "85a18e13d9": 9, "point": 9, "project": 9, "page": [9, 11], "cross": 9, "depend": 9, "12212": 9, "59eb5de78c": 9, "up": 9, "come": 9, "0beta1": 9, "12206": 9, "b2a28d1590": 9, "move": 9, "script": [9, 11], "dev": 9, "12082": 9, "41bf172c1d": 9, "simplifi": 9, "express": 9, "12093": 9, "4e8f9cc8d0": 9, "enabl": 9, "black": 9, "formmatt": 9, "9550": 9, "5a439e84eb": 9, "10": [9, 10], "2a1": 9, "11855": 9, "872b1566a1": 9, "25": 9, "setup": 9, "29": 9, "11826": 9, "349b0811c3": 9, "d200": 9, "pydocstyl": 9, "check": [9, 11], "11688": 9, "16e7129719": 9, "11487": 9, "0a0e1af800": 9, "markdown": 9, "link": [9, 11], "toc": 9, "11249": 9, "ca4238eb4d": 9, "month": 9, "octob": 9, "11242": 9, "5220e4c384": 9, "11238": 9, "720912f67b": 9, "strict": 9, "multipl": 9, "11229": 9, "fdd9b6f65b": 9, "10543": 9, "3696c34c28": 9, "24": 9, "word": 9, "10528": 9, "ee7ca128a1": 9, "refernc": 9, "10483": 9, "cdec301254": 9, "correct": [9, 11], "signatur": [9, 11], "all": [9, 10], "sensor": 9, "10205": 9, "aeea71274d": 9, "constructor": [9, 10], "10097": 9, "d0e7db4024": 9, "number": 9, "fresh": 9, "9408": 9, "12af6a0800": 9, "final": 9, "cleanup": 9, "6": 9, "23rc1": 9, "9404": 9, "c7e5bce57f": 9, "candid": 9, "9370": 9, "f6bd817a3a": 9, "introduc": 9, "transfer": 9, "9320": 9, "0b0e4f7a4c": 9, "rc3": 9, "relas": 9, "9026": 9, "00642a46d0": 9, "remain": 9, "wrongli": 9, "8994": 9, "375d1ca229": 9, "8898": 9, "12c5e5d8a": 9, "8891": 9, "f3521fb0e3": 9, "regener": 9, "file": [9, 10, 11], "8886": 9, "92585ca4cb": 9, "autom": 9, "8807": 9, "4bde99f132": 9, "make": 9, "7802": 9, "305053cb7c": 9, "6889": 9, "mutabl": 9, "argument": [9, 10], "7512": 9, "4d03e33c11": 9, "6817": 9, "__init__": 9, "py": [9, 13], "replac": [9, 10], "implicit": 9, "explicit": 9, "entri": 9, "squash": 9, "rebas": 9, "7456": 9, "97a429f9d0": 9, "6714": 9, "magic": 9, "comment": 9, "utf": 9, "8": 9, "7338": 9, "9a04013b0": 9, "6646": 9, "aip": 9, "protocol": 9, "7268": 9, "c42a375e79": 9, "6644": 9, "servic": 9, "7265": 9, "repositori": 10, "top": [10, 11], "exist": 10, "below": [10, 11], "minimum": 10, "via": [10, 11], "onli": 10, "explain": 10, "polici": 10, "main": [10, 11], "mistakenli": 10, "install_requir": 10, "22382": 10, "trove": 10, "framework": 10, "doe": 10, "keyword": 10, "anymor": 10, "object": 10, "instead": 10, "session": 10, "opsegniealerthook": 10, "visibleto": 10, "request_id": 10, "requestid": 10, "optimis": 10, "due": 10, "your": 10, "want": [10, 11], "first": 10, "least": 10, "otherwis": 10, "automat": 10, "manual": 10, "run": [10, 11], "db": 10, "complet": 10, "initi": 10, "describ": 11, "download": 11, "apach": 11, "airflow": 11, "provid": [11, 13], "opsgeni": [11, 13], "also": 11, "most": 11, "choos": 11, "differ": 11, "select": 11, "drop": 11, "down": 11, "left": 11, "sdist": 11, "whl": 11, "origin": 11, "checksum": 11, "softwar": 11, "foundat": 11, "asc": 11, "sha512": 11, "those": 11, "code": 11, "abov": 11, "contain": 11, "pgp": 11, "It": 11, "essenti": 11, "sha": 11, "gpg": 11, "well": 11, "relev": 11, "distribut": 11, "recommend": 11, "directori": 11, "mirror": 11, "pgpk": 11, "ka": 11, "To": 11, "binari": 11, "follow": 11, "pgpv": 11, "tar": 11, "gz": 11, "made": 11, "sat": 11, "sep": 11, "49": 11, "54": 11, "bst": 11, "rsa": 11, "cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f": 11, "issuer": 11, "kaxilnaik": 11, "org": 11, "good": 11, "kaxil": 11, "naik": 11, "unknown": 11, "aka": 11, "gmail": 11, "certifi": 11, "trust": 11, "There": 11, "indic": 11, "belong": 11, "primari": 11, "fingerprint": 11, "cde1": 11, "5c6e": 11, "4d3a": 11, "8ec4": 11, "ecf4": 11, "ba4b": 11, "6674": 11, "e08a": 11, "d7de": 11, "406f": 11, "do": 11, "worri": 11, "certif": 11, "self": 11, "sign": 11, "why": 11, "By": 11, "server": 11, "previou": 11, "step": 11, "know": 11, "valid": 11, "alreadi": 11, "sum": 11, "shasum": 11, "512": 11, "diff": 11, "should": 11, "match": 11, "one": 11, "local": 11, "bin": 11, "bash": 11, "package_vers": 11, "package_nam": 11, "provider_download_dir": 11, "mktemp": 11, "d": 11, "dep": 11, "dest": 11, "curl": 11, "apache_airflow_providers_opsgeni": 11, "py3": 11, "l": 11, "o": 11, "echo": 11, "la": 11, "onc": 11, "instruct": 11, "chapter": 11, "temporari": 11, "folder": 11, "test": 13, "system": 13, "task_id": 13, "opsgenie_task": 13, "hello": 13, "world": 13, "opsgenie_close_alert_oper": 13, "opsgenie_close_task": 13, "identifier_exampl": 13, "opsgenie_delete_alert_oper": 13, "opsgenie_delete_task": 13}, "objects": {"airflow.providers": [[3, 0, 0, "-", "opsgenie"]], "airflow.providers.opsgenie": [[0, 0, 0, "-", "hooks"], [4, 0, 0, "-", "operators"]], "airflow.providers.opsgenie.hooks": [[1, 0, 0, "-", "opsgenie"], [2, 0, 0, "-", "opsgenie_alert"]], "airflow.providers.opsgenie.hooks.opsgenie": [[1, 1, 1, "", "OpsgenieAlertHook"]], "airflow.providers.opsgenie.hooks.opsgenie.OpsgenieAlertHook": [[1, 2, 1, "", "close_alert"], [1, 3, 1, "", "conn_name_attr"], [1, 3, 1, "", "conn_type"], [1, 2, 1, "", "create_alert"], [1, 3, 1, "", "default_conn_name"], [1, 2, 1, "", "delete_alert"], [1, 2, 1, "", "get_conn"], [1, 3, 1, "", "hook_name"]], "airflow.providers.opsgenie.operators": [[5, 0, 0, "-", "opsgenie"], [6, 0, 0, "-", "opsgenie_alert"]], "airflow.providers.opsgenie.operators.opsgenie": [[5, 1, 1, "", "OpsgenieCloseAlertOperator"], [5, 1, 1, "", "OpsgenieCreateAlertOperator"], [5, 1, 1, "", "OpsgenieDeleteAlertOperator"]], "airflow.providers.opsgenie.operators.opsgenie.OpsgenieCloseAlertOperator": [[5, 2, 1, "", "execute"]], "airflow.providers.opsgenie.operators.opsgenie.OpsgenieCreateAlertOperator": [[5, 2, 1, "", "execute"], [5, 3, 1, "", "template_fields"]], "airflow.providers.opsgenie.operators.opsgenie.OpsgenieDeleteAlertOperator": [[5, 2, 1, "", "execute"], [5, 3, 1, "", "template_fields"]], "airflow.providers.opsgenie.operators.opsgenie_alert": [[6, 1, 1, "", "OpsgenieAlertOperator"]], "tests.system.providers": [[8, 0, 0, "-", "opsgenie"]], "tests.system.providers.opsgenie": [[7, 0, 0, "-", "example_opsgenie_alert"]], "tests.system.providers.opsgenie.example_opsgenie_alert": [[7, 4, 1, "", "DAG_ID"], [7, 4, 1, "", "ENV_ID"], [7, 4, 1, "", "opsgenie_alert_operator"], [7, 4, 1, "", "test_run"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "data", "Python data"]}, "titleterms": {"airflow": [0, 1, 2, 3, 4, 5, 6, 9, 10], "provid": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "opsgeni": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12], "hook": [0, 1, 2], "submodul": [0, 4, 8], "modul": [1, 5, 6, 7], "content": [1, 5, 6, 7, 10], "class": [1, 5, 6], "opsgenie_alert": [2, 6], "subpackag": 3, "oper": [4, 5, 6, 12, 13], "test": [7, 8], "system": [7, 8], "example_opsgenie_alert": 7, "packag": [9, 10, 11], "apach": [9, 10], "4": [9, 10], "0": [9, 10], "3": [9, 10], "1": [9, 10], "2": [9, 10], "guid": 10, "refer": 10, "resourc": 10, "commit": 10, "instal": [10, 11], "requir": 10, "changelog": 10, "break": 10, "chang": 10, "featur": 10, "bug": 10, "fix": 10, "misc": 10, "from": 11, "sourc": 11, "releas": 11, "integr": 11, "verifi": 11, "pypi": 11, "opsgeniecreatealertoper": 13, "us": 13, "opsgenieclosealertoper": 13, "opsgeniedeletealertoper": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 56}})