aboutsummaryrefslogtreecommitdiffstats
path: root/client/jobs.html
diff options
context:
space:
mode:
Diffstat (limited to 'client/jobs.html')
-rwxr-xr-xclient/jobs.html127
1 files changed, 78 insertions, 49 deletions
diff --git a/client/jobs.html b/client/jobs.html
index 4a58384..722dcc1 100755
--- a/client/jobs.html
+++ b/client/jobs.html
@@ -13,6 +13,8 @@
13 13
14 14
15 15
16
17
16 18
17 19
18 20
@@ -45,6 +47,7 @@
45 47
46<body class="wy-body-for-nav" role="document"> 48<body class="wy-body-for-nav" role="document">
47 49
50
48 <div class="wy-grid-for-nav"> 51 <div class="wy-grid-for-nav">
49 52
50 53
@@ -64,7 +67,7 @@
64 67
65 68
66 <div class="version"> 69 <div class="version">
67 0.3.3 70 0.3.6
68 </div> 71 </div>
69 72
70 73
@@ -85,7 +88,10 @@
85 88
86 89
87 90
88 <ul class="current"> 91
92
93
94 <ul class="current">
89<li class="toctree-l1"><a class="reference internal" href="../using.html">Using EventMQ</a></li> 95<li class="toctree-l1"><a class="reference internal" href="../using.html">Using EventMQ</a></li>
90<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current"> 96<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current">
91<li class="toctree-l2 current"><a class="reference internal" href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a><ul class="current"> 97<li class="toctree-l2 current"><a class="reference internal" href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a><ul class="current">
@@ -115,8 +121,10 @@
115 121
116 122
117 <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> 123 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
118 <i data-toggle="wy-nav-top" class="fa fa-bars"></i> 124
119 <a href="../index.html">EventMQ</a> 125 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
126 <a href="../index.html">EventMQ</a>
127
120 </nav> 128 </nav>
121 129
122 130
@@ -125,27 +133,44 @@
125 <div class="rst-content"> 133 <div class="rst-content">
126 134
127 135
128 136
137
138
139
140
141
142
143
144
145
146
129 147
130 148
131 149
132<div role="navigation" aria-label="breadcrumbs navigation"> 150<div role="navigation" aria-label="breadcrumbs navigation">
151
133 <ul class="wy-breadcrumbs"> 152 <ul class="wy-breadcrumbs">
134 <li><a href="../index.html">Docs</a> &raquo;</li> 153
135 154 <li><a href="../index.html">Docs</a> &raquo;</li>
155
136 <li><a href="../api.html">API Documentation</a> &raquo;</li> 156 <li><a href="../api.html">API Documentation</a> &raquo;</li>
137 157
138 <li><a href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a> &raquo;</li> 158 <li><a href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a> &raquo;</li>
139 159
140 <li><code class="docutils literal"><span class="pre">jobs</span></code> &#8211; Client Job Helpers</li> 160 <li><code class="docutils literal"><span class="pre">jobs</span></code> &#8211; Client Job Helpers</li>
161
162
141 <li class="wy-breadcrumbs-aside"> 163 <li class="wy-breadcrumbs-aside">
142 164
143 165
144 <a href="../_sources/client/jobs.rst.txt" rel="nofollow"> View page source</a> 166 <a href="../_sources/client/jobs.rst.txt" rel="nofollow"> View page source</a>
145 167
146 168
147 </li> 169 </li>
170
148 </ul> 171 </ul>
172
173
149 <hr/> 174 <hr/>
150</div> 175</div>
151 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> 176 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
@@ -162,23 +187,23 @@
162<p class="last">All passed class &amp; function kwargs/args MUST be json serializable.</p> 187<p class="last">All passed class &amp; function kwargs/args MUST be json serializable.</p>
163</div> 188</div>
164<p>Usage:</p> 189<p>Usage:</p>
165<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">eventmq</span> <span class="kn">import</span> <span class="n">job</span> 190<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">eventmq</span> <span class="kn">import</span> <span class="n">job</span>
166 191
167<span class="nd">@job</span><span class="p">(</span><span class="n">queue</span><span class="o">=</span><span class="s1">&#39;messaging&#39;</span><span class="p">)</span> 192<span class="nd">@job</span><span class="p">(</span><span class="n">queue</span><span class="o">=</span><span class="s">&#39;messaging&#39;</span><span class="p">)</span>
168<span class="k">def</span> <span class="nf">send_email</span><span class="p">(</span><span class="n">recipient</span><span class="p">,</span> <span class="n">subject</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> 193<span class="k">def</span> <span class="nf">send_email</span><span class="p">(</span><span class="n">recipient</span><span class="p">,</span> <span class="n">subject</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
169 <span class="kn">from</span> <span class="nn">email.mime.text</span> <span class="kn">import</span> <span class="n">MIMEText</span> 194 <span class="kn">from</span> <span class="nn">email.mime.text</span> <span class="kn">import</span> <span class="n">MIMEText</span>
170 <span class="kn">import</span> <span class="nn">smtplib</span> 195 <span class="kn">import</span> <span class="nn">smtplib</span>
171 196
172 <span class="n">msg</span> <span class="o">=</span> <span class="n">MIMEText</span><span class="p">(</span><span class="n">message</span><span class="p">)</span> 197 <span class="n">msg</span> <span class="o">=</span> <span class="n">MIMEText</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
173 <span class="n">msg</span><span class="p">[</span><span class="s1">&#39;Subject&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">subject</span> 198 <span class="n">msg</span><span class="p">[</span><span class="s">&#39;Subject&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">subject</span>
174 <span class="n">msg</span><span class="p">[</span><span class="s1">&#39;From&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;no-reply@foobar.io&#39;</span> 199 <span class="n">msg</span><span class="p">[</span><span class="s">&#39;From&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;no-reply@foobar.io&#39;</span>
175 <span class="n">msg</span><span class="p">[</span><span class="s1">&#39;To&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">recipient</span> 200 <span class="n">msg</span><span class="p">[</span><span class="s">&#39;To&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">recipient</span>
176 201
177 <span class="n">s</span> <span class="o">=</span> <span class="n">smtplib</span><span class="o">.</span><span class="n">SMTP</span><span class="p">(</span><span class="s1">&#39;smtp.gmail.com&#39;</span><span class="p">)</span> 202 <span class="n">s</span> <span class="o">=</span> <span class="n">smtplib</span><span class="o">.</span><span class="n">SMTP</span><span class="p">(</span><span class="s">&#39;smtp.gmail.com&#39;</span><span class="p">)</span>
178 203
179 <span class="n">s</span><span class="o">.</span><span class="n">login</span><span class="p">(</span><span class="s1">&#39;me@gmail.com&#39;</span><span class="p">,</span> <span class="s1">&#39;my-app-password&#39;</span><span class="p">)</span> 204 <span class="n">s</span><span class="o">.</span><span class="n">login</span><span class="p">(</span><span class="s">&#39;me@gmail.com&#39;</span><span class="p">,</span> <span class="s">&#39;my-app-password&#39;</span><span class="p">)</span>
180 205
181 <span class="n">s</span><span class="o">.</span><span class="n">sendmail</span><span class="p">(</span><span class="s1">&#39;me@gmail.com&#39;</span><span class="p">,</span> <span class="p">[</span><span class="n">recipient</span><span class="p">,],</span> <span class="n">msg</span><span class="o">.</span><span class="n">as_string</span><span class="p">())</span> 206 <span class="n">s</span><span class="o">.</span><span class="n">sendmail</span><span class="p">(</span><span class="s">&#39;me@gmail.com&#39;</span><span class="p">,</span> <span class="p">[</span><span class="n">recipient</span><span class="p">,],</span> <span class="n">msg</span><span class="o">.</span><span class="n">as_string</span><span class="p">())</span>
182 <span class="n">s</span><span class="o">.</span><span class="n">quit</span><span class="p">()</span> 207 <span class="n">s</span><span class="o">.</span><span class="n">quit</span><span class="p">()</span>
183</pre></div> 208</pre></div>
184</div> 209</div>
@@ -190,13 +215,13 @@
190<col class="field-body" /> 215<col class="field-body" />
191<tbody valign="top"> 216<tbody valign="top">
192<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 217<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
193<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the queue this function should be executed 218<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; Name of the queue this function should be executed
194in. If no queue provided <code class="docutils literal"><span class="pre">default</span></code> is used.</li> 219in. If no queue provided <code class="docutils literal"><span class="pre">default</span></code> is used.</li>
195<li><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address of the broker to send the job to. If no 220<li><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; Address of the broker to send the job to. If no
196address is given then the value of the environment variable 221address is given then the value of the environment variable
197<code class="docutils literal"><span class="pre">EMQ_BROKER_ADDR</span></code> will be used, If that is undefined a 222<code class="docutils literal"><span class="pre">EMQ_BROKER_ADDR</span></code> will be used, If that is undefined a
198warning will be emitted and the job will be run synchronously.</li> 223warning will be emitted and the job will be run synchronously.</li>
199<li><strong>async</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; If you want to run all executions of a particular job 224<li><strong>async</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) &#8211; If you want to run all executions of a particular job
200synchronously but still decorate it with the job decorator you 225synchronously but still decorate it with the job decorator you
201can set this to False. This is useful for unit tests.</li> 226can set this to False. This is useful for unit tests.</li>
202</ul> 227</ul>
@@ -234,27 +259,27 @@ can set this to False. This is useful for unit tests.</li>
234<col class="field-body" /> 259<col class="field-body" />
235<tbody valign="top"> 260<tbody valign="top">
236<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 261<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
237<li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) &#8211; the callable (or string path to calable) to be 262<li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#callable" title="(in Python v3.7)"><em>callable</em></a>) &#8211; the callable (or string path to calable) to be
238scheduled on a worker</li> 263scheduled on a worker</li>
239<li><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address of the broker to send the job to. If no 264<li><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; Address of the broker to send the job to. If no
240address is given then the value of the environment variable 265address is given then the value of the environment variable
241<code class="docutils literal"><span class="pre">EMQ_BROKER_ADDR</span></code> will be used.</li> 266<code class="docutils literal"><span class="pre">EMQ_BROKER_ADDR</span></code> will be used.</li>
242<li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Run job every interval_secs or None if using cron</li> 267<li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) &#8211; Run job every interval_secs or None if using cron</li>
243<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id1"><span class="problematic" id="id2">*</span></a>args to pass to the callable</li> 268<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) &#8211; list of <a href="#id1"><span class="problematic" id="id2">*</span></a>args to pass to the callable</li>
244<li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs to pass to the callable</li> 269<li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) &#8211; dict of <a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs to pass to the callable</li>
245<li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id5"><span class="problematic" id="id6">*</span></a>args to pass to the class (if applicable)</li> 270<li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) &#8211; list of <a href="#id5"><span class="problematic" id="id6">*</span></a>args to pass to the class (if applicable)</li>
246<li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs to pass to the class (if 271<li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) &#8211; dict of <a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs to pass to the class (if
247applicable)</li> 272applicable)</li>
248<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of strings denoting enabled headers. Default: 273<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) &#8211; list of strings denoting enabled headers. Default:
249guarantee is enabled to ensure the scheduler schedules the job.</li> 274guarantee is enabled to ensure the scheduler schedules the job.</li>
250<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of the queue to use when executing the job. The 275<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; name of the queue to use when executing the job. The
251default value is the default queue.</li> 276default value is the default queue.</li>
252<li><strong>cron</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) &#8211; cron formatted string used for job schedule if 277<li><strong>cron</strong> (<a class="reference external" href="https://docs.python.org/3/library/string.html#module-string" title="(in Python v3.7)"><em>string</em></a>) &#8211; cron formatted string used for job schedule if
253interval_secs is None, i.e. &#8216;* * * * <a href="#id9"><span class="problematic" id="id10">*</span></a>&#8216; (every minute)</li> 278interval_secs is None, i.e. &#8216;* * * * <a href="#id9"><span class="problematic" id="id10">*</span></a>&#8216; (every minute)</li>
254</ul> 279</ul>
255</td> 280</td>
256</tr> 281</tr>
257<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code> &#8211; When one or more parameters are not JSON serializable.</p> 282<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.7)"><code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code></a> &#8211; When one or more parameters are not JSON serializable.</p>
258</td> 283</td>
259</tr> 284</tr>
260<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils"> 285<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
@@ -265,7 +290,7 @@ interval_secs is None, i.e. &#8216;* * * * <a href="#id9"><span class="problemat
265</p> 290</p>
266</td> 291</td>
267</tr> 292</tr>
268<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p> 293<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
269</td> 294</td>
270</tr> 295</tr>
271</tbody> 296</tbody>
@@ -285,27 +310,27 @@ interval_secs is None, i.e. &#8216;* * * * <a href="#id9"><span class="problemat
285<col class="field-body" /> 310<col class="field-body" />
286<tbody valign="top"> 311<tbody valign="top">
287<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 312<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
288<li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) &#8211; the callable (or string path to calable) to be 313<li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#callable" title="(in Python v3.7)"><em>callable</em></a>) &#8211; the callable (or string path to calable) to be
289scheduled on a worker</li> 314scheduled on a worker</li>
290<li><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address of the broker to send the job to. If no 315<li><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; Address of the broker to send the job to. If no
291address is given then the value of the environment variable 316address is given then the value of the environment variable
292<code class="docutils literal"><span class="pre">EMQ_BROKER_ADDR</span></code> will be used.</li> 317<code class="docutils literal"><span class="pre">EMQ_BROKER_ADDR</span></code> will be used.</li>
293<li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Run job every interval_secs or None if using cron</li> 318<li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) &#8211; Run job every interval_secs or None if using cron</li>
294<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id11"><span class="problematic" id="id12">*</span></a>args to pass to the callable</li> 319<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) &#8211; list of <a href="#id11"><span class="problematic" id="id12">*</span></a>args to pass to the callable</li>
295<li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id13"><span class="problematic" id="id14">**</span></a>kwargs to pass to the callable</li> 320<li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) &#8211; dict of <a href="#id13"><span class="problematic" id="id14">**</span></a>kwargs to pass to the callable</li>
296<li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id15"><span class="problematic" id="id16">*</span></a>args to pass to the class (if applicable)</li> 321<li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) &#8211; list of <a href="#id15"><span class="problematic" id="id16">*</span></a>args to pass to the class (if applicable)</li>
297<li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id17"><span class="problematic" id="id18">**</span></a>kwargs to pass to the class (if 322<li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) &#8211; dict of <a href="#id17"><span class="problematic" id="id18">**</span></a>kwargs to pass to the class (if
298applicable)</li> 323applicable)</li>
299<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of strings denoting enabled headers. Default: 324<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) &#8211; list of strings denoting enabled headers. Default:
300guarantee is enabled to ensure the scheduler schedules the job.</li> 325guarantee is enabled to ensure the scheduler schedules the job.</li>
301<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of the queue to use when executing the job. The 326<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; name of the queue to use when executing the job. The
302default value is the default queue.</li> 327default value is the default queue.</li>
303<li><strong>cron</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) &#8211; cron formatted string used for job schedule if 328<li><strong>cron</strong> (<a class="reference external" href="https://docs.python.org/3/library/string.html#module-string" title="(in Python v3.7)"><em>string</em></a>) &#8211; cron formatted string used for job schedule if
304interval_secs is None, i.e. &#8216;* * * * <a href="#id19"><span class="problematic" id="id20">*</span></a>&#8216; (every minute)</li> 329interval_secs is None, i.e. &#8216;* * * * <a href="#id19"><span class="problematic" id="id20">*</span></a>&#8216; (every minute)</li>
305</ul> 330</ul>
306</td> 331</td>
307</tr> 332</tr>
308<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code> &#8211; When one or more parameters are not JSON serializable.</p> 333<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.7)"><code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code></a> &#8211; When one or more parameters are not JSON serializable.</p>
309</td> 334</td>
310</tr> 335</tr>
311<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils"> 336<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
@@ -316,7 +341,7 @@ interval_secs is None, i.e. &#8216;* * * * <a href="#id19"><span class="problema
316</p> 341</p>
317</td> 342</td>
318</tr> 343</tr>
319<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p> 344<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
320</td> 345</td>
321</tr> 346</tr>
322</tbody> 347</tbody>
@@ -327,15 +352,18 @@ interval_secs is None, i.e. &#8216;* * * * <a href="#id19"><span class="problema
327 352
328 353
329 </div> 354 </div>
355 <div class="articleComments">
356
357 </div>
330 </div> 358 </div>
331 <footer> 359 <footer>
332 360
333 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 361 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
334 362
335 <a href="../exceptions.html" class="btn btn-neutral float-right" title="exceptions – Exceptions" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 363 <a href="../exceptions.html" class="btn btn-neutral float-right" title="exceptions – Exceptions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
336 364
337 365
338 <a href="messages.html" class="btn btn-neutral" title="messages – Client Messaging" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 366 <a href="messages.html" class="btn btn-neutral" title="messages – Client Messaging" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
339 367
340 </div> 368 </div>
341 369
@@ -369,7 +397,8 @@ interval_secs is None, i.e. &#8216;* * * * <a href="#id19"><span class="problema
369 VERSION:'0', 397 VERSION:'0',
370 COLLAPSE_INDEX:false, 398 COLLAPSE_INDEX:false,
371 FILE_SUFFIX:'.html', 399 FILE_SUFFIX:'.html',
372 HAS_SOURCE: true 400 HAS_SOURCE: true,
401 SOURCELINK_SUFFIX: '.txt'
373 }; 402 };
374 </script> 403 </script>
375 <script type="text/javascript" src="../_static/jquery.js"></script> 404 <script type="text/javascript" src="../_static/jquery.js"></script>
generated by cgit v1.2.1 (git 2.18.0) at 2026-01-12 04:57:27 +0000