blob: a431d4bd351dd35f1aadd8fe3fcc6c4b0229bfa7 [file] [log] [blame]
Search.setIndex({"docnames": ["_api/airflow/providers/dingding/hooks/dingding/index", "_api/airflow/providers/dingding/hooks/index", "_api/airflow/providers/dingding/index", "_api/airflow/providers/dingding/operators/dingding/index", "_api/airflow/providers/dingding/operators/index", "_api/tests/system/providers/dingding/example_dingding/index", "_api/tests/system/providers/dingding/index", "commits", "index", "installing-providers-from-sources", "operators"], "filenames": ["_api/airflow/providers/dingding/hooks/dingding/index.rst", "_api/airflow/providers/dingding/hooks/index.rst", "_api/airflow/providers/dingding/index.rst", "_api/airflow/providers/dingding/operators/dingding/index.rst", "_api/airflow/providers/dingding/operators/index.rst", "_api/tests/system/providers/dingding/example_dingding/index.rst", "_api/tests/system/providers/dingding/index.rst", "commits.rst", "index.rst", "installing-providers-from-sources.rst", "operators.rst"], "titles": ["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.dingding.hooks.dingding</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.dingding.hooks</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.dingding</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.dingding.operators.dingding</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.dingding.operators</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.dingding.example_dingding</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.dingding</span></code>", "Package apache-airflow-providers-dingding", "<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-dingding</span></code>", "Installing from sources", "Dingding Operators"], "terms": {"dingdinghook": 0, "dingding_conn_id": [0, 3], "dingding_default": [0, 3, 10], "message_typ": [0, 3, 10], "text": [0, 3], "messag": [0, 3], "none": [0, 3, 9, 10], "at_mobil": [0, 3, 10], "at_al": [0, 3, 10], "fals": [0, 3, 10], "arg": [0, 7], "kwarg": [0, 3], "sourc": [0, 3, 5, 8, 10], "base": [0, 3], "http": [0, 3, 7, 8, 9, 10], "httphook": 0, "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "allow": [0, 3], "you": [0, 3, 8, 9], "send": [0, 3], "us": [0, 3, 5, 7, 8, 9, 10], "custom": [0, 3, 10], "bot": [0, 3], "get": [0, 3, 9, 10], "token": [0, 3, 10], "from": [0, 3, 7, 8], "conn_id": [0, 3], "password": [0, 3, 10], "And": [0, 3], "prefer": [0, 3], "set": [0, 3, 10], "domain": [0, 3], "host": [0, 3], "default": [0, 3, 7, 10], "oapi": [0, 3, 10], "dingtalk": [0, 3, 7, 10], "com": [0, 3, 8, 9, 10], "For": [0, 3, 7, 8, 9], "more": [0, 3, 7], "detail": [0, 3, 7, 8, 9], "paramet": [0, 3, 5, 7, 10], "The": [0, 3, 5, 8, 9, 10], "name": [0, 3, 7], "connect": [0, 3, 7, 8], "str": [0, 3], "type": [0, 3, 7, 10], "want": [0, 3, 8, 9, 10], "support": [0, 3, 7, 8], "five": [0, 3], "so": [0, 3], "far": [0, 3], "includ": [0, 3, 7, 10], "link": [0, 3, 7, 8, 9, 10], "markdown": [0, 3, 7, 10], "actioncard": [0, 3, 10], "feedcard": [0, 3, 10], "option": [0, 3], "union": [0, 3], "dict": [0, 3], "chat": [0, 3], "group": [0, 3, 10], "list": [0, 3, 7, 8, 10], "remind": [0, 3], "specif": [0, 3, 7, 10], "user": [0, 3, 7, 9], "bool": [0, 3], "all": [0, 3, 7, 8, 10], "peopl": [0, 3], "If": [0, 3, 8, 9], "true": [0, 3, 10], "overwrit": [0, 3], "conn_name_attr": 0, "default_conn_nam": 0, "conn_typ": 0, "hook_nam": 0, "get_conn": 0, "header": 0, "becaus": 0, "just": [0, 10], "need": [0, 8], "base_url": 0, "don": 0, "t": 0, "gener": [0, 7], "param": [0, 10], "addit": 0, "pass": [0, 10], "through": 0, "dictionari": [0, 3], "3": [0, 1, 2, 3, 4, 5, 6, 9, 10], "0": [0, 1, 2, 3, 4, 5, 6, 9, 10], "2": [0, 1, 2, 3, 4, 5, 6, 9, 10], "4": [0, 1, 2, 3, 4, 5, 6, 9, 10], "dev0": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "an": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "experiment": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "featur": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "hook": [2, 7, 8], "oper": [2, 7, 8], "dingdingoper": [3, 5, 10], "model": 3, "baseoper": [3, 7], "template_field": [3, 7], "sequenc": [3, 7], "ui_color": 3, "4ea4d4": 3, "execut": [3, 5, 10], "context": [3, 5, 7, 10], "main": [3, 8, 9], "method": 3, "deriv": 3, "when": [3, 7, 8, 10], "creat": [3, 9], "same": 3, "render": 3, "jinja": 3, "templat": 3, "refer": [3, 7], "get_template_context": 3, "exampl": [5, 7, 8, 9, 10], "dag": [5, 7, 8, 10], "env_id": 5, "dag_id": [5, 10], "example_dingding_oper": 5, "failure_callback": [5, 10], "failur": [5, 10], "task": 5, "text_msg_remind_non": [5, 10], "test_run": 5, "example_dingd": [6, 10], "commit": 7, "chang": 7, "version": [7, 8, 9], "high": 7, "level": 7, "changelog": 7, "see": [7, 8, 10], "inform": 7, "latest": 7, "2022": 7, "06": 7, "07": 7, "subject": 7, "717a7588bc": 7, "updat": [7, 8], "descript": 7, "remov": [7, 8, 9], "doubl": 7, "min": 7, "24292": 7, "aeabe994b3": 7, "prepar": 7, "doc": [7, 8], "mai": 7, "": [7, 9], "releas": [7, 8], "24231": 7, "027b707d21": 7, "05": 7, "add": [7, 8, 10], "explanatori": 7, "note": 7, "contributor": 7, "about": [7, 9], "24229": 7, "942e1264a7": 7, "03": 7, "migrat": [7, 8], "new": 7, "design": 7, "22443": 7, "24133": 7, "75c60923e0": 7, "12": [7, 9], "document": [7, 8, 10], "11": [7, 9], "23631": 7, "2d109401b3": 7, "04": 7, "bump": 7, "pre": 7, "22887": 7, "8b6b0848a3": 7, "23": 7, "brees": 7, "build": [7, 9], "pull": 7, "verifi": [7, 8], "imag": 7, "23104": 7, "7fe97fb86f": 7, "13": 7, "tree": 7, "grid": 7, "22966": 7, "22": 7, "d7dbfb7e26": 7, "bugfix": 7, "22383": 7, "14": 7, "16adc035b1": 7, "classifi": [7, 8], "march": 7, "22226": 7, "f5b96315fe": 7, "feb": 7, "22056": 7, "d94fa37830": 7, "02": 7, "08": 7, "fix": 7, "januari": 7, "delai": 7, "21439": 7, "6c3a67d4fc": 7, "2021": [7, 9], "21257": 7, "602abe8394": 7, "01": 7, "20": 7, "line": 7, "now": 7, "sphinx": 7, "autoapi": 7, "typehint": 7, "20951": 7, "f77417eb0d": 7, "31": 7, "k8": 7, "pypi": [7, 8], "compat": 7, "20614": 7, "97496ba2b4": 7, "decemb": 7, "20523": 7, "d56e7b56bb": 7, "30": 7, "have": [7, 8], "mypi": 7, "friendli": 7, "20571": 7, "a0821235fb": 7, "everywher": 7, "20565": 7, "853576d901": 7, "novemb": 7, "19882": 7, "d9567eb106": 7, "10": [7, 8], "29": 7, "octob": 7, "19321": 7, "86a2a19ad2": 7, "17": 7, "f": [7, 10], "string": [7, 10], "18855": 7, "840ea3efb9": 7, "09": 7, "septemb": 7, "18613": 7, "ef037e7021": 7, "static": 7, "start_dat": 7, "cleanup": 7, "misc": 7, "18597": 7, "0a68588479": 7, "august": 7, "17890": 7, "be75dcd39c": 7, "meta": 7, "data": 7, "76ed2a49c6": 7, "19": 7, "import": [7, 8, 9], "lazili": 7, "individu": 7, "manag": [7, 9], "17682": 7, "87f408b1e7": 7, "26": 7, "rc2": 7, "juli": 7, "17116": 7, "0dbd0f420c": 7, "refactor": 7, "default_arg": 7, "pattern": 7, "miscellan": 7, "16872": 7, "18": 7, "bbc627a3da": 7, "16501": 7, "cbf8001d76": 7, "16": 7, "synchron": 7, "after": 7, "buggfix": 7, "16464": 7, "1fba5402bb": 7, "15": 7, "june": 7, "16405": 7, "9c94b72d44": 7, "16294": 7, "10ed42a837": 7, "27": 7, "extend": [7, 8], "16109": [7, 8], "37681bca00": 7, "auto": [7, 8], "appli": [7, 8], "apply_default": [7, 8], "decor": [7, 8], "15667": [7, 8], "807ad32ce5": 7, "pip": [7, 8, 9], "21": 7, "15576": 7, "814e471d13": 7, "check": [7, 9], "15583": 7, "40a2476a5d": 7, "28": 7, "interact": 7, "15518": 7, "266384a63f": 7, "concaten": 7, "15200": 7, "68e4c4dcb0": 7, "backport": 7, "14886": 7, "589d6dec92": 7, "next": 7, "wave": 7, "14487": 7, "e121812584": 7, "24": 7, "replac": [7, 8], "deprec": [7, 8], "correct": [7, 8, 9], "one": [7, 8, 9], "14429": [7, 8], "88bdcfa0df": 7, "14013": 7, "ac2f72c98d": 7, "implement": 7, "tool": 7, "13767": 7, "3fd5ef3555": 7, "miss": 7, "logo": [7, 10], "integr": 7, "13717": 7, "295d66f914": 7, "2020": 7, "grammar": 7, "warn": [7, 9], "13380": 7, "6cf76d7ac0": 7, "typo": 7, "upgrad": [7, 8], "command": 7, "13148": 7, "ed4926fa3f": 7, "site": [7, 8], "13043": 7, "32971a1a2d": 7, "12955": 7, "bd90136aaf": 7, "move": 7, "guid": [7, 9], "12681": 7, "de15aa30d4": 7, "read": 7, "12541": 7, "c34ef853c8": 7, "separ": 7, "out": 7, "per": 7, "12444": 7, "0080354502": 7, "readm": [7, 8], "0b2": 7, "batch": 7, "12449": 7, "ae7cb4a1e2": 7, "wrong": 7, "hash": 7, "12390": 7, "6889a333cf": 7, "improv": 7, "ref": 7, "12366": 7, "3a72fc8247": 7, "12361": 7, "7825e8f590": 7, "instal": 7, "12304": 7, "85a18e13d9": 7, "point": 7, "project": 7, "page": [7, 9], "cross": 7, "depend": 7, "12212": 7, "59eb5de78c": 7, "up": 7, "come": 7, "0beta1": 7, "12206": 7, "b2a28d1590": 7, "script": [7, 9], "dev": 7, "12082": 7, "41bf172c1d": 7, "simplifi": 7, "express": 7, "12093": 7, "4e8f9cc8d0": 7, "enabl": 7, "black": 7, "python": [7, 8, 9], "formmatt": 7, "9550": 7, "1dc7099315": 7, "ding": 7, "12063": 7, "8c42cf1b00": 7, "pyupgrad": 7, "6": 7, "11447": 7, "5a439e84eb": 7, "2a1": 7, "11855": 7, "872b1566a1": 7, "25": 7, "setup": 7, "11826": 7, "172820db4d": 7, "case": 7, "github": [7, 8], "11398": 7, "349b0811c3": 7, "d200": 7, "pydocstyl": 7, "11688": 7, "16e7129719": 7, "ad": [7, 8], "11487": 7, "0a0e1af800": 7, "broken": 7, "toc": 7, "11249": 7, "ca4238eb4d": 7, "month": 7, "11242": 7, "5220e4c384": 7, "11238": 7, "720912f67b": 7, "strict": 7, "multipl": 7, "11229": 7, "ce19657ec6": 7, "10955": 7, "fdd9b6f65b": 7, "10543": 7, "3696c34c28": 7, "word": 7, "10528": 7, "ee7ca128a1": 7, "refernc": 7, "10483": 7, "cdec301254": 7, "signatur": [7, 8, 9], "sensor": 7, "10205": 7, "aeea71274d": 7, "constructor": 7, "10097": 7, "7d24b088cd": 7, "stop": 7, "example_dag": 7, "9985": 7, "d0e7db4024": 7, "number": 7, "fresh": 7, "9408": 7, "12af6a0800": 7, "final": 7, "23rc1": 7, "9404": 7, "c7e5bce57f": 7, "candid": 7, "9370": 7, "f6bd817a3a": 7, "introduc": 7, "transfer": 7, "9320": 7, "0b0e4f7a4c": 7, "rc3": 7, "relas": 7, "9026": 7, "00642a46d0": 7, "remain": 7, "wrongli": 7, "8994": 7, "375d1ca229": 7, "8898": 7, "12c5e5d8a": 7, "8891": 7, "f3521fb0e3": 7, "regener": 7, "file": [7, 8, 9], "8886": 7, "92585ca4cb": 7, "autom": 7, "8807": 7, "4bde99f132": 7, "make": 7, "pylint": 7, "7802": 7, "3320e432a1": 7, "6817": 7, "lazi": 7, "load": 7, "keep": 7, "face": 7, "api": [7, 8], "untouch": 7, "7517": 7, "4d03e33c11": 7, "__init__": 7, "py": [7, 10], "implicit": 7, "explicit": 7, "entri": 7, "md": [7, 8], "squash": 7, "rebas": 7, "7456": 7, "97a429f9d0": 7, "6714": 7, "magic": 7, "comment": 7, "utf": 7, "8": 7, "7338": 7, "83c037873f": 7, "6674": [7, 9], "accord": 7, "aip": 7, "7287": 7, "ceea293c16": 7, "6656": 7, "7272": 7, "9a04013b0": 7, "6646": 7, "protocol": 7, "class": [7, 8], "7268": 7, "c42a375e79": 7, "6644": 7, "servic": 7, "7265": 7, "repositori": 8, "ar": [8, 9], "can": [8, 9, 10], "top": [8, 9], "exist": 8, "requir": 8, "below": [8, 9], "minimum": 8, "via": [8, 9], "those": [8, 9], "might": 8, "order": 8, "specifi": 8, "them": 8, "extra": 8, "checksum": [8, 9], "sdist": [8, 9], "asc": [8, 9], "sha512": [8, 9], "wheel": 8, "onli": 8, "avail": [8, 9], "explain": 8, "polici": 8, "blob": 8, "mistakenli": 8, "install_requir": 8, "22382": 8, "trove": 8, "framework": 8, "optimis": 8, "due": 8, "your": 8, "first": 8, "least": 8, "otherwis": 8, "automat": 8, "manual": 8, "run": [8, 9], "db": 8, "complet": 8, "initi": 8, "describ": 9, "download": 9, "apach": [9, 10], "airflow": [9, 10], "provid": [9, 10], "dingd": 9, "offici": 9, "also": 9, "most": 9, "choos": 9, "differ": 9, "select": 9, "drop": 9, "down": 9, "left": 9, "whl": 9, "origin": 9, "softwar": 9, "foundat": 9, "code": 9, "abov": 9, "contain": 9, "how": [9, 10], "pgp": 9, "kei": 9, "It": 9, "essenti": 9, "sha": 9, "gpg": 9, "pleas": 9, "well": 9, "relev": 9, "distribut": 9, "recommend": 9, "directori": 9, "mirror": 9, "pgpk": 9, "ka": 9, "To": [9, 10], "binari": 9, "follow": 9, "pgpv": 9, "tar": 9, "gz": 9, "made": 9, "sat": 9, "sep": 9, "49": 9, "54": 9, "bst": 9, "rsa": 9, "cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f": 9, "issuer": 9, "kaxilnaik": 9, "org": [9, 10], "good": 9, "kaxil": 9, "naik": 9, "unknown": 9, "aka": 9, "gmail": 9, "id": 9, "certifi": 9, "trust": 9, "There": 9, "indic": 9, "belong": 9, "owner": 9, "primari": 9, "fingerprint": 9, "cde1": 9, "5c6e": 9, "4d3a": 9, "8ec4": 9, "ecf4": 9, "ba4b": 9, "e08a": 9, "d7de": 9, "406f": 9, "do": [9, 10], "worri": 9, "certif": 9, "self": 9, "sign": 9, "why": 9, "By": 9, "server": 9, "previou": 9, "step": 9, "know": 9, "valid": 9, "alreadi": 9, "sum": 9, "shasum": 9, "512": 9, "diff": 9, "should": 9, "match": 9, "local": 9, "bin": 9, "bash": 9, "package_vers": 9, "package_nam": 9, "provider_download_dir": 9, "mktemp": 9, "d": 9, "dep": 9, "dest": 9, "curl": 9, "apache_airflow_providers_dingd": 9, "py3": 9, "ani": 9, "l": 9, "o": 9, "echo": 9, "la": 9, "onc": 9, "instruct": 9, "chapter": 9, "temporari": 9, "folder": 9, "must": 10, "few": 10, "thing": 10, "robot": 10, "which": 10, "webhook": 10, "put": 10, "field": 10, "notic": 10, "rather": 10, "than": 10, "whole": 10, "test": 10, "system": 10, "task_id": 10, "ignor": 10, "text_msg_remind_al": 10, "phone": 10, "email": 10, "here": 10, "cover": 10, "156xxxxxxxx": 10, "130xxxxxxxx": 10, "A": 10, "except": 10, "markdown_msg": 10, "titl": 10, "n": 10, "content": 10, "sub": 10, "_imag": 10, "pin_larg": 10, "png": 10, "could": 10, "handl": 10, "write": 10, "function": 10, "wrapper": 10, "sla_miss_callback": 10, "on_success_callback": 10, "on_failure_callback": 10, "on_retry_callback": 10, "we": 10, "def": 10, "tip": 10, "task_inst": 10, "reason": 10, "return": 10, "dingding_success_callback": 10, "post": 10, "request": 10}, "objects": {"airflow.providers": [[2, 0, 0, "-", "dingding"]], "airflow.providers.dingding": [[1, 0, 0, "-", "hooks"], [4, 0, 0, "-", "operators"]], "airflow.providers.dingding.hooks": [[0, 0, 0, "-", "dingding"]], "airflow.providers.dingding.hooks.dingding": [[0, 1, 1, "", "DingdingHook"]], "airflow.providers.dingding.hooks.dingding.DingdingHook": [[0, 2, 1, "", "conn_name_attr"], [0, 2, 1, "", "conn_type"], [0, 2, 1, "", "default_conn_name"], [0, 3, 1, "", "get_conn"], [0, 2, 1, "", "hook_name"], [0, 3, 1, "", "send"]], "airflow.providers.dingding.operators": [[3, 0, 0, "-", "dingding"]], "airflow.providers.dingding.operators.dingding": [[3, 1, 1, "", "DingdingOperator"]], "airflow.providers.dingding.operators.dingding.DingdingOperator": [[3, 3, 1, "", "execute"], [3, 2, 1, "", "template_fields"], [3, 2, 1, "", "ui_color"]], "tests.system.providers": [[6, 0, 0, "-", "dingding"]], "tests.system.providers.dingding": [[5, 0, 0, "-", "example_dingding"]], "tests.system.providers.dingding.example_dingding": [[5, 4, 1, "", "DAG_ID"], [5, 4, 1, "", "ENV_ID"], [5, 5, 1, "", "failure_callback"], [5, 4, 1, "", "test_run"], [5, 4, 1, "", "text_msg_remind_none"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:data", "5": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "data", "Python data"], "5": ["py", "function", "Python function"]}, "titleterms": {"airflow": [0, 1, 2, 3, 4, 7, 8], "provid": [0, 1, 2, 3, 4, 5, 6, 7, 8], "dingd": [0, 1, 2, 3, 4, 5, 6, 7, 8, 10], "hook": [0, 1], "modul": [0, 3, 5], "content": [0, 3, 5, 8], "class": [0, 3], "submodul": [1, 4, 6], "subpackag": 2, "oper": [3, 4, 10], "test": [5, 6], "system": [5, 6], "example_dingd": 5, "function": 5, "attribut": 5, "packag": [7, 8, 9], "apach": [7, 8], "3": [7, 8], "0": [7, 8], "2": [7, 8], "4": [7, 8], "1": [7, 8], "guid": 8, "refer": 8, "resourc": 8, "commit": 8, "instal": [8, 9], "cross": 8, "depend": 8, "download": 8, "offici": 8, "changelog": 8, "break": 8, "chang": [8, 10], "bug": 8, "fix": 8, "misc": 8, "from": [9, 10], "sourc": 9, "releas": 9, "integr": 9, "verifi": 9, "pypi": 9, "prerequisit": 10, "task": 10, "basic": 10, "usag": 10, "remind": 10, "user": 10, "messag": 10, "send": 10, "rich": 10, "text": 10, "callback": 10, "connect": 10, "host": 10, "you": 10, "need": 10, "more": 10, "inform": 10}, "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}})