| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>API — apache-dolphinscheduler 0.0.1 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" /> |
| <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=4c969af8" /> |
| <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" /> |
| |
| |
| <!--[if lt IE 9]> |
| <script src="_static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=d45e8c67"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/tabs.js?v=3ee01567"></script> |
| <script src="_static/clipboard.min.js?v=a7894cd8"></script> |
| <script src="_static/copybutton.js?v=f281be69"></script> |
| <script src="_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="prev" title="Sub Process" href="tasks/sub_process.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> |
| apache-dolphinscheduler |
| </a> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="start.html">Getting Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="concept.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="tasks/index.html">Tasks</a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">API</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#module-pydolphinscheduler.core">Core</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.core.Database"><code class="docutils literal notranslate"><span class="pre">Database</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.clear"><code class="docutils literal notranslate"><span class="pre">Database.clear()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.copy"><code class="docutils literal notranslate"><span class="pre">Database.copy()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.fromkeys"><code class="docutils literal notranslate"><span class="pre">Database.fromkeys()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.get"><code class="docutils literal notranslate"><span class="pre">Database.get()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.get_database_info"><code class="docutils literal notranslate"><span class="pre">Database.get_database_info()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.items"><code class="docutils literal notranslate"><span class="pre">Database.items()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.keys"><code class="docutils literal notranslate"><span class="pre">Database.keys()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.pop"><code class="docutils literal notranslate"><span class="pre">Database.pop()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.popitem"><code class="docutils literal notranslate"><span class="pre">Database.popitem()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.setdefault"><code class="docutils literal notranslate"><span class="pre">Database.setdefault()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.update"><code class="docutils literal notranslate"><span class="pre">Database.update()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.values"><code class="docutils literal notranslate"><span class="pre">Database.values()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.database_id"><code class="docutils literal notranslate"><span class="pre">Database.database_id</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Database.database_type"><code class="docutils literal notranslate"><span class="pre">Database.database_type</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition._ensure_side_model_exists"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition._ensure_side_model_exists()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition._handle_root_relation"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition._handle_root_relation()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition._parse_datetime"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition._parse_datetime()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition._pre_submit_check"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition._pre_submit_check()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.add_task"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.add_task()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.add_tasks"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.add_tasks()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.get_define"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.get_define_custom"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.get_one_task_by_name"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.get_one_task_by_name()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.get_task"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.get_task()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.get_tasks_by_name"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.get_tasks_by_name()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.run"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.run()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.start"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.start()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.submit"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.submit()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.end_time"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.end_time</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.param_json"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.param_json</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.project"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.project</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.schedule_json"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.schedule_json</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.start_time"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.start_time</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.task_definition_json"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.task_definition_json</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.task_list"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.task_list</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.task_location"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.task_location</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.task_relation_json"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.task_relation_json</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.tenant"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.tenant</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.user"><code class="docutils literal notranslate"><span class="pre">ProcessDefinition.user</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.core.Task"><code class="docutils literal notranslate"><span class="pre">Task</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task._set_deps"><code class="docutils literal notranslate"><span class="pre">Task._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">Task.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task.get_define"><code class="docutils literal notranslate"><span class="pre">Task.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Task.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task.set_downstream"><code class="docutils literal notranslate"><span class="pre">Task.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task.set_upstream"><code class="docutils literal notranslate"><span class="pre">Task.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">Task.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Task._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Task._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Task._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">Task._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task.condition_result"><code class="docutils literal notranslate"><span class="pre">Task.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task.process_definition"><code class="docutils literal notranslate"><span class="pre">Task.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.core.Task.task_params"><code class="docutils literal notranslate"><span class="pre">Task.task_params</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#module-pydolphinscheduler.side">Sides</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.side.Project"><code class="docutils literal notranslate"><span class="pre">Project</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Project.create_if_not_exists"><code class="docutils literal notranslate"><span class="pre">Project.create_if_not_exists()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Project.get_define"><code class="docutils literal notranslate"><span class="pre">Project.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Project.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Project.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Project._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Project._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Project._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Project._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Project._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Project._KEY_ATTR</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.side.Queue"><code class="docutils literal notranslate"><span class="pre">Queue</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Queue.create_if_not_exists"><code class="docutils literal notranslate"><span class="pre">Queue.create_if_not_exists()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Queue.get_define"><code class="docutils literal notranslate"><span class="pre">Queue.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Queue.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Queue.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Queue._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Queue._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Queue._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Queue._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Queue._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Queue._KEY_ATTR</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.side.Tenant"><code class="docutils literal notranslate"><span class="pre">Tenant</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Tenant.create_if_not_exists"><code class="docutils literal notranslate"><span class="pre">Tenant.create_if_not_exists()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Tenant.get_define"><code class="docutils literal notranslate"><span class="pre">Tenant.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Tenant.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Tenant.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Tenant._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Tenant._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Tenant._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Tenant._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.Tenant._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Tenant._KEY_ATTR</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.side.User"><code class="docutils literal notranslate"><span class="pre">User</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.User.create_if_not_exists"><code class="docutils literal notranslate"><span class="pre">User.create_if_not_exists()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.User.get_define"><code class="docutils literal notranslate"><span class="pre">User.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.User.get_define_custom"><code class="docutils literal notranslate"><span class="pre">User.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.User._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">User._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.User._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">User._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.User._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">User._KEY_ATTR</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.side.WorkerGroup"><code class="docutils literal notranslate"><span class="pre">WorkerGroup</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.WorkerGroup.create_if_not_exists"><code class="docutils literal notranslate"><span class="pre">WorkerGroup.create_if_not_exists()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.WorkerGroup.get_define"><code class="docutils literal notranslate"><span class="pre">WorkerGroup.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.WorkerGroup.get_define_custom"><code class="docutils literal notranslate"><span class="pre">WorkerGroup.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.WorkerGroup._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">WorkerGroup._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.WorkerGroup._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">WorkerGroup._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.side.WorkerGroup._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">WorkerGroup._KEY_ATTR</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#module-pydolphinscheduler.tasks">Tasks</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition"><code class="docutils literal notranslate"><span class="pre">Condition</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition._set_dep"><code class="docutils literal notranslate"><span class="pre">Condition._set_dep()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition._set_deps"><code class="docutils literal notranslate"><span class="pre">Condition._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">Condition.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition.get_define"><code class="docutils literal notranslate"><span class="pre">Condition.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Condition.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition.set_downstream"><code class="docutils literal notranslate"><span class="pre">Condition.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition.set_upstream"><code class="docutils literal notranslate"><span class="pre">Condition.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">Condition.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Condition._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Condition._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Condition._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Condition._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">Condition._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition._task_relation"><code class="docutils literal notranslate"><span class="pre">Condition._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Condition._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition.condition_result"><code class="docutils literal notranslate"><span class="pre">Condition.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition.process_definition"><code class="docutils literal notranslate"><span class="pre">Condition.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Condition.task_params"><code class="docutils literal notranslate"><span class="pre">Condition.task_params</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX"><code class="docutils literal notranslate"><span class="pre">DataX</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX._set_deps"><code class="docutils literal notranslate"><span class="pre">DataX._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">DataX.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX.get_define"><code class="docutils literal notranslate"><span class="pre">DataX.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX.get_define_custom"><code class="docutils literal notranslate"><span class="pre">DataX.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX.set_downstream"><code class="docutils literal notranslate"><span class="pre">DataX.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX.set_upstream"><code class="docutils literal notranslate"><span class="pre">DataX.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX.CUSTOM_CONFIG"><code class="docutils literal notranslate"><span class="pre">DataX.CUSTOM_CONFIG</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">DataX.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">DataX._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">DataX._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">DataX._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">DataX._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">DataX._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX._task_relation"><code class="docutils literal notranslate"><span class="pre">DataX._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">DataX._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX.condition_result"><code class="docutils literal notranslate"><span class="pre">DataX.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX.process_definition"><code class="docutils literal notranslate"><span class="pre">DataX.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.DataX.task_params"><code class="docutils literal notranslate"><span class="pre">DataX.task_params</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent"><code class="docutils literal notranslate"><span class="pre">Dependent</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent._set_deps"><code class="docutils literal notranslate"><span class="pre">Dependent._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">Dependent.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent.get_define"><code class="docutils literal notranslate"><span class="pre">Dependent.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Dependent.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent.set_downstream"><code class="docutils literal notranslate"><span class="pre">Dependent.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent.set_upstream"><code class="docutils literal notranslate"><span class="pre">Dependent.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">Dependent.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Dependent._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Dependent._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Dependent._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Dependent._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">Dependent._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent._task_relation"><code class="docutils literal notranslate"><span class="pre">Dependent._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Dependent._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent.condition_result"><code class="docutils literal notranslate"><span class="pre">Dependent.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent.process_definition"><code class="docutils literal notranslate"><span class="pre">Dependent.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Dependent.task_params"><code class="docutils literal notranslate"><span class="pre">Dependent.task_params</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink"><code class="docutils literal notranslate"><span class="pre">Flink</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink._set_deps"><code class="docutils literal notranslate"><span class="pre">Flink._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">Flink.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink.get_define"><code class="docutils literal notranslate"><span class="pre">Flink.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Flink.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink.get_jar_id"><code class="docutils literal notranslate"><span class="pre">Flink.get_jar_id()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink.get_resource_info"><code class="docutils literal notranslate"><span class="pre">Flink.get_resource_info()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink.set_downstream"><code class="docutils literal notranslate"><span class="pre">Flink.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink.set_upstream"><code class="docutils literal notranslate"><span class="pre">Flink.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">Flink.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Flink._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Flink._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Flink._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Flink._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">Flink._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink._task_relation"><code class="docutils literal notranslate"><span class="pre">Flink._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Flink._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink.condition_result"><code class="docutils literal notranslate"><span class="pre">Flink.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink.process_definition"><code class="docutils literal notranslate"><span class="pre">Flink.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Flink.task_params"><code class="docutils literal notranslate"><span class="pre">Flink.task_params</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.Http"><code class="docutils literal notranslate"><span class="pre">Http</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http._set_deps"><code class="docutils literal notranslate"><span class="pre">Http._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">Http.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http.get_define"><code class="docutils literal notranslate"><span class="pre">Http.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Http.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http.set_downstream"><code class="docutils literal notranslate"><span class="pre">Http.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http.set_upstream"><code class="docutils literal notranslate"><span class="pre">Http.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">Http.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Http._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Http._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Http._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Http._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">Http._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http._task_relation"><code class="docutils literal notranslate"><span class="pre">Http._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Http._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http.condition_result"><code class="docutils literal notranslate"><span class="pre">Http.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http.process_definition"><code class="docutils literal notranslate"><span class="pre">Http.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Http.task_params"><code class="docutils literal notranslate"><span class="pre">Http.task_params</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.MR"><code class="docutils literal notranslate"><span class="pre">MR</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR._set_deps"><code class="docutils literal notranslate"><span class="pre">MR._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">MR.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR.get_define"><code class="docutils literal notranslate"><span class="pre">MR.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR.get_define_custom"><code class="docutils literal notranslate"><span class="pre">MR.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR.get_jar_id"><code class="docutils literal notranslate"><span class="pre">MR.get_jar_id()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR.get_resource_info"><code class="docutils literal notranslate"><span class="pre">MR.get_resource_info()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR.set_downstream"><code class="docutils literal notranslate"><span class="pre">MR.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR.set_upstream"><code class="docutils literal notranslate"><span class="pre">MR.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">MR.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">MR._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">MR._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">MR._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">MR._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">MR._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR._task_relation"><code class="docutils literal notranslate"><span class="pre">MR._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">MR._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR.condition_result"><code class="docutils literal notranslate"><span class="pre">MR.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR.process_definition"><code class="docutils literal notranslate"><span class="pre">MR.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.MR.task_params"><code class="docutils literal notranslate"><span class="pre">MR.task_params</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure"><code class="docutils literal notranslate"><span class="pre">Procedure</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure._set_deps"><code class="docutils literal notranslate"><span class="pre">Procedure._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">Procedure.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure.get_define"><code class="docutils literal notranslate"><span class="pre">Procedure.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Procedure.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure.set_downstream"><code class="docutils literal notranslate"><span class="pre">Procedure.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure.set_upstream"><code class="docutils literal notranslate"><span class="pre">Procedure.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">Procedure.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Procedure._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Procedure._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Procedure._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Procedure._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">Procedure._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure._task_relation"><code class="docutils literal notranslate"><span class="pre">Procedure._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Procedure._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure.condition_result"><code class="docutils literal notranslate"><span class="pre">Procedure.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure.process_definition"><code class="docutils literal notranslate"><span class="pre">Procedure.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Procedure.task_params"><code class="docutils literal notranslate"><span class="pre">Procedure.task_params</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.Python"><code class="docutils literal notranslate"><span class="pre">Python</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python._set_deps"><code class="docutils literal notranslate"><span class="pre">Python._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">Python.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python.get_define"><code class="docutils literal notranslate"><span class="pre">Python.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Python.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python.set_downstream"><code class="docutils literal notranslate"><span class="pre">Python.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python.set_upstream"><code class="docutils literal notranslate"><span class="pre">Python.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">Python.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Python._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Python._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Python._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Python._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">Python._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python._task_relation"><code class="docutils literal notranslate"><span class="pre">Python._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Python._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python.condition_result"><code class="docutils literal notranslate"><span class="pre">Python.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python.process_definition"><code class="docutils literal notranslate"><span class="pre">Python.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python.raw_script"><code class="docutils literal notranslate"><span class="pre">Python.raw_script</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Python.task_params"><code class="docutils literal notranslate"><span class="pre">Python.task_params</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell"><code class="docutils literal notranslate"><span class="pre">Shell</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell._set_deps"><code class="docutils literal notranslate"><span class="pre">Shell._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">Shell.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell.get_define"><code class="docutils literal notranslate"><span class="pre">Shell.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Shell.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell.set_downstream"><code class="docutils literal notranslate"><span class="pre">Shell.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell.set_upstream"><code class="docutils literal notranslate"><span class="pre">Shell.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">Shell.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Shell._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Shell._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Shell._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Shell._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">Shell._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell._task_relation"><code class="docutils literal notranslate"><span class="pre">Shell._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Shell._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell.condition_result"><code class="docutils literal notranslate"><span class="pre">Shell.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell.process_definition"><code class="docutils literal notranslate"><span class="pre">Shell.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Shell.task_params"><code class="docutils literal notranslate"><span class="pre">Shell.task_params</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark"><code class="docutils literal notranslate"><span class="pre">Spark</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark._set_deps"><code class="docutils literal notranslate"><span class="pre">Spark._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">Spark.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark.get_define"><code class="docutils literal notranslate"><span class="pre">Spark.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Spark.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark.get_jar_id"><code class="docutils literal notranslate"><span class="pre">Spark.get_jar_id()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark.get_resource_info"><code class="docutils literal notranslate"><span class="pre">Spark.get_resource_info()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark.set_downstream"><code class="docutils literal notranslate"><span class="pre">Spark.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark.set_upstream"><code class="docutils literal notranslate"><span class="pre">Spark.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">Spark.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Spark._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Spark._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Spark._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Spark._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">Spark._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark._task_relation"><code class="docutils literal notranslate"><span class="pre">Spark._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Spark._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark.condition_result"><code class="docutils literal notranslate"><span class="pre">Spark.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark.process_definition"><code class="docutils literal notranslate"><span class="pre">Spark.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Spark.task_params"><code class="docutils literal notranslate"><span class="pre">Spark.task_params</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql"><code class="docutils literal notranslate"><span class="pre">Sql</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql._set_deps"><code class="docutils literal notranslate"><span class="pre">Sql._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">Sql.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql.get_define"><code class="docutils literal notranslate"><span class="pre">Sql.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Sql.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql.set_downstream"><code class="docutils literal notranslate"><span class="pre">Sql.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql.set_upstream"><code class="docutils literal notranslate"><span class="pre">Sql.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">Sql.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Sql._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Sql._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Sql._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Sql._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">Sql._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql._task_relation"><code class="docutils literal notranslate"><span class="pre">Sql._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Sql._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql.condition_result"><code class="docutils literal notranslate"><span class="pre">Sql.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql.process_definition"><code class="docutils literal notranslate"><span class="pre">Sql.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql.sql_type"><code class="docutils literal notranslate"><span class="pre">Sql.sql_type</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Sql.task_params"><code class="docutils literal notranslate"><span class="pre">Sql.task_params</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess"><code class="docutils literal notranslate"><span class="pre">SubProcess</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess._set_deps"><code class="docutils literal notranslate"><span class="pre">SubProcess._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">SubProcess.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.get_define"><code class="docutils literal notranslate"><span class="pre">SubProcess.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.get_define_custom"><code class="docutils literal notranslate"><span class="pre">SubProcess.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.get_process_definition_info"><code class="docutils literal notranslate"><span class="pre">SubProcess.get_process_definition_info()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.set_downstream"><code class="docutils literal notranslate"><span class="pre">SubProcess.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.set_upstream"><code class="docutils literal notranslate"><span class="pre">SubProcess.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">SubProcess.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">SubProcess._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">SubProcess._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">SubProcess._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">SubProcess._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">SubProcess._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess._task_relation"><code class="docutils literal notranslate"><span class="pre">SubProcess._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">SubProcess._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.condition_result"><code class="docutils literal notranslate"><span class="pre">SubProcess.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.process_definition"><code class="docutils literal notranslate"><span class="pre">SubProcess.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.process_definition_code"><code class="docutils literal notranslate"><span class="pre">SubProcess.process_definition_code</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.task_params"><code class="docutils literal notranslate"><span class="pre">SubProcess.task_params</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch"><code class="docutils literal notranslate"><span class="pre">Switch</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch._set_dep"><code class="docutils literal notranslate"><span class="pre">Switch._set_dep()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch._set_deps"><code class="docutils literal notranslate"><span class="pre">Switch._set_deps()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch.gen_code_and_version"><code class="docutils literal notranslate"><span class="pre">Switch.gen_code_and_version()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch.get_define"><code class="docutils literal notranslate"><span class="pre">Switch.get_define()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch.get_define_custom"><code class="docutils literal notranslate"><span class="pre">Switch.get_define_custom()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch.set_downstream"><code class="docutils literal notranslate"><span class="pre">Switch.set_downstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch.set_upstream"><code class="docutils literal notranslate"><span class="pre">Switch.set_upstream()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch.DEFAULT_CONDITION_RESULT"><code class="docutils literal notranslate"><span class="pre">Switch.DEFAULT_CONDITION_RESULT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch._DEFAULT_ATTR"><code class="docutils literal notranslate"><span class="pre">Switch._DEFAULT_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch._DEFINE_ATTR"><code class="docutils literal notranslate"><span class="pre">Switch._DEFINE_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch._KEY_ATTR"><code class="docutils literal notranslate"><span class="pre">Switch._KEY_ATTR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch._downstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Switch._downstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch._task_custom_attr"><code class="docutils literal notranslate"><span class="pre">Switch._task_custom_attr</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch._task_relation"><code class="docutils literal notranslate"><span class="pre">Switch._task_relation</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch._upstream_task_codes"><code class="docutils literal notranslate"><span class="pre">Switch._upstream_task_codes</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch.condition_result"><code class="docutils literal notranslate"><span class="pre">Switch.condition_result</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch.process_definition"><code class="docutils literal notranslate"><span class="pre">Switch.process_definition</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.tasks.Switch.task_params"><code class="docutils literal notranslate"><span class="pre">Switch.task_params</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#module-pydolphinscheduler.constants">Constants</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.constants.DefaultTaskCodeNum"><code class="docutils literal notranslate"><span class="pre">DefaultTaskCodeNum</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.DefaultTaskCodeNum.DEFAULT"><code class="docutils literal notranslate"><span class="pre">DefaultTaskCodeNum.DEFAULT</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.constants.Delimiter"><code class="docutils literal notranslate"><span class="pre">Delimiter</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.Delimiter.BAR"><code class="docutils literal notranslate"><span class="pre">Delimiter.BAR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.Delimiter.COLON"><code class="docutils literal notranslate"><span class="pre">Delimiter.COLON</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.Delimiter.DASH"><code class="docutils literal notranslate"><span class="pre">Delimiter.DASH</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.Delimiter.DIRECTION"><code class="docutils literal notranslate"><span class="pre">Delimiter.DIRECTION</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.Delimiter.UNDERSCORE"><code class="docutils literal notranslate"><span class="pre">Delimiter.UNDERSCORE</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.constants.JavaGatewayDefault"><code class="docutils literal notranslate"><span class="pre">JavaGatewayDefault</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.JavaGatewayDefault.AUTO_CONVERT"><code class="docutils literal notranslate"><span class="pre">JavaGatewayDefault.AUTO_CONVERT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_DATA"><code class="docutils literal notranslate"><span class="pre">JavaGatewayDefault.RESULT_DATA</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_MESSAGE_KEYWORD"><code class="docutils literal notranslate"><span class="pre">JavaGatewayDefault.RESULT_MESSAGE_KEYWORD</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_MESSAGE_SUCCESS"><code class="docutils literal notranslate"><span class="pre">JavaGatewayDefault.RESULT_MESSAGE_SUCCESS</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_STATUS_KEYWORD"><code class="docutils literal notranslate"><span class="pre">JavaGatewayDefault.RESULT_STATUS_KEYWORD</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_STATUS_SUCCESS"><code class="docutils literal notranslate"><span class="pre">JavaGatewayDefault.RESULT_STATUS_SUCCESS</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.JavaGatewayDefault.SERVER_ADDRESS"><code class="docutils literal notranslate"><span class="pre">JavaGatewayDefault.SERVER_ADDRESS</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.JavaGatewayDefault.SERVER_PORT"><code class="docutils literal notranslate"><span class="pre">JavaGatewayDefault.SERVER_PORT</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionDefault"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionDefault</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.PROJECT"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionDefault.PROJECT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.QUEUE"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionDefault.QUEUE</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.TENANT"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionDefault.TENANT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.TIME_ZONE"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionDefault.TIME_ZONE</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.USER"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionDefault.USER</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.USER_EMAIL"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionDefault.USER_EMAIL</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.USER_PHONE"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionDefault.USER_PHONE</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.USER_PWD"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionDefault.USER_PWD</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.USER_STATE"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionDefault.USER_STATE</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.WORKER_GROUP"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionDefault.WORKER_GROUP</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionReleaseState"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionReleaseState</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionReleaseState.OFFLINE"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionReleaseState.OFFLINE</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionReleaseState.ONLINE"><code class="docutils literal notranslate"><span class="pre">ProcessDefinitionReleaseState.ONLINE</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.constants.TaskFlag"><code class="docutils literal notranslate"><span class="pre">TaskFlag</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskFlag.NO"><code class="docutils literal notranslate"><span class="pre">TaskFlag.NO</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskFlag.YES"><code class="docutils literal notranslate"><span class="pre">TaskFlag.YES</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.constants.TaskPriority"><code class="docutils literal notranslate"><span class="pre">TaskPriority</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskPriority.HIGH"><code class="docutils literal notranslate"><span class="pre">TaskPriority.HIGH</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskPriority.HIGHEST"><code class="docutils literal notranslate"><span class="pre">TaskPriority.HIGHEST</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskPriority.LOW"><code class="docutils literal notranslate"><span class="pre">TaskPriority.LOW</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskPriority.LOWEST"><code class="docutils literal notranslate"><span class="pre">TaskPriority.LOWEST</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskPriority.MEDIUM"><code class="docutils literal notranslate"><span class="pre">TaskPriority.MEDIUM</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.constants.TaskTimeoutFlag"><code class="docutils literal notranslate"><span class="pre">TaskTimeoutFlag</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskTimeoutFlag.CLOSE"><code class="docutils literal notranslate"><span class="pre">TaskTimeoutFlag.CLOSE</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType"><code class="docutils literal notranslate"><span class="pre">TaskType</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.CONDITIONS"><code class="docutils literal notranslate"><span class="pre">TaskType.CONDITIONS</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.DATAX"><code class="docutils literal notranslate"><span class="pre">TaskType.DATAX</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.DEPENDENT"><code class="docutils literal notranslate"><span class="pre">TaskType.DEPENDENT</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.FLINK"><code class="docutils literal notranslate"><span class="pre">TaskType.FLINK</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.HTTP"><code class="docutils literal notranslate"><span class="pre">TaskType.HTTP</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.MR"><code class="docutils literal notranslate"><span class="pre">TaskType.MR</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.PROCEDURE"><code class="docutils literal notranslate"><span class="pre">TaskType.PROCEDURE</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.PYTHON"><code class="docutils literal notranslate"><span class="pre">TaskType.PYTHON</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.SHELL"><code class="docutils literal notranslate"><span class="pre">TaskType.SHELL</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.SPARK"><code class="docutils literal notranslate"><span class="pre">TaskType.SPARK</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.SQL"><code class="docutils literal notranslate"><span class="pre">TaskType.SQL</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.SUB_PROCESS"><code class="docutils literal notranslate"><span class="pre">TaskType.SUB_PROCESS</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.TaskType.SWITCH"><code class="docutils literal notranslate"><span class="pre">TaskType.SWITCH</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.constants.Time"><code class="docutils literal notranslate"><span class="pre">Time</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.Time.FMT_DASH_DATE"><code class="docutils literal notranslate"><span class="pre">Time.FMT_DASH_DATE</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.Time.FMT_NO_COLON_TIME"><code class="docutils literal notranslate"><span class="pre">Time.FMT_NO_COLON_TIME</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.Time.FMT_SHORT_DATE"><code class="docutils literal notranslate"><span class="pre">Time.FMT_SHORT_DATE</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.Time.FMT_STD_DATE"><code class="docutils literal notranslate"><span class="pre">Time.FMT_STD_DATE</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.Time.FMT_STD_TIME"><code class="docutils literal notranslate"><span class="pre">Time.FMT_STD_TIME</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.Time.LEN_SHORT_DATE"><code class="docutils literal notranslate"><span class="pre">Time.LEN_SHORT_DATE</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#pydolphinscheduler.constants.Time.LEN_STD_DATE"><code class="docutils literal notranslate"><span class="pre">Time.LEN_STD_DATE</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#module-pydolphinscheduler.exceptions">Exceptions</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.exceptions.PyDSBaseException"><code class="docutils literal notranslate"><span class="pre">PyDSBaseException</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.exceptions.PyDSJavaGatewayException"><code class="docutils literal notranslate"><span class="pre">PyDSJavaGatewayException</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.exceptions.PyDSParamException"><code class="docutils literal notranslate"><span class="pre">PyDSParamException</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.exceptions.PyDSProcessDefinitionNotAssignException"><code class="docutils literal notranslate"><span class="pre">PyDSProcessDefinitionNotAssignException</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#pydolphinscheduler.exceptions.PyDSTaskNoFoundException"><code class="docutils literal notranslate"><span class="pre">PyDSTaskNoFoundException</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">apache-dolphinscheduler</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item active">API</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/api.rst.txt" rel="nofollow"> View page source</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="api"> |
| <h1>API<a class="headerlink" href="#api" title="Link to this heading"></a></h1> |
| <section id="module-pydolphinscheduler.core"> |
| <span id="core"></span><h2>Core<a class="headerlink" href="#module-pydolphinscheduler.core" title="Link to this heading"></a></h2> |
| <p>Init pydolphinscheduler.core package.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.core.</span></span><span class="sig-name descname"><span class="pre">Database</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">database_key</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/core/database.html#Database"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.Database" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p> |
| <p>database object, get information about database.</p> |
| <p>You provider database_name contain connection information, it decisions which |
| database type and database instance would run task.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.clear"> |
| <span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None.</span>  <span class="pre">Remove</span> <span class="pre">all</span> <span class="pre">items</span> <span class="pre">from</span> <span class="pre">D.</span></span></span><a class="headerlink" href="#pydolphinscheduler.core.Database.clear" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.copy"> |
| <span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">a</span> <span class="pre">shallow</span> <span class="pre">copy</span> <span class="pre">of</span> <span class="pre">D</span></span></span><a class="headerlink" href="#pydolphinscheduler.core.Database.copy" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.fromkeys"> |
| <span class="sig-name descname"><span class="pre">fromkeys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pydolphinscheduler.core.Database.fromkeys" title="Link to this definition"></a></dt> |
| <dd><p>Create a new dictionary with keys from iterable and values set to value.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.get"> |
| <span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pydolphinscheduler.core.Database.get" title="Link to this definition"></a></dt> |
| <dd><p>Return the value for key if key is in the dictionary, else default.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.get_database_info"> |
| <span class="sig-name descname"><span class="pre">get_database_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/database.html#Database.get_database_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.Database.get_database_info" title="Link to this definition"></a></dt> |
| <dd><p>Get database info from java gateway, contains database id, type, name.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.items"> |
| <span class="sig-name descname"><span class="pre">items</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">a</span> <span class="pre">set-like</span> <span class="pre">object</span> <span class="pre">providing</span> <span class="pre">a</span> <span class="pre">view</span> <span class="pre">on</span> <span class="pre">D's</span> <span class="pre">items</span></span></span><a class="headerlink" href="#pydolphinscheduler.core.Database.items" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.keys"> |
| <span class="sig-name descname"><span class="pre">keys</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">a</span> <span class="pre">set-like</span> <span class="pre">object</span> <span class="pre">providing</span> <span class="pre">a</span> <span class="pre">view</span> <span class="pre">on</span> <span class="pre">D's</span> <span class="pre">keys</span></span></span><a class="headerlink" href="#pydolphinscheduler.core.Database.keys" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.pop"> |
| <span class="sig-name descname"><span class="pre">pop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">k</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">d</span></span></em><span class="optional">]</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">v,</span> <span class="pre">remove</span> <span class="pre">specified</span> <span class="pre">key</span> <span class="pre">and</span> <span class="pre">return</span> <span class="pre">the</span> <span class="pre">corresponding</span> <span class="pre">value.</span></span></span><a class="headerlink" href="#pydolphinscheduler.core.Database.pop" title="Link to this definition"></a></dt> |
| <dd><p>If the key is not found, return the default if given; otherwise, |
| raise a KeyError.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.popitem"> |
| <span class="sig-name descname"><span class="pre">popitem</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pydolphinscheduler.core.Database.popitem" title="Link to this definition"></a></dt> |
| <dd><p>Remove and return a (key, value) pair as a 2-tuple.</p> |
| <p>Pairs are returned in LIFO (last-in, first-out) order. |
| Raises KeyError if the dict is empty.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.setdefault"> |
| <span class="sig-name descname"><span class="pre">setdefault</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pydolphinscheduler.core.Database.setdefault" title="Link to this definition"></a></dt> |
| <dd><p>Insert key with a value of default if key is not in the dictionary.</p> |
| <p>Return the value for key if key is in the dictionary, else default.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.update"> |
| <span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">E</span></span></em>, <span class="optional">]</span><em class="sig-param"><span class="n"><span class="pre">**F</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None.</span>  <span class="pre">Update</span> <span class="pre">D</span> <span class="pre">from</span> <span class="pre">dict/iterable</span> <span class="pre">E</span> <span class="pre">and</span> <span class="pre">F.</span></span></span><a class="headerlink" href="#pydolphinscheduler.core.Database.update" title="Link to this definition"></a></dt> |
| <dd><p>If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] |
| If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v |
| In either case, this is followed by: for k in F: D[k] = F[k]</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.values"> |
| <span class="sig-name descname"><span class="pre">values</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">an</span> <span class="pre">object</span> <span class="pre">providing</span> <span class="pre">a</span> <span class="pre">view</span> <span class="pre">on</span> <span class="pre">D's</span> <span class="pre">values</span></span></span><a class="headerlink" href="#pydolphinscheduler.core.Database.values" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.database_id"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">database_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#pydolphinscheduler.core.Database.database_id" title="Link to this definition"></a></dt> |
| <dd><p>Get database id from java gateway, a wrapper for <a class="reference internal" href="#pydolphinscheduler.core.Database.get_database_info" title="pydolphinscheduler.core.Database.get_database_info"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_database_info()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Database.database_type"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">database_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#pydolphinscheduler.core.Database.database_type" title="Link to this definition"></a></dt> |
| <dd><p>Get database type from java gateway, a wrapper for <a class="reference internal" href="#pydolphinscheduler.core.Database.get_database_info" title="pydolphinscheduler.core.Database.get_database_info"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_database_info()</span></code></a>.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.core.</span></span><span class="sig-name descname"><span class="pre">ProcessDefinition</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schedule</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timezone</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'Asia/Shanghai'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'userPythonGateway'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'project-pydolphin'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tenant</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'tenant_pydolphin'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">queue</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'queuePythonGateway'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">worker_group</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'default'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release_state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'ONLINE'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">param</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Base</span></code></p> |
| <p>process definition object, will define process definition attribute, task, relation.</p> |
| <p>TODO: maybe we should rename this class, currently use DS object name.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition._ensure_side_model_exists"> |
| <span class="sig-name descname"><span class="pre">_ensure_side_model_exists</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition._ensure_side_model_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition._ensure_side_model_exists" title="Link to this definition"></a></dt> |
| <dd><p>Ensure process definition side model exists.</p> |
| <p>For now, side object including <a class="reference internal" href="#pydolphinscheduler.side.Project" title="pydolphinscheduler.side.project.Project"><code class="xref py py-class docutils literal notranslate"><span class="pre">pydolphinscheduler.side.project.Project</span></code></a>, |
| <a class="reference internal" href="#pydolphinscheduler.side.Tenant" title="pydolphinscheduler.side.tenant.Tenant"><code class="xref py py-class docutils literal notranslate"><span class="pre">pydolphinscheduler.side.tenant.Tenant</span></code></a>, <a class="reference internal" href="#pydolphinscheduler.side.User" title="pydolphinscheduler.side.user.User"><code class="xref py py-class docutils literal notranslate"><span class="pre">pydolphinscheduler.side.user.User</span></code></a>. |
| If these model not exists, would create default value in |
| <a class="reference internal" href="#pydolphinscheduler.constants.ProcessDefinitionDefault" title="pydolphinscheduler.constants.ProcessDefinitionDefault"><code class="xref py py-class docutils literal notranslate"><span class="pre">pydolphinscheduler.constants.ProcessDefinitionDefault</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition._handle_root_relation"> |
| <span class="sig-name descname"><span class="pre">_handle_root_relation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition._handle_root_relation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition._handle_root_relation" title="Link to this definition"></a></dt> |
| <dd><p>Handle root task property <code class="xref py py-class docutils literal notranslate"><span class="pre">pydolphinscheduler.core.task.TaskRelation</span></code>.</p> |
| <p>Root task in DAG do not have dominant upstream node, but we have to add an exactly default |
| upstream task with task_code equal to <cite>0</cite>. This is requests from java gateway interface.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition._parse_datetime"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_parse_datetime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">val</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition._parse_datetime"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition._parse_datetime" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition._pre_submit_check"> |
| <span class="sig-name descname"><span class="pre">_pre_submit_check</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition._pre_submit_check"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition._pre_submit_check" title="Link to this definition"></a></dt> |
| <dd><p>Check specific condition satisfy before.</p> |
| <p>This method should be called before process definition submit to java gateway |
| For now, we have below checker: |
| * <cite>self.param</cite> should be set if task <cite>switch</cite> in this workflow.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.add_task"> |
| <span class="sig-name descname"><span class="pre">add_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.Task"><span class="pre">Task</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition.add_task"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.add_task" title="Link to this definition"></a></dt> |
| <dd><p>Add a single task to process definition.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.add_tasks"> |
| <span class="sig-name descname"><span class="pre">add_tasks</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition.add_tasks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.add_tasks" title="Link to this definition"></a></dt> |
| <dd><p>Add task sequence to process definition, it a wrapper of <a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.add_task" title="pydolphinscheduler.core.ProcessDefinition.add_task"><code class="xref py py-func docutils literal notranslate"><span class="pre">add_task()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.get_one_task_by_name"> |
| <span class="sig-name descname"><span class="pre">get_one_task_by_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.Task"><span class="pre">Task</span></a></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition.get_one_task_by_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.get_one_task_by_name" title="Link to this definition"></a></dt> |
| <dd><p>Get exact one task from process definition by given name.</p> |
| <p>Function always return one task even though this process definition have more than one task with |
| this name.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.get_task"> |
| <span class="sig-name descname"><span class="pre">get_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.Task"><span class="pre">Task</span></a></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition.get_task"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.get_task" title="Link to this definition"></a></dt> |
| <dd><p>Get task object from process definition by given code.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.get_tasks_by_name"> |
| <span class="sig-name descname"><span class="pre">get_tasks_by_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition.get_tasks_by_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.get_tasks_by_name" title="Link to this definition"></a></dt> |
| <dd><p>Get tasks object by given name, if will return all tasks with this name.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.run"> |
| <span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition.run"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.run" title="Link to this definition"></a></dt> |
| <dd><p>Submit and Start ProcessDefinition instance.</p> |
| <p>Shortcut for function <a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.submit" title="pydolphinscheduler.core.ProcessDefinition.submit"><code class="xref py py-func docutils literal notranslate"><span class="pre">submit()</span></code></a> and function <a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition.start" title="pydolphinscheduler.core.ProcessDefinition.start"><code class="xref py py-func docutils literal notranslate"><span class="pre">start()</span></code></a>. Only support manual start workflow |
| for now, and schedule run will coming soon. |
| :return:</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.start"> |
| <span class="sig-name descname"><span class="pre">start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition.start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.start" title="Link to this definition"></a></dt> |
| <dd><p>Create and start ProcessDefinition instance.</p> |
| <p>which post to <cite>start-process-instance</cite> to java gateway</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.submit"> |
| <span class="sig-name descname"><span class="pre">submit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/process_definition.html#ProcessDefinition.submit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.submit" title="Link to this definition"></a></dt> |
| <dd><p>Submit ProcessDefinition instance to java gateway.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'_project',</span> <span class="pre">'_tenant',</span> <span class="pre">'description',</span> <span class="pre">'name',</span> <span class="pre">'param',</span> <span class="pre">'release_state',</span> <span class="pre">'task_definition_json',</span> <span class="pre">'task_relation_json',</span> <span class="pre">'tasks',</span> <span class="pre">'timeout',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'name',</span> <span class="pre">'param',</span> <span class="pre">'project',</span> <span class="pre">'release_state',</span> <span class="pre">'tenant'}</span></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.end_time"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">end_time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Any</span></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.end_time" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute end_time.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.param_json"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">param_json</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.param_json" title="Link to this definition"></a></dt> |
| <dd><p>Return param json base on self.param.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.project"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">project</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.side.Project" title="pydolphinscheduler.side.project.Project"><span class="pre">Project</span></a></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.project" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute project.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.schedule_json"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schedule_json</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.schedule_json" title="Link to this definition"></a></dt> |
| <dd><p>Get schedule parameter json object. This is requests from java gateway interface.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.start_time"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">start_time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Any</span></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.start_time" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute start_time.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.task_definition_json"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_definition_json</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.task_definition_json" title="Link to this definition"></a></dt> |
| <dd><p>Return all tasks definition in list of dict.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.task_list"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.task_list" title="Link to this definition"></a></dt> |
| <dd><p>Return list of tasks objects.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.task_location"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_location</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.task_location" title="Link to this definition"></a></dt> |
| <dd><p>Return all tasks location for all process definition.</p> |
| <p>For now, we only set all location with same x and y valued equal to 0. Because we do not |
| find a good way to set task locations. This is requests from java gateway interface.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.task_relation_json"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_relation_json</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.task_relation_json" title="Link to this definition"></a></dt> |
| <dd><p>Return all relation between tasks pair in list of dict.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.tenant"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tenant</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.side.Tenant" title="pydolphinscheduler.side.tenant.Tenant"><span class="pre">Tenant</span></a></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.tenant" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute tenant.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.ProcessDefinition.user"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.side.User" title="pydolphinscheduler.side.user.User"><span class="pre">User</span></a></em><a class="headerlink" href="#pydolphinscheduler.core.ProcessDefinition.user" title="Link to this definition"></a></dt> |
| <dd><p>Get user object.</p> |
| <p>For now we just get from python side but not from java gateway side, so it may not correct.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.core.</span></span><span class="sig-name descname"><span class="pre">Task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'YES'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_priority</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'MEDIUM'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">worker_group</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'default'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delay_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fail_retry_times</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fail_retry_interval</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout_flag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'CLOSE'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout_notify_strategy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">process_definition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_list</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dependence</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait_start_timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">condition_result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/core/task.html#Task"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.Task" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Base</span></code></p> |
| <p>Task object, parent class for all exactly task type.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/task.html#Task._set_deps"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.Task._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.core.Task.set_upstream" title="pydolphinscheduler.core.Task.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.core.Task.set_downstream" title="pydolphinscheduler.core.Task.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/task.html#Task.gen_code_and_version"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.Task.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.core.Task.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.core.Task.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/task.html#Task.set_downstream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.Task.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/core/task.html#Task.set_upstream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.core.Task.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.core.Task.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.core.Task._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.core.Task._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.core.Task._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.core.Task._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.core.Task.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.core.Task.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.core.Task.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.core.Task.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Get task parameter object.</p> |
| <p>Will get result to combine _task_custom_attr and custom_attr.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="module-pydolphinscheduler.side"> |
| <span id="sides"></span><h2>Sides<a class="headerlink" href="#module-pydolphinscheduler.side" title="Link to this heading"></a></h2> |
| <p>Init Side package, Side package keep object related to DolphinScheduler but not in the Core part.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Project"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.side.</span></span><span class="sig-name descname"><span class="pre">Project</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'project-pydolphin'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/side/project.html#Project"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.side.Project" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseSide</span></code></p> |
| <p>DolphinScheduler Project object.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Project.create_if_not_exists"> |
| <span class="sig-name descname"><span class="pre">create_if_not_exists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'userPythonGateway'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/side/project.html#Project.create_if_not_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.side.Project.create_if_not_exists" title="Link to this definition"></a></dt> |
| <dd><p>Create Project if not exists.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Project.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.side.Project.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Project.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.side.Project.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Project._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.side.Project._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Project._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.side.Project._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Project._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.side.Project._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Queue"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.side.</span></span><span class="sig-name descname"><span class="pre">Queue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'queuePythonGateway'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/side/queue.html#Queue"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.side.Queue" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseSide</span></code></p> |
| <p>DolphinScheduler Queue object.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Queue.create_if_not_exists"> |
| <span class="sig-name descname"><span class="pre">create_if_not_exists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'userPythonGateway'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/side/queue.html#Queue.create_if_not_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.side.Queue.create_if_not_exists" title="Link to this definition"></a></dt> |
| <dd><p>Create Queue if not exists.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Queue.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.side.Queue.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Queue.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.side.Queue.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Queue._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.side.Queue._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Queue._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.side.Queue._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Queue._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.side.Queue._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Tenant"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.side.</span></span><span class="sig-name descname"><span class="pre">Tenant</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'tenant_pydolphin'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">queue</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'queuePythonGateway'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/side/tenant.html#Tenant"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.side.Tenant" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseSide</span></code></p> |
| <p>DolphinScheduler Tenant object.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Tenant.create_if_not_exists"> |
| <span class="sig-name descname"><span class="pre">create_if_not_exists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">queue_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'userPythonGateway'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/side/tenant.html#Tenant.create_if_not_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.side.Tenant.create_if_not_exists" title="Link to this definition"></a></dt> |
| <dd><p>Create Tenant if not exists.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Tenant.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.side.Tenant.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Tenant.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.side.Tenant.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Tenant._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.side.Tenant._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Tenant._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.side.Tenant._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.Tenant._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.side.Tenant._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.User"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.side.</span></span><span class="sig-name descname"><span class="pre">User</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">phone</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tenant</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">queue</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/side/user.html#User"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.side.User" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseSide</span></code></p> |
| <p>DolphinScheduler User object.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.User.create_if_not_exists"> |
| <span class="sig-name descname"><span class="pre">create_if_not_exists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/side/user.html#User.create_if_not_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.side.User.create_if_not_exists" title="Link to this definition"></a></dt> |
| <dd><p>Create User if not exists.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.User.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.side.User.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.User.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.side.User.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.User._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.side.User._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.User._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.side.User._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.User._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'email',</span> <span class="pre">'name',</span> <span class="pre">'password',</span> <span class="pre">'phone',</span> <span class="pre">'queue',</span> <span class="pre">'status',</span> <span class="pre">'tenant'}</span></em><a class="headerlink" href="#pydolphinscheduler.side.User._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.WorkerGroup"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.side.</span></span><span class="sig-name descname"><span class="pre">WorkerGroup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/side/worker_group.html#WorkerGroup"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.side.WorkerGroup" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseSide</span></code></p> |
| <p>DolphinScheduler Worker Group object.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.WorkerGroup.create_if_not_exists"> |
| <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_if_not_exists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'userPythonGateway'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pydolphinscheduler.side.WorkerGroup.create_if_not_exists" title="Link to this definition"></a></dt> |
| <dd><p>Create Base if not exists.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.WorkerGroup.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.side.WorkerGroup.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.WorkerGroup.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.side.WorkerGroup.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.WorkerGroup._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.side.WorkerGroup._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.WorkerGroup._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.side.WorkerGroup._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.side.WorkerGroup._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.side.WorkerGroup._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="module-pydolphinscheduler.tasks"> |
| <span id="tasks"></span><h2>Tasks<a class="headerlink" href="#module-pydolphinscheduler.tasks" title="Link to this heading"></a></h2> |
| <p>Init pydolphinscheduler.tasks package.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">Condition</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">condition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="tasks/condition.html#pydolphinscheduler.tasks.condition.ConditionOperator" title="pydolphinscheduler.tasks.condition.ConditionOperator"><span class="pre">ConditionOperator</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">success_task</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">failed_task</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/condition.html#Condition"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.Condition" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a></p> |
| <p>Task condition object, declare behavior for condition task to dolphinscheduler.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition._set_dep"> |
| <span class="sig-name descname"><span class="pre">_set_dep</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/condition.html#Condition._set_dep"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.Condition._set_dep" title="Link to this definition"></a></dt> |
| <dd><p>Set upstream according to parameter <cite>condition</cite>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Condition._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.Condition.set_upstream" title="pydolphinscheduler.tasks.Condition.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.Condition.set_downstream" title="pydolphinscheduler.tasks.Condition.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Condition.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Condition.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Condition.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Condition.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Condition.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Condition.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Condition._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Condition._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Condition._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Condition._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Condition._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Condition._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Condition._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Condition.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get condition result define for java gateway.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Condition.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Condition.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Condition.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Override Task.task_params for Condition task.</p> |
| <p>Condition task have some specials attribute <cite>dependence</cite>, and in most of the task |
| this attribute is None and use empty dict <cite>{}</cite> as default value. We do not use class |
| attribute <cite>_task_custom_attr</cite> due to avoid attribute cover.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">DataX</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datasource_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datatarget_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sql</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_table</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">job_speed_byte</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">job_speed_record</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pre_statements</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">post_statements</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xms</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xmx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/datax.html#DataX"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.DataX" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a></p> |
| <p>Task DataX object, declare behavior for DataX task to dolphinscheduler.</p> |
| <p>It should run database datax job in multiply sql link engine, such as: |
| - MySQL |
| - Oracle |
| - Postgresql |
| - SQLServer |
| You provider datasource_name and datatarget_name contain connection information, it decisions which |
| database type and database instance would synchronous data.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.DataX._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.DataX.set_upstream" title="pydolphinscheduler.tasks.DataX.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.DataX.set_downstream" title="pydolphinscheduler.tasks.DataX.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.DataX.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.DataX.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.DataX.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.DataX.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.DataX.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX.CUSTOM_CONFIG"> |
| <span class="sig-name descname"><span class="pre">CUSTOM_CONFIG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.DataX.CUSTOM_CONFIG" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.DataX.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.DataX._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.DataX._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.DataX._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.DataX._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'custom_config',</span> <span class="pre">'job_speed_byte',</span> <span class="pre">'job_speed_record',</span> <span class="pre">'post_statements',</span> <span class="pre">'pre_statements',</span> <span class="pre">'sql',</span> <span class="pre">'target_table',</span> <span class="pre">'xms',</span> <span class="pre">'xmx'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.DataX._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.DataX._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.DataX._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.DataX.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.DataX.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.DataX.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.DataX.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Override Task.task_params for datax task.</p> |
| <p>datax task have some specials attribute for task_params, and is odd if we |
| directly set as python property, so we Override Task.task_params here.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">Dependent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dependence</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="tasks/dependent.html#pydolphinscheduler.tasks.dependent.DependentOperator" title="pydolphinscheduler.tasks.dependent.DependentOperator"><span class="pre">DependentOperator</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/dependent.html#Dependent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a></p> |
| <p>Task dependent object, declare behavior for dependent task to dolphinscheduler.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.Dependent.set_upstream" title="pydolphinscheduler.tasks.Dependent.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.Dependent.set_downstream" title="pydolphinscheduler.tasks.Dependent.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Dependent.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Dependent.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Override Task.task_params for dependent task.</p> |
| <p>Dependent task have some specials attribute <cite>dependence</cite>, and in most of the task |
| this attribute is None and use empty dict <cite>{}</cite> as default value. We do not use class |
| attribute <cite>_task_custom_attr</cite> due to avoid attribute cover.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">Flink</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_class</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">program_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ProgramType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'SCALA'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deploy_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="tasks/flink.html#pydolphinscheduler.tasks.flink.DeployMode" title="pydolphinscheduler.tasks.flink.DeployMode"><span class="pre">DeployMode</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'cluster'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flink_version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="tasks/flink.html#pydolphinscheduler.tasks.flink.FlinkVersion" title="pydolphinscheduler.tasks.flink.FlinkVersion"><span class="pre">FlinkVersion</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'<1.10'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">app_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">job_manager_memory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'1G'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_manager_memory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'2G'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slot</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_manager</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parallelism</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">others</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/flink.html#Flink"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.Flink" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Engine</span></code></p> |
| <p>Task flink object, declare behavior for flink task to dolphinscheduler.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Flink._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.Flink.set_upstream" title="pydolphinscheduler.tasks.Flink.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.Flink.set_downstream" title="pydolphinscheduler.tasks.Flink.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Flink.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Flink.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Flink.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink.get_jar_id"> |
| <span class="sig-name descname"><span class="pre">get_jar_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Flink.get_jar_id" title="Link to this definition"></a></dt> |
| <dd><p>Get jar id from java gateway, a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.Flink.get_resource_info" title="pydolphinscheduler.tasks.Flink.get_resource_info"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_resource_info()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink.get_resource_info"> |
| <span class="sig-name descname"><span class="pre">get_resource_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">program_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_package</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pydolphinscheduler.tasks.Flink.get_resource_info" title="Link to this definition"></a></dt> |
| <dd><p>Get resource info from java gateway, contains resource id, name.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Flink.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Flink.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Flink.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Flink._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Flink._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Flink._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Flink._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'app_name',</span> <span class="pre">'deploy_mode',</span> <span class="pre">'flink_version',</span> <span class="pre">'job_manager_memory',</span> <span class="pre">'main_args',</span> <span class="pre">'others',</span> <span class="pre">'parallelism',</span> <span class="pre">'slot',</span> <span class="pre">'task_manager',</span> <span class="pre">'task_manager_memory'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Flink._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Flink._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Flink._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Flink.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Flink.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Flink.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Flink.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Override Task.task_params for engine children task.</p> |
| <p>children task have some specials attribute for task_params, and is odd if we |
| directly set as python property, so we Override Task.task_params here.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">Http</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_method</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'GET'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_check_condition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'STATUS_CODE_DEFAULT'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">condition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connect_timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">60000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">socket_timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">60000</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/http.html#Http"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.Http" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a></p> |
| <p>Task HTTP object, declare behavior for HTTP task to dolphinscheduler.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Http._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.Http.set_upstream" title="pydolphinscheduler.tasks.Http.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.Http.set_downstream" title="pydolphinscheduler.tasks.Http.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Http.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Http.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Http.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Http.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Http.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Http.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Http._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Http._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Http._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Http._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'condition',</span> <span class="pre">'connect_timeout',</span> <span class="pre">'http_check_condition',</span> <span class="pre">'http_method',</span> <span class="pre">'http_params',</span> <span class="pre">'socket_timeout',</span> <span class="pre">'url'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Http._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Http._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Http._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Http.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Http.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Http.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Http.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Get task parameter object.</p> |
| <p>Will get result to combine _task_custom_attr and custom_attr.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">MR</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_class</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">program_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ProgramType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'SCALA'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">app_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">others</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/map_reduce.html#MR"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.MR" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Engine</span></code></p> |
| <p>Task mr object, declare behavior for mr task to dolphinscheduler.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.MR._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.MR.set_upstream" title="pydolphinscheduler.tasks.MR.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.MR.set_downstream" title="pydolphinscheduler.tasks.MR.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.MR.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.MR.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.MR.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR.get_jar_id"> |
| <span class="sig-name descname"><span class="pre">get_jar_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.MR.get_jar_id" title="Link to this definition"></a></dt> |
| <dd><p>Get jar id from java gateway, a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.MR.get_resource_info" title="pydolphinscheduler.tasks.MR.get_resource_info"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_resource_info()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR.get_resource_info"> |
| <span class="sig-name descname"><span class="pre">get_resource_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">program_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_package</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pydolphinscheduler.tasks.MR.get_resource_info" title="Link to this definition"></a></dt> |
| <dd><p>Get resource info from java gateway, contains resource id, name.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.MR.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.MR.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.MR.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.MR._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.MR._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.MR._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.MR._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'app_name',</span> <span class="pre">'main_args',</span> <span class="pre">'others'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.MR._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.MR._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.MR._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.MR.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.MR.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.MR.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.MR.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Override Task.task_params for engine children task.</p> |
| <p>children task have some specials attribute for task_params, and is odd if we |
| directly set as python property, so we Override Task.task_params here.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">Procedure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datasource_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/procedure.html#Procedure"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a></p> |
| <p>Task Procedure object, declare behavior for Procedure task to dolphinscheduler.</p> |
| <p>It should run database procedure job in multiply sql lik engine, such as: |
| - ClickHouse |
| - DB2 |
| - HIVE |
| - MySQL |
| - Oracle |
| - Postgresql |
| - Presto |
| - SQLServer |
| You provider datasource_name contain connection information, it decisions which |
| database type and database instance would run this sql.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.Procedure.set_upstream" title="pydolphinscheduler.tasks.Procedure.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.Procedure.set_downstream" title="pydolphinscheduler.tasks.Procedure.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'method'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Procedure.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Procedure.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Override Task.task_params for produce task.</p> |
| <p>produce task have some specials attribute for task_params, and is odd if we |
| directly set as python property, so we Override Task.task_params here.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">Python</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/python.html#Python"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.Python" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a></p> |
| <p>Task Python object, declare behavior for Python task to dolphinscheduler.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Python._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.Python.set_upstream" title="pydolphinscheduler.tasks.Python.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.Python.set_downstream" title="pydolphinscheduler.tasks.Python.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Python.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Python.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Python.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Python.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Python.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Python.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Python._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Python._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Python._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Python._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'raw_script'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Python._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Python._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Python._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Python.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Python.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python.raw_script"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">raw_script</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Python.raw_script" title="Link to this definition"></a></dt> |
| <dd><p>Get python task define attribute <cite>raw_script</cite>.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Python.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Python.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Get task parameter object.</p> |
| <p>Will get result to combine _task_custom_attr and custom_attr.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">Shell</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">command</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/shell.html#Shell"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.Shell" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a></p> |
| <p>Task shell object, declare behavior for shell task to dolphinscheduler.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> – A unique, meaningful string for the shell task.</p></li> |
| <li><p><strong>command</strong> – <p>One or more command want to run in this task.</p> |
| <p>It could be simply command:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Shell</span><span class="p">(</span><span class="n">name</span><span class="o">=...</span><span class="p">,</span> <span class="n">command</span><span class="o">=</span><span class="s2">"echo task shell"</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>or maybe same commands trying to do complex task:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">command</span> <span class="o">=</span> <span class="s1">'''echo task shell step 1;</span> |
| <span class="s1">echo task shell step 2;</span> |
| <span class="s1">echo task shell step 3</span> |
| <span class="s1">'''</span> |
| |
| <span class="n">Shell</span><span class="p">(</span><span class="n">name</span><span class="o">=...</span><span class="p">,</span> <span class="n">command</span><span class="o">=</span><span class="n">command</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| </p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Shell._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.Shell.set_upstream" title="pydolphinscheduler.tasks.Shell.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.Shell.set_downstream" title="pydolphinscheduler.tasks.Shell.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Shell.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Shell.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Shell.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Shell.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Shell.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Shell.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Shell._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Shell._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Shell._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Shell._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'raw_script'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Shell._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Shell._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Shell._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Shell.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Shell.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Shell.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Shell.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Get task parameter object.</p> |
| <p>Will get result to combine _task_custom_attr and custom_attr.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">Spark</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_class</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">program_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ProgramType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'SCALA'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deploy_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="tasks/spark.html#pydolphinscheduler.tasks.spark.DeployMode" title="pydolphinscheduler.tasks.spark.DeployMode"><span class="pre">DeployMode</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'cluster'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spark_version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="tasks/spark.html#pydolphinscheduler.tasks.spark.SparkVersion" title="pydolphinscheduler.tasks.spark.SparkVersion"><span class="pre">SparkVersion</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'SPARK2'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">app_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driver_cores</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driver_memory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'512M'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_executors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executor_memory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'2G'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executor_cores</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">others</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/spark.html#Spark"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.Spark" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Engine</span></code></p> |
| <p>Task spark object, declare behavior for spark task to dolphinscheduler.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Spark._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.Spark.set_upstream" title="pydolphinscheduler.tasks.Spark.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.Spark.set_downstream" title="pydolphinscheduler.tasks.Spark.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Spark.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Spark.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Spark.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark.get_jar_id"> |
| <span class="sig-name descname"><span class="pre">get_jar_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Spark.get_jar_id" title="Link to this definition"></a></dt> |
| <dd><p>Get jar id from java gateway, a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.Spark.get_resource_info" title="pydolphinscheduler.tasks.Spark.get_resource_info"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_resource_info()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark.get_resource_info"> |
| <span class="sig-name descname"><span class="pre">get_resource_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">program_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_package</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pydolphinscheduler.tasks.Spark.get_resource_info" title="Link to this definition"></a></dt> |
| <dd><p>Get resource info from java gateway, contains resource id, name.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Spark.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Spark.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Spark.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Spark._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Spark._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Spark._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Spark._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'app_name',</span> <span class="pre">'deploy_mode',</span> <span class="pre">'driver_cores',</span> <span class="pre">'driver_memory',</span> <span class="pre">'executor_cores',</span> <span class="pre">'executor_memory',</span> <span class="pre">'main_args',</span> <span class="pre">'num_executors',</span> <span class="pre">'others',</span> <span class="pre">'spark_version'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Spark._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Spark._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Spark._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Spark.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Spark.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Spark.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Spark.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Override Task.task_params for engine children task.</p> |
| <p>children task have some specials attribute for task_params, and is odd if we |
| directly set as python property, so we Override Task.task_params here.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">Sql</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datasource_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sql</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pre_statements</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">post_statements</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_rows</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/sql.html#Sql"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.Sql" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a></p> |
| <p>Task SQL object, declare behavior for SQL task to dolphinscheduler.</p> |
| <p>It should run sql job in multiply sql lik engine, such as: |
| - ClickHouse |
| - DB2 |
| - HIVE |
| - MySQL |
| - Oracle |
| - Postgresql |
| - Presto |
| - SQLServer |
| You provider datasource_name contain connection information, it decisions which |
| database type and database instance would run this sql.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Sql._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.Sql.set_upstream" title="pydolphinscheduler.tasks.Sql.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.Sql.set_downstream" title="pydolphinscheduler.tasks.Sql.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Sql.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Sql.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Sql.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Sql.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Sql.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Sql.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Sql._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Sql._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Sql._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Sql._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'display_rows',</span> <span class="pre">'post_statements',</span> <span class="pre">'pre_statements',</span> <span class="pre">'sql',</span> <span class="pre">'sql_type'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Sql._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Sql._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Sql._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Sql.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Sql.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql.sql_type"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sql_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Sql.sql_type" title="Link to this definition"></a></dt> |
| <dd><p>Judgement sql type, use regexp to check which type of the sql is.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Sql.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Sql.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Override Task.task_params for sql task.</p> |
| <p>sql task have some specials attribute for task_params, and is odd if we |
| directly set as python property, so we Override Task.task_params here.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">SubProcess</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">process_definition_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/sub_process.html#SubProcess"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a></p> |
| <p>Task SubProcess object, declare behavior for SubProcess task to dolphinscheduler.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.set_upstream" title="pydolphinscheduler.tasks.SubProcess.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.set_downstream" title="pydolphinscheduler.tasks.SubProcess.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess.get_process_definition_info"> |
| <span class="sig-name descname"><span class="pre">get_process_definition_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">process_definition_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/sub_process.html#SubProcess.get_process_definition_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess.get_process_definition_info" title="Link to this definition"></a></dt> |
| <dd><p>Get process definition info from java gateway, contains process definition id, name, code.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'process_definition_code'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess.process_definition_code"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition_code</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess.process_definition_code" title="Link to this definition"></a></dt> |
| <dd><p>Get process definition code, a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.SubProcess.get_process_definition_info" title="pydolphinscheduler.tasks.SubProcess.get_process_definition_info"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_process_definition_info()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.SubProcess.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.SubProcess.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Get task parameter object.</p> |
| <p>Will get result to combine _task_custom_attr and custom_attr.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.tasks.</span></span><span class="sig-name descname"><span class="pre">Switch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">condition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="tasks/switch.html#pydolphinscheduler.tasks.switch.SwitchCondition" title="pydolphinscheduler.tasks.switch.SwitchCondition"><span class="pre">SwitchCondition</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/switch.html#Switch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.Switch" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a></p> |
| <p>Task switch object, declare behavior for switch task to dolphinscheduler.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch._set_dep"> |
| <span class="sig-name descname"><span class="pre">_set_dep</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pydolphinscheduler/tasks/switch.html#Switch._set_dep"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.tasks.Switch._set_dep" title="Link to this definition"></a></dt> |
| <dd><p>Set downstream according to parameter <cite>condition</cite>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch._set_deps"> |
| <span class="sig-name descname"><span class="pre">_set_deps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upstream</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Switch._set_deps" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks dependent to current task.</p> |
| <p>it is a wrapper for <a class="reference internal" href="#pydolphinscheduler.tasks.Switch.set_upstream" title="pydolphinscheduler.tasks.Switch.set_upstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_upstream()</span></code></a> and <a class="reference internal" href="#pydolphinscheduler.tasks.Switch.set_downstream" title="pydolphinscheduler.tasks.Switch.set_downstream"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_downstream()</span></code></a>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch.gen_code_and_version"> |
| <span class="sig-name descname"><span class="pre">gen_code_and_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Switch.gen_code_and_version" title="Link to this definition"></a></dt> |
| <dd><p>Generate task code and version from java gateway.</p> |
| <p>If task name do not exists in process definition before, if will generate new code and version id |
| equal to 0 by java gateway, otherwise if will return the exists code and version.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch.get_define"> |
| <span class="sig-name descname"><span class="pre">get_define</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Switch.get_define" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute communicate to Java gateway server.</p> |
| <p>use attribute <cite>self._DEFINE_ATTR</cite> to determine which attributes should including when |
| object tries to communicate with Java gateway server.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch.get_define_custom"> |
| <span class="sig-name descname"><span class="pre">get_define_custom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">camel_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_attr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Switch.get_define_custom" title="Link to this definition"></a></dt> |
| <dd><p>Get object definition attribute by given attr set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch.set_downstream"> |
| <span class="sig-name descname"><span class="pre">set_downstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Switch.set_downstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as downstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch.set_upstream"> |
| <span class="sig-name descname"><span class="pre">set_upstream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pydolphinscheduler.core.Task" title="pydolphinscheduler.core.task.Task"><span class="pre">Task</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pydolphinscheduler.tasks.Switch.set_upstream" title="Link to this definition"></a></dt> |
| <dd><p>Set parameter tasks as upstream to current task.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch.DEFAULT_CONDITION_RESULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT_CONDITION_RESULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'failedNode':</span> <span class="pre">[''],</span> <span class="pre">'successNode':</span> <span class="pre">['']}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Switch.DEFAULT_CONDITION_RESULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch._DEFAULT_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFAULT_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Switch._DEFAULT_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch._DEFINE_ATTR"> |
| <span class="sig-name descname"><span class="pre">_DEFINE_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'code',</span> <span class="pre">'delay_time',</span> <span class="pre">'description',</span> <span class="pre">'fail_retry_interval',</span> <span class="pre">'fail_retry_times',</span> <span class="pre">'flag',</span> <span class="pre">'name',</span> <span class="pre">'task_params',</span> <span class="pre">'task_priority',</span> <span class="pre">'task_type',</span> <span class="pre">'timeout',</span> <span class="pre">'timeout_flag',</span> <span class="pre">'timeout_notify_strategy',</span> <span class="pre">'version',</span> <span class="pre">'worker_group'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Switch._DEFINE_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch._KEY_ATTR"> |
| <span class="sig-name descname"><span class="pre">_KEY_ATTR</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'description',</span> <span class="pre">'name'}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Switch._KEY_ATTR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch._downstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_downstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Switch._downstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch._task_custom_attr"> |
| <span class="sig-name descname"><span class="pre">_task_custom_attr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Switch._task_custom_attr" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch._task_relation"> |
| <span class="sig-name descname"><span class="pre">_task_relation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">TaskRelation</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Switch._task_relation" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch._upstream_task_codes"> |
| <span class="sig-name descname"><span class="pre">_upstream_task_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Set</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Switch._upstream_task_codes" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch.condition_result"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">condition_result</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Switch.condition_result" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute condition_result.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch.process_definition"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_definition</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><span class="pre">ProcessDefinition</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Switch.process_definition" title="Link to this definition"></a></dt> |
| <dd><p>Get attribute process_definition.</p> |
| </dd></dl> |
| |
| <dl class="py property"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.tasks.Switch.task_params"> |
| <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">task_params</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Dict</span></em><a class="headerlink" href="#pydolphinscheduler.tasks.Switch.task_params" title="Link to this definition"></a></dt> |
| <dd><p>Override Task.task_params for switch task.</p> |
| <p>switch task have some specials attribute <cite>switch</cite>, and in most of the task |
| this attribute is None and use empty dict <cite>{}</cite> as default value. We do not use class |
| attribute <cite>_task_custom_attr</cite> due to avoid attribute cover.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="module-pydolphinscheduler.constants"> |
| <span id="constants"></span><h2>Constants<a class="headerlink" href="#module-pydolphinscheduler.constants" title="Link to this heading"></a></h2> |
| <p>Constants for pydolphinscheduler.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.DefaultTaskCodeNum"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.constants.</span></span><span class="sig-name descname"><span class="pre">DefaultTaskCodeNum</span></span><a class="reference internal" href="_modules/pydolphinscheduler/constants.html#DefaultTaskCodeNum"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.constants.DefaultTaskCodeNum" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p> |
| <p>Constants and default value for default task code number.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.DefaultTaskCodeNum.DEFAULT"> |
| <span class="sig-name descname"><span class="pre">DEFAULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#pydolphinscheduler.constants.DefaultTaskCodeNum.DEFAULT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Delimiter"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.constants.</span></span><span class="sig-name descname"><span class="pre">Delimiter</span></span><a class="reference internal" href="_modules/pydolphinscheduler/constants.html#Delimiter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.constants.Delimiter" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p> |
| <p>Constants for delimiter.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Delimiter.BAR"> |
| <span class="sig-name descname"><span class="pre">BAR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'-'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.Delimiter.BAR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Delimiter.COLON"> |
| <span class="sig-name descname"><span class="pre">COLON</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">':'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.Delimiter.COLON" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Delimiter.DASH"> |
| <span class="sig-name descname"><span class="pre">DASH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.Delimiter.DASH" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Delimiter.DIRECTION"> |
| <span class="sig-name descname"><span class="pre">DIRECTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'->'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.Delimiter.DIRECTION" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Delimiter.UNDERSCORE"> |
| <span class="sig-name descname"><span class="pre">UNDERSCORE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'_'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.Delimiter.UNDERSCORE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.constants.</span></span><span class="sig-name descname"><span class="pre">JavaGatewayDefault</span></span><a class="reference internal" href="_modules/pydolphinscheduler/constants.html#JavaGatewayDefault"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p> |
| <p>Constants and default value for java gateway.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault.AUTO_CONVERT"> |
| <span class="sig-name descname"><span class="pre">AUTO_CONVERT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.AUTO_CONVERT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault.RESULT_DATA"> |
| <span class="sig-name descname"><span class="pre">RESULT_DATA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_DATA" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault.RESULT_MESSAGE_KEYWORD"> |
| <span class="sig-name descname"><span class="pre">RESULT_MESSAGE_KEYWORD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'msg'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_MESSAGE_KEYWORD" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault.RESULT_MESSAGE_SUCCESS"> |
| <span class="sig-name descname"><span class="pre">RESULT_MESSAGE_SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'success'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_MESSAGE_SUCCESS" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault.RESULT_STATUS_KEYWORD"> |
| <span class="sig-name descname"><span class="pre">RESULT_STATUS_KEYWORD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'status'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_STATUS_KEYWORD" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault.RESULT_STATUS_SUCCESS"> |
| <span class="sig-name descname"><span class="pre">RESULT_STATUS_SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SUCCESS'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.RESULT_STATUS_SUCCESS" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault.SERVER_ADDRESS"> |
| <span class="sig-name descname"><span class="pre">SERVER_ADDRESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'127.0.0.1'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.SERVER_ADDRESS" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.JavaGatewayDefault.SERVER_PORT"> |
| <span class="sig-name descname"><span class="pre">SERVER_PORT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">25333</span></em><a class="headerlink" href="#pydolphinscheduler.constants.JavaGatewayDefault.SERVER_PORT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionDefault"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.constants.</span></span><span class="sig-name descname"><span class="pre">ProcessDefinitionDefault</span></span><a class="reference internal" href="_modules/pydolphinscheduler/constants.html#ProcessDefinitionDefault"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionDefault" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> |
| <p>Constants default value for <a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><code class="xref py py-class docutils literal notranslate"><span class="pre">pydolphinscheduler.core.process_definition.ProcessDefinition</span></code></a>.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionDefault.PROJECT"> |
| <span class="sig-name descname"><span class="pre">PROJECT</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'project-pydolphin'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.PROJECT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionDefault.QUEUE"> |
| <span class="sig-name descname"><span class="pre">QUEUE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'queuePythonGateway'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.QUEUE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionDefault.TENANT"> |
| <span class="sig-name descname"><span class="pre">TENANT</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tenant_pydolphin'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.TENANT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionDefault.TIME_ZONE"> |
| <span class="sig-name descname"><span class="pre">TIME_ZONE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Asia/Shanghai'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.TIME_ZONE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionDefault.USER"> |
| <span class="sig-name descname"><span class="pre">USER</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'userPythonGateway'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.USER" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionDefault.USER_EMAIL"> |
| <span class="sig-name descname"><span class="pre">USER_EMAIL</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'userPythonGateway@dolphinscheduler.com'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.USER_EMAIL" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionDefault.USER_PHONE"> |
| <span class="sig-name descname"><span class="pre">USER_PHONE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'11111111111'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.USER_PHONE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionDefault.USER_PWD"> |
| <span class="sig-name descname"><span class="pre">USER_PWD</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'userPythonGateway'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.USER_PWD" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionDefault.USER_STATE"> |
| <span class="sig-name descname"><span class="pre">USER_STATE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.USER_STATE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionDefault.WORKER_GROUP"> |
| <span class="sig-name descname"><span class="pre">WORKER_GROUP</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'default'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionDefault.WORKER_GROUP" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionReleaseState"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.constants.</span></span><span class="sig-name descname"><span class="pre">ProcessDefinitionReleaseState</span></span><a class="reference internal" href="_modules/pydolphinscheduler/constants.html#ProcessDefinitionReleaseState"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionReleaseState" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> |
| <p>Constants for <a class="reference internal" href="#pydolphinscheduler.core.ProcessDefinition" title="pydolphinscheduler.core.process_definition.ProcessDefinition"><code class="xref py py-class docutils literal notranslate"><span class="pre">pydolphinscheduler.core.process_definition.ProcessDefinition</span></code></a> release state.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionReleaseState.OFFLINE"> |
| <span class="sig-name descname"><span class="pre">OFFLINE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'OFFLINE'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionReleaseState.OFFLINE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.ProcessDefinitionReleaseState.ONLINE"> |
| <span class="sig-name descname"><span class="pre">ONLINE</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ONLINE'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.ProcessDefinitionReleaseState.ONLINE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskFlag"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.constants.</span></span><span class="sig-name descname"><span class="pre">TaskFlag</span></span><a class="reference internal" href="_modules/pydolphinscheduler/constants.html#TaskFlag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.constants.TaskFlag" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p> |
| <p>Constants for task flag.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskFlag.NO"> |
| <span class="sig-name descname"><span class="pre">NO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NO'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskFlag.NO" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskFlag.YES"> |
| <span class="sig-name descname"><span class="pre">YES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'YES'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskFlag.YES" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskPriority"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.constants.</span></span><span class="sig-name descname"><span class="pre">TaskPriority</span></span><a class="reference internal" href="_modules/pydolphinscheduler/constants.html#TaskPriority"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.constants.TaskPriority" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p> |
| <p>Constants for task priority.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskPriority.HIGH"> |
| <span class="sig-name descname"><span class="pre">HIGH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'HIGH'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskPriority.HIGH" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskPriority.HIGHEST"> |
| <span class="sig-name descname"><span class="pre">HIGHEST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'HIGHEST'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskPriority.HIGHEST" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskPriority.LOW"> |
| <span class="sig-name descname"><span class="pre">LOW</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LOW'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskPriority.LOW" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskPriority.LOWEST"> |
| <span class="sig-name descname"><span class="pre">LOWEST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'LOWEST'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskPriority.LOWEST" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskPriority.MEDIUM"> |
| <span class="sig-name descname"><span class="pre">MEDIUM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MEDIUM'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskPriority.MEDIUM" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskTimeoutFlag"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.constants.</span></span><span class="sig-name descname"><span class="pre">TaskTimeoutFlag</span></span><a class="reference internal" href="_modules/pydolphinscheduler/constants.html#TaskTimeoutFlag"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.constants.TaskTimeoutFlag" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p> |
| <p>Constants for task timeout flag.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskTimeoutFlag.CLOSE"> |
| <span class="sig-name descname"><span class="pre">CLOSE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CLOSE'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskTimeoutFlag.CLOSE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.constants.</span></span><span class="sig-name descname"><span class="pre">TaskType</span></span><a class="reference internal" href="_modules/pydolphinscheduler/constants.html#TaskType"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.constants.TaskType" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p> |
| <p>Constants for task type, it will also show you which kind we support up to now.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.CONDITIONS"> |
| <span class="sig-name descname"><span class="pre">CONDITIONS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CONDITIONS'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.CONDITIONS" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.DATAX"> |
| <span class="sig-name descname"><span class="pre">DATAX</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DATAX'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.DATAX" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.DEPENDENT"> |
| <span class="sig-name descname"><span class="pre">DEPENDENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DEPENDENT'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.DEPENDENT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.FLINK"> |
| <span class="sig-name descname"><span class="pre">FLINK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FLINK'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.FLINK" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.HTTP"> |
| <span class="sig-name descname"><span class="pre">HTTP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'HTTP'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.HTTP" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.MR"> |
| <span class="sig-name descname"><span class="pre">MR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'MR'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.MR" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.PROCEDURE"> |
| <span class="sig-name descname"><span class="pre">PROCEDURE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PROCEDURE'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.PROCEDURE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.PYTHON"> |
| <span class="sig-name descname"><span class="pre">PYTHON</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PYTHON'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.PYTHON" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.SHELL"> |
| <span class="sig-name descname"><span class="pre">SHELL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SHELL'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.SHELL" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.SPARK"> |
| <span class="sig-name descname"><span class="pre">SPARK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SPARK'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.SPARK" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.SQL"> |
| <span class="sig-name descname"><span class="pre">SQL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SQL'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.SQL" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.SUB_PROCESS"> |
| <span class="sig-name descname"><span class="pre">SUB_PROCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SUB_PROCESS'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.SUB_PROCESS" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.TaskType.SWITCH"> |
| <span class="sig-name descname"><span class="pre">SWITCH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SWITCH'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.TaskType.SWITCH" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Time"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.constants.</span></span><span class="sig-name descname"><span class="pre">Time</span></span><a class="reference internal" href="_modules/pydolphinscheduler/constants.html#Time"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.constants.Time" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p> |
| <p>Constants for date.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Time.FMT_DASH_DATE"> |
| <span class="sig-name descname"><span class="pre">FMT_DASH_DATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%Y/%m/%d'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.Time.FMT_DASH_DATE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Time.FMT_NO_COLON_TIME"> |
| <span class="sig-name descname"><span class="pre">FMT_NO_COLON_TIME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%H%M%S'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.Time.FMT_NO_COLON_TIME" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Time.FMT_SHORT_DATE"> |
| <span class="sig-name descname"><span class="pre">FMT_SHORT_DATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%Y%m%d'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.Time.FMT_SHORT_DATE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Time.FMT_STD_DATE"> |
| <span class="sig-name descname"><span class="pre">FMT_STD_DATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%Y-%m-%d'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.Time.FMT_STD_DATE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Time.FMT_STD_TIME"> |
| <span class="sig-name descname"><span class="pre">FMT_STD_TIME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%H:%M:%S'</span></em><a class="headerlink" href="#pydolphinscheduler.constants.Time.FMT_STD_TIME" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Time.LEN_SHORT_DATE"> |
| <span class="sig-name descname"><span class="pre">LEN_SHORT_DATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">8</span></em><a class="headerlink" href="#pydolphinscheduler.constants.Time.LEN_SHORT_DATE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.constants.Time.LEN_STD_DATE"> |
| <span class="sig-name descname"><span class="pre">LEN_STD_DATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#pydolphinscheduler.constants.Time.LEN_STD_DATE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| <section id="module-pydolphinscheduler.exceptions"> |
| <span id="exceptions"></span><h2>Exceptions<a class="headerlink" href="#module-pydolphinscheduler.exceptions" title="Link to this heading"></a></h2> |
| <p>Exceptions for pydolphinscheduler.</p> |
| <dl class="py exception"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.exceptions.PyDSBaseException"> |
| <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.exceptions.</span></span><span class="sig-name descname"><span class="pre">PyDSBaseException</span></span><a class="reference internal" href="_modules/pydolphinscheduler/exceptions.html#PyDSBaseException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.exceptions.PyDSBaseException" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p> |
| <p>Base exception for pydolphinscheduler.</p> |
| </dd></dl> |
| |
| <dl class="py exception"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.exceptions.PyDSJavaGatewayException"> |
| <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.exceptions.</span></span><span class="sig-name descname"><span class="pre">PyDSJavaGatewayException</span></span><a class="reference internal" href="_modules/pydolphinscheduler/exceptions.html#PyDSJavaGatewayException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.exceptions.PyDSJavaGatewayException" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.exceptions.PyDSBaseException" title="pydolphinscheduler.exceptions.PyDSBaseException"><code class="xref py py-class docutils literal notranslate"><span class="pre">PyDSBaseException</span></code></a></p> |
| <p>Exception for pydolphinscheduler Java gateway error.</p> |
| </dd></dl> |
| |
| <dl class="py exception"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.exceptions.PyDSParamException"> |
| <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.exceptions.</span></span><span class="sig-name descname"><span class="pre">PyDSParamException</span></span><a class="reference internal" href="_modules/pydolphinscheduler/exceptions.html#PyDSParamException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.exceptions.PyDSParamException" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.exceptions.PyDSBaseException" title="pydolphinscheduler.exceptions.PyDSBaseException"><code class="xref py py-class docutils literal notranslate"><span class="pre">PyDSBaseException</span></code></a></p> |
| <p>Exception for pydolphinscheduler parameter verify error.</p> |
| </dd></dl> |
| |
| <dl class="py exception"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.exceptions.PyDSProcessDefinitionNotAssignException"> |
| <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.exceptions.</span></span><span class="sig-name descname"><span class="pre">PyDSProcessDefinitionNotAssignException</span></span><a class="reference internal" href="_modules/pydolphinscheduler/exceptions.html#PyDSProcessDefinitionNotAssignException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.exceptions.PyDSProcessDefinitionNotAssignException" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.exceptions.PyDSBaseException" title="pydolphinscheduler.exceptions.PyDSBaseException"><code class="xref py py-class docutils literal notranslate"><span class="pre">PyDSBaseException</span></code></a></p> |
| <p>Exception for pydolphinscheduler process definition not assign error.</p> |
| </dd></dl> |
| |
| <dl class="py exception"> |
| <dt class="sig sig-object py" id="pydolphinscheduler.exceptions.PyDSTaskNoFoundException"> |
| <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pydolphinscheduler.exceptions.</span></span><span class="sig-name descname"><span class="pre">PyDSTaskNoFoundException</span></span><a class="reference internal" href="_modules/pydolphinscheduler/exceptions.html#PyDSTaskNoFoundException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydolphinscheduler.exceptions.PyDSTaskNoFoundException" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#pydolphinscheduler.exceptions.PyDSBaseException" title="pydolphinscheduler.exceptions.PyDSBaseException"><code class="xref py py-class docutils literal notranslate"><span class="pre">PyDSBaseException</span></code></a></p> |
| <p>Exception for pydolphinscheduler workflow task no found error.</p> |
| </dd></dl> |
| |
| </section> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="tasks/sub_process.html" class="btn btn-neutral float-left" title="Sub Process" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2022, apache.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| |
| <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> |
| <span class="rst-current-version" data-toggle="rst-current-version"> |
| <span class="fa fa-book"> Other Versions</span> |
| v: 2.0.6 |
| <span class="fa fa-caret-down"></span> |
| </span> |
| <div class="rst-other-versions"> |
| <dl> |
| <dt>Tags</dt> |
| <dd><a href="../2.0.5/api.html">2.0.5</a></dd> |
| <dd><a href="api.html">2.0.6</a></dd> |
| <dd><a href="../2.0.7/api.html">2.0.7</a></dd> |
| <dd><a href="../3.0.0/api.html">3.0.0</a></dd> |
| <dd><a href="../3.0.1/api.html">3.0.1</a></dd> |
| <dd><a href="../3.1.0/api.html">3.1.0</a></dd> |
| <dd><a href="../4.0.0/api.html">4.0.0</a></dd> |
| <dd><a href="../4.0.1/api.html">4.0.1</a></dd> |
| <dd><a href="../4.0.2/api.html">4.0.2</a></dd> |
| <dd><a href="../4.0.3/api.html">4.0.3</a></dd> |
| <dd><a href="../4.0.4/api.html">4.0.4</a></dd> |
| </dl> |
| <dl> |
| <dt>Branches</dt> |
| <dd><a href="../main/api.html">main</a></dd> |
| </dl> |
| </div> |
| </div><script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
