-
Notifications
You must be signed in to change notification settings - Fork 0
/
deployment.html
792 lines (734 loc) · 79.4 KB
/
deployment.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>mtap.deployment — MTAP 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="mtap.serialization" href="serialization.html" />
<link rel="prev" title="mtap" href="mtap.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="serialization.html" title="mtap.serialization"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="mtap.html" title="mtap"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">MTAP 1.0.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">mtap.deployment</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-mtap.deployment">
<span id="mtap-deployment"></span><h1>mtap.deployment<a class="headerlink" href="#module-mtap.deployment" title="Permalink to this heading">¶</a></h1>
<p>Module for deploying a set of processing services and the events server all at once.</p>
<p class="rubric">Examples</p>
<p>See python/mtap/examples/exampleDeploymentConfiguration.yml for an example of the yaml deployment configuration
which can be loaded using <a class="reference internal" href="#mtap.deployment.Deployment.from_yaml_file" title="mtap.deployment.Deployment.from_yaml_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">from_yaml_file()</span></code></a></p>
<p>An example configuration</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">deploy</span> <span class="o">=</span> <span class="n">Deployment</span><span class="p">(</span>
<span class="gp">>>> </span> <span class="n">GlobalSettings</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s1">'0.0.0.0'</span><span class="p">),</span>
<span class="gp">>>> </span> <span class="n">EventsDeployment</span><span class="p">(</span><span class="n">port</span><span class="o">=</span><span class="mi">10100</span><span class="p">,</span> <span class="n">workers</span><span class="o">=</span><span class="mi">8</span><span class="p">),</span>
<span class="gp">>>> </span> <span class="n">SharedProcessorConfig</span><span class="p">(</span><span class="n">workers</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span> <span class="n">jvm_args</span><span class="o">=</span><span class="p">[</span><span class="s1">'-Xms32m'</span><span class="p">,</span> <span class="s1">'-Xmx8g'</span><span class="p">],</span> <span class="n">classpath</span><span class="o">=</span><span class="s1">'blah.jar'</span><span class="p">),</span>
<span class="gp">>>> </span> <span class="n">ProcessorDeployment</span><span class="p">(</span><span class="n">implementation</span><span class="o">=</span><span class="s1">'python'</span><span class="p">,</span>
<span class="gp">>>> </span> <span class="n">entry_point</span><span class="o">=</span><span class="s1">'mtap.examples.example_processor'</span><span class="p">,</span>
<span class="gp">>>> </span> <span class="n">instances</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span>
<span class="gp">>>> </span> <span class="n">port</span><span class="o">=</span><span class="mi">10101</span><span class="p">,</span>
<span class="gp">>>> </span> <span class="n">workers</span><span class="o">=</span><span class="mi">4</span><span class="p">),</span>
<span class="gp">>>> </span> <span class="n">ProcessorDeployment</span><span class="p">(</span><span class="n">implementation</span><span class="o">=</span><span class="s1">'java'</span><span class="p">,</span>
<span class="gp">>>> </span> <span class="n">entry_point</span><span class="o">=</span><span class="s1">'edu.umn.nlpie.mtap.WordOccurrencesExampleProcessor'</span><span class="p">,</span>
<span class="gp">>>> </span> <span class="n">port</span><span class="o">=</span><span class="mi">10105</span><span class="p">)</span>
<span class="gp">>>> </span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">deploy</span><span class="o">.</span><span class="n">run_servers</span><span class="p">()</span>
</pre></div>
</div>
<dl class="py class">
<dt class="sig sig-object py" id="mtap.deployment.Deployment">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mtap.deployment.</span></span><span class="sig-name descname"><span class="pre">Deployment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">global_settings</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="n"><span class="pre">events_deployment</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="n"><span class="pre">shared_processor_config</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><span class="n"><span class="pre">processors</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#Deployment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.Deployment" title="Permalink to this definition">¶</a></dt>
<dd><p>An automatic deployment configuration which launches a configurable set of MTAP services.</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>global_settings</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference internal" href="#mtap.deployment.GlobalSettings" title="mtap.deployment.GlobalSettings"><em>GlobalSettings</em></a><em>]</em>) – Settings shared among all services.</p></li>
<li><p><strong>events_deployment</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference internal" href="#mtap.deployment.EventsDeployment" title="mtap.deployment.EventsDeployment"><em>EventsDeployment</em></a><em>]</em>) – Deployment settings for the events service.</p></li>
<li><p><strong>shared_processor_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference internal" href="#mtap.deployment.SharedProcessorConfig" title="mtap.deployment.SharedProcessorConfig"><em>SharedProcessorConfig</em></a><em>]</em>) – Shared configuration settings for all processors.</p></li>
<li><p><strong>*processors</strong> (<a class="reference internal" href="#mtap.deployment.ProcessorDeployment" title="mtap.deployment.ProcessorDeployment"><em>ProcessorDeployment</em></a>) – Configurations for individual processors.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.Deployment.global_settings">
<span class="sig-name descname"><span class="pre">global_settings</span></span><a class="headerlink" href="#mtap.deployment.Deployment.global_settings" title="Permalink to this definition">¶</a></dt>
<dd><p>Settings shared among all services.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference internal" href="#mtap.deployment.GlobalSettings" title="mtap.deployment.GlobalSettings">GlobalSettings</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.Deployment.events_deployment">
<span class="sig-name descname"><span class="pre">events_deployment</span></span><a class="headerlink" href="#mtap.deployment.Deployment.events_deployment" title="Permalink to this definition">¶</a></dt>
<dd><p>Deployment settings for the events service.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference internal" href="#mtap.deployment.EventsDeployment" title="mtap.deployment.EventsDeployment">EventsDeployment</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.Deployment.shared_processor_config">
<span class="sig-name descname"><span class="pre">shared_processor_config</span></span><a class="headerlink" href="#mtap.deployment.Deployment.shared_processor_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Shared configuration settings for all processors.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference internal" href="#mtap.deployment.SharedProcessorConfig" title="mtap.deployment.SharedProcessorConfig">SharedProcessorConfig</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.Deployment.processors">
<span class="sig-name descname"><span class="pre">processors</span></span><a class="headerlink" href="#mtap.deployment.Deployment.processors" title="Permalink to this definition">¶</a></dt>
<dd><p>Configurations for individual processors.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.11)"><em>List</em></a>[<a class="reference internal" href="#mtap.deployment.ProcessorDeployment" title="mtap.deployment.ProcessorDeployment">ProcessorDeployment</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mtap.deployment.Deployment.load_configuration">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conf</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#Deployment.load_configuration"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.Deployment.load_configuration" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a deployment object from a configuration dictionary.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>conf</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.11)"><em>Dict</em></a>) – The configuration dictionary.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Deployment object created.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mtap.deployment.Deployment.from_yaml_file">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_yaml_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conf_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#Deployment.from_yaml_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.Deployment.from_yaml_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads a deployment configuration from a yaml file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>conf_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.11)"><em>pathlib.Path</em></a>) – The path to the yaml configuration file.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Deployment object created from the configuration.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mtap.deployment.Deployment.run_servers">
<span class="sig-name descname"><span class="pre">run_servers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#Deployment.run_servers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.Deployment.run_servers" title="Permalink to this definition">¶</a></dt>
<dd><p>A context manager that starts all the configured services in subprocesses and returns.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#mtap.deployment.ServiceDeploymentException" title="mtap.deployment.ServiceDeploymentException"><strong>ServiceDeploymentException</strong></a> – If one or more of the services fails to launch.</p>
</dd>
</dl>
<p>Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">deploy</span> <span class="o">=</span> <span class="n">Deployment</span><span class="o">.</span><span class="n">from_yaml_file</span><span class="p">(</span><span class="s1">'deploy_config.yml'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">with</span> <span class="n">deploy</span><span class="o">.</span><span class="n">run_servers</span><span class="p">():</span>
<span class="gp">>>> </span> <span class="c1"># do something that requires the servers.</span>
<span class="gp">>>> </span><span class="c1"># servers are automatically shutdown / terminated when the block is exited</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mtap.deployment.Deployment.run_servers_and_wait">
<span class="sig-name descname"><span class="pre">run_servers_and_wait</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#Deployment.run_servers_and_wait"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.Deployment.run_servers_and_wait" title="Permalink to this definition">¶</a></dt>
<dd><p>Starts the specified servers and blocks until KeyboardInterrupt, SIGINT, or SIGTERM are received.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mtap.deployment.Deployment.shutdown">
<span class="sig-name descname"><span class="pre">shutdown</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#Deployment.shutdown"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.Deployment.shutdown" title="Permalink to this definition">¶</a></dt>
<dd><p>Shuts down all processors.</p>
<p>Returns:</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="mtap.deployment.GlobalSettings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mtap.deployment.</span></span><span class="sig-name descname"><span class="pre">GlobalSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</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="n"><span class="pre">mtap_config</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="n"><span class="pre">log_level</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="n"><span class="pre">register</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#GlobalSettings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.GlobalSettings" title="Permalink to this definition">¶</a></dt>
<dd><p>Settings shared by event service and all processors.</p>
<dl class="field-list simple">
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – The global host override, forces all services to use a specific host name.</p></li>
<li><p><strong>mtap_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – The path to an MTAP config file to load for all services.</p></li>
<li><p><strong>log_level</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – A python logging level to pass to all services.</p></li>
<li><p><strong>register</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a><em>]</em>) – Whether services should register with service discovery.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.GlobalSettings.host">
<span class="sig-name descname"><span class="pre">host</span></span><a class="headerlink" href="#mtap.deployment.GlobalSettings.host" title="Permalink to this definition">¶</a></dt>
<dd><p>The global host override, forces all services to use a specific host name.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.GlobalSettings.mtap_config">
<span class="sig-name descname"><span class="pre">mtap_config</span></span><a class="headerlink" href="#mtap.deployment.GlobalSettings.mtap_config" title="Permalink to this definition">¶</a></dt>
<dd><p>The path to an MTAP config file to load for all services.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.GlobalSettings.log_level">
<span class="sig-name descname"><span class="pre">log_level</span></span><a class="headerlink" href="#mtap.deployment.GlobalSettings.log_level" title="Permalink to this definition">¶</a></dt>
<dd><p>A python logging level to pass to all services.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.GlobalSettings.register">
<span class="sig-name descname"><span class="pre">register</span></span><a class="headerlink" href="#mtap.deployment.GlobalSettings.register" title="Permalink to this definition">¶</a></dt>
<dd><p>Whether services should register with service discovery.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)">bool</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mtap.deployment.GlobalSettings.from_conf">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_conf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conf</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#GlobalSettings.from_conf"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.GlobalSettings.from_conf" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a global settings object from a configuration dictionary.</p>
<dl class="field-list simple">
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>conf</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.11)"><em>Dict</em></a><em>]</em>) – The configuration dictionary.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The global settings object.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#mtap.deployment.GlobalSettings" title="mtap.deployment.GlobalSettings">GlobalSettings</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="mtap.deployment.SharedProcessorConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mtap.deployment.</span></span><span class="sig-name descname"><span class="pre">SharedProcessorConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">events_addresses</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="n"><span class="pre">workers</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="n"><span class="pre">additional_args</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="n"><span class="pre">jvm_args</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="n"><span class="pre">java_classpath</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="n"><span class="pre">java_additional_args</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="n"><span class="pre">startup_timeout</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="n"><span class="pre">mp_spawn_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#SharedProcessorConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.SharedProcessorConfig" title="Permalink to this definition">¶</a></dt>
<dd><p>Configuration that is shared between multiple processor services.</p>
<dl class="field-list simple">
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>events_addresses</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.11)"><em>List</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em><em>]</em>) – An optional GRPC-compatible target for the events
service to be used by all processors.</p></li>
<li><p><strong>workers</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a><em>]</em>) – The default number of worker threads which will perform
processing.</p></li>
<li><p><strong>additional_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.11)"><em>List</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em><em>]</em>) – a list of additional arguments that
should be appended to every processor.</p></li>
<li><p><strong>jvm_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.11)"><em>List</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em><em>]</em>) – a list of JVM arguments for all java
processors.</p></li>
<li><p><strong>java_classpath</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – A classpath string that will be passed to all java
processors.</p></li>
<li><p><strong>startup_timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a><em>]</em>) – The default startup timeout for processors.</p></li>
<li><p><strong>mp_spawn_method</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – A <code class="xref py py-meth docutils literal notranslate"><span class="pre">multiprocessing.get_context()</span></code> argument to create
the multiprocessing context.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.SharedProcessorConfig.events_addresses">
<span class="sig-name descname"><span class="pre">events_addresses</span></span><a class="headerlink" href="#mtap.deployment.SharedProcessorConfig.events_addresses" title="Permalink to this definition">¶</a></dt>
<dd><p>An optional GRPC-compatible target for the events
service to be used by all processors.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.11)"><em>List</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.SharedProcessorConfig.workers">
<span class="sig-name descname"><span class="pre">workers</span></span><a class="headerlink" href="#mtap.deployment.SharedProcessorConfig.workers" title="Permalink to this definition">¶</a></dt>
<dd><p>The default number of worker threads which will perform
processing.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)">int</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.SharedProcessorConfig.additional_args">
<span class="sig-name descname"><span class="pre">additional_args</span></span><a class="headerlink" href="#mtap.deployment.SharedProcessorConfig.additional_args" title="Permalink to this definition">¶</a></dt>
<dd><p>a list of additional arguments that
should be appended to every processor.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.11)"><em>List</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.SharedProcessorConfig.jvm_args">
<span class="sig-name descname"><span class="pre">jvm_args</span></span><a class="headerlink" href="#mtap.deployment.SharedProcessorConfig.jvm_args" title="Permalink to this definition">¶</a></dt>
<dd><p>a list of JVM arguments for all java
processors.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.11)"><em>List</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.SharedProcessorConfig.java_classpath">
<span class="sig-name descname"><span class="pre">java_classpath</span></span><a class="headerlink" href="#mtap.deployment.SharedProcessorConfig.java_classpath" title="Permalink to this definition">¶</a></dt>
<dd><p>A classpath string that will be passed to all java
processors.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.SharedProcessorConfig.startup_timeout">
<span class="sig-name descname"><span class="pre">startup_timeout</span></span><a class="headerlink" href="#mtap.deployment.SharedProcessorConfig.startup_timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>The default startup timeout for processors.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)">int</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.SharedProcessorConfig.mp_spawn_method">
<span class="sig-name descname"><span class="pre">mp_spawn_method</span></span><a class="headerlink" href="#mtap.deployment.SharedProcessorConfig.mp_spawn_method" title="Permalink to this definition">¶</a></dt>
<dd><p>A <code class="xref py py-meth docutils literal notranslate"><span class="pre">multiprocessing.get_context()</span></code> argument to create
the multiprocessing context.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mtap.deployment.SharedProcessorConfig.from_conf">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_conf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conf</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#SharedProcessorConfig.from_conf"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.SharedProcessorConfig.from_conf" title="Permalink to this definition">¶</a></dt>
<dd><p>Builds a configuration from a dictionary representation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>conf</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.11)"><em>Dict</em></a><em>]</em>) – The configuration dictionary.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>SharedProcessorConfig object.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="mtap.deployment.EventsDeployment">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mtap.deployment.</span></span><span class="sig-name descname"><span class="pre">EventsDeployment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">addresses</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="n"><span class="pre">workers</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="n"><span class="pre">register</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="n"><span class="pre">mtap_config</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="n"><span class="pre">log_level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#EventsDeployment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.EventsDeployment" title="Permalink to this definition">¶</a></dt>
<dd><p>Deployment configuration for the events service.</p>
<dl class="field-list simple">
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>enabled</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a>) – Whether an events service should be created.</p></li>
<li><p><strong>addresses</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.11)"><em>Sequence</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em><em>]</em>) – The host address of the events service.</p></li>
<li><p><strong>workers</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a><em>]</em>) – The number of worker threads the events service should use.</p></li>
<li><p><strong>register</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a><em>]</em>) – Whether to register the events service with discovery.</p></li>
<li><p><strong>mtap_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – Path to an mtap configuration file.</p></li>
<li><p><strong>log_level</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – The log level for the events service.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.EventsDeployment.enabled">
<span class="sig-name descname"><span class="pre">enabled</span></span><a class="headerlink" href="#mtap.deployment.EventsDeployment.enabled" title="Permalink to this definition">¶</a></dt>
<dd><p>Whether an events service should be created.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)">bool</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.EventsDeployment.addresses">
<span class="sig-name descname"><span class="pre">addresses</span></span><a class="headerlink" href="#mtap.deployment.EventsDeployment.addresses" title="Permalink to this definition">¶</a></dt>
<dd><p>The host address of the events service.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.11)"><em>Sequence</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.EventsDeployment.service_deployment">
<span class="sig-name descname"><span class="pre">service_deployment</span></span><a class="headerlink" href="#mtap.deployment.EventsDeployment.service_deployment" title="Permalink to this definition">¶</a></dt>
<dd><p>The service deployment settings (workers, registration, config, logging).</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#mtap.deployment.ServiceDeployment" title="mtap.deployment.ServiceDeployment">ServiceDeployment</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mtap.deployment.EventsDeployment.from_conf">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_conf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conf</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#EventsDeployment.from_conf"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.EventsDeployment.from_conf" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates the EventsDeployment configuration option from a configuration dictionary.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>conf</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.11)"><em>Dict</em></a><em>]</em>) – The configuration dictionary</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>EventsDeployment or None from the configuration dictionary.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="mtap.deployment.ServiceDeployment">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mtap.deployment.</span></span><span class="sig-name descname"><span class="pre">ServiceDeployment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">workers</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">register</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mtap_config</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">log_level</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#ServiceDeployment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.ServiceDeployment" title="Permalink to this definition">¶</a></dt>
<dd><p>Shared configuration for services, both events and processors.</p>
<dl class="field-list simple">
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>workers</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a><em>]</em>) – The number of workers.</p></li>
<li><p><strong>register</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a><em>]</em>) – Whether to use service discovery.</p></li>
<li><p><strong>mtap_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – A path to the mtap configuration.</p></li>
<li><p><strong>log_level</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – The log level.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ServiceDeployment.workers">
<span class="sig-name descname"><span class="pre">workers</span></span><a class="headerlink" href="#mtap.deployment.ServiceDeployment.workers" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of workers.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)">int</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ServiceDeployment.register">
<span class="sig-name descname"><span class="pre">register</span></span><a class="headerlink" href="#mtap.deployment.ServiceDeployment.register" title="Permalink to this definition">¶</a></dt>
<dd><p>Whether to use service discovery.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)">bool</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ServiceDeployment.mtap_config">
<span class="sig-name descname"><span class="pre">mtap_config</span></span><a class="headerlink" href="#mtap.deployment.ServiceDeployment.mtap_config" title="Permalink to this definition">¶</a></dt>
<dd><p>A path to the mtap configuration.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ServiceDeployment.log_level">
<span class="sig-name descname"><span class="pre">log_level</span></span><a class="headerlink" href="#mtap.deployment.ServiceDeployment.log_level" title="Permalink to this definition">¶</a></dt>
<dd><p>The log level.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mtap.deployment.</span></span><span class="sig-name descname"><span class="pre">ProcessorDeployment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">implementation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entry_point</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enabled</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="n"><span class="pre">instances</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="n"><span class="pre">host</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="n"><span class="pre">port</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="n"><span class="pre">workers</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="n"><span class="pre">register</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="n"><span class="pre">mtap_config</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="n"><span class="pre">log_level</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="n"><span class="pre">name</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="n"><span class="pre">unique_service_identifier</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="n"><span class="pre">pre_args</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="n"><span class="pre">additional_args</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="n"><span class="pre">startup_timeout</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="n"><span class="pre">mp_spawn_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#ProcessorDeployment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.ProcessorDeployment" title="Permalink to this definition">¶</a></dt>
<dd><p>Deployment configuration for an MTAP processor.</p>
<p>Used to construct the command for launching the processor. The processor should be a Java Class
with a main method or a Python module with a main block. It should accept the standard MTAP
processor deployment arguments and launch an MTAP processor using <a class="reference internal" href="mtap.html#mtap.run_processor" title="mtap.run_processor"><code class="xref py py-func docutils literal notranslate"><span class="pre">mtap.run_processor()</span></code></a> or
the equivalent Java method.</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>implementation</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – Either “java” or “python”.</p></li>
<li><p><strong>entry_point</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – Either the java main class, or the python main module.</p></li>
</ul>
</dd>
<dt class="field-even">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>enabled</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a><em>]</em>) – Whether the processor should be launched as part of
deployment. Default is <cite>True</cite> if <cite>None</cite>.</p></li>
<li><p><strong>instances</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a><em>]</em>) – The number of instances of the processor to launch.
Default is <cite>1</cite> if <cite>None</cite>.</p></li>
<li><p><strong>host</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – The listening host for the processor service.</p></li>
<li><p><strong>port</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a><em>]</em>) – The listening port for the processor service.</p></li>
<li><p><strong>workers</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a><em>]</em>) – The number of worker threads per instance.</p></li>
<li><p><strong>register</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><em>bool</em></a><em>]</em>) – Whether the processor should register with the discovery service specified in the MTAP
configuration</p></li>
<li><p><strong>mtap_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – Path to the MTAP configuration file.</p></li>
<li><p><strong>log_level</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – The log level for the processor.</p></li>
<li><p><strong>identifier</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – An optional identifier override to use for registration.</p></li>
<li><p><strong>pre_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.11)"><em>List</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em><em>]</em>) – Arguments that occur prior to the MTAP service arguments (like host, port, etc).</p></li>
<li><p><strong>additional_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.11)"><em>List</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em><em>]</em>) – Arguments that occur after the MTAP service arguments.</p></li>
<li><p><strong>startup_timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a><em>]</em>) – Optional override startup timeout.</p></li>
<li><p><strong>mp_spawn_method</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – A <code class="xref py py-meth docutils literal notranslate"><span class="pre">multiprocessing.get_context()</span></code> argument to create
the multiprocessing context.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment.implementation">
<span class="sig-name descname"><span class="pre">implementation</span></span><a class="headerlink" href="#mtap.deployment.ProcessorDeployment.implementation" title="Permalink to this definition">¶</a></dt>
<dd><p>Either “java” or “python”.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment.entry_point">
<span class="sig-name descname"><span class="pre">entry_point</span></span><a class="headerlink" href="#mtap.deployment.ProcessorDeployment.entry_point" title="Permalink to this definition">¶</a></dt>
<dd><p>Either the java main class, or the python main module.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment.enabled">
<span class="sig-name descname"><span class="pre">enabled</span></span><a class="headerlink" href="#mtap.deployment.ProcessorDeployment.enabled" title="Permalink to this definition">¶</a></dt>
<dd><p>Whether the processor should be launched as part of deployment.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)">bool</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment.instances">
<span class="sig-name descname"><span class="pre">instances</span></span><a class="headerlink" href="#mtap.deployment.ProcessorDeployment.instances" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of instances of the processor to launch.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)">int</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment.host">
<span class="sig-name descname"><span class="pre">host</span></span><a class="headerlink" href="#mtap.deployment.ProcessorDeployment.host" title="Permalink to this definition">¶</a></dt>
<dd><p>The listening host for the processor service.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment.port">
<span class="sig-name descname"><span class="pre">port</span></span><a class="headerlink" href="#mtap.deployment.ProcessorDeployment.port" title="Permalink to this definition">¶</a></dt>
<dd><p>The listening port for the processor service.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)">int</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment.service_deployment">
<span class="sig-name descname"><span class="pre">service_deployment</span></span><a class="headerlink" href="#mtap.deployment.ProcessorDeployment.service_deployment" title="Permalink to this definition">¶</a></dt>
<dd><p>The service deployment settings (workers, registration, config, logging).</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#mtap.deployment.ServiceDeployment" title="mtap.deployment.ServiceDeployment">ServiceDeployment</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment.pre_args">
<span class="sig-name descname"><span class="pre">pre_args</span></span><a class="headerlink" href="#mtap.deployment.ProcessorDeployment.pre_args" title="Permalink to this definition">¶</a></dt>
<dd><p>Arguments that occur prior to the MTAP service arguments (like host, port, etc).</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.11)"><em>List</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment.additional_args">
<span class="sig-name descname"><span class="pre">additional_args</span></span><a class="headerlink" href="#mtap.deployment.ProcessorDeployment.additional_args" title="Permalink to this definition">¶</a></dt>
<dd><p>Arguments that occur after the MTAP service arguments.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.11)"><em>List</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment.startup_timeout">
<span class="sig-name descname"><span class="pre">startup_timeout</span></span><a class="headerlink" href="#mtap.deployment.ProcessorDeployment.startup_timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Optional override startup timeout.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)">int</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment.mp_spawn_method">
<span class="sig-name descname"><span class="pre">mp_spawn_method</span></span><a class="headerlink" href="#mtap.deployment.ProcessorDeployment.mp_spawn_method" title="Permalink to this definition">¶</a></dt>
<dd><p>A <code class="xref py py-meth docutils literal notranslate"><span class="pre">multiprocessing.get_context()</span></code> argument to create
the multiprocessing context.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><em>Optional</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mtap.deployment.ProcessorDeployment.from_conf">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_conf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">conf</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#ProcessorDeployment.from_conf"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.ProcessorDeployment.from_conf" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates an MTAP processor deployment configuration from a configuration dictionary.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>conf</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.11)"><em>Dict</em></a>) – The configuration dictionary.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>ProcessorDeployment object that can be used to constuct the call for the processor.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="mtap.deployment.deployment_parser">
<span class="sig-prename descclassname"><span class="pre">mtap.deployment.</span></span><span class="sig-name descname"><span class="pre">deployment_parser</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/mtap/deployment.html#deployment_parser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.deployment_parser" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a parser for configuration that can be passed to the deployment main method.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The argument parser object that will create a namespace that can
be passed to <code class="xref py py-func docutils literal notranslate"><span class="pre">main()</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser" title="(in Python v3.11)"><em>ArgumentParser</em></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="mtap.deployment.ServiceDeploymentException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mtap.deployment.</span></span><span class="sig-name descname"><span class="pre">ServiceDeploymentException</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">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/mtap/deployment.html#ServiceDeploymentException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mtap.deployment.ServiceDeploymentException" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised in the case of a service failing to launch.</p>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="mtap.html">mtap</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">mtap.deployment</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#mtap.deployment.Deployment"><code class="docutils literal notranslate"><span class="pre">Deployment</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#mtap.deployment.GlobalSettings"><code class="docutils literal notranslate"><span class="pre">GlobalSettings</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#mtap.deployment.SharedProcessorConfig"><code class="docutils literal notranslate"><span class="pre">SharedProcessorConfig</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#mtap.deployment.EventsDeployment"><code class="docutils literal notranslate"><span class="pre">EventsDeployment</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#mtap.deployment.ServiceDeployment"><code class="docutils literal notranslate"><span class="pre">ServiceDeployment</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#mtap.deployment.ProcessorDeployment"><code class="docutils literal notranslate"><span class="pre">ProcessorDeployment</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#mtap.deployment.deployment_parser"><code class="docutils literal notranslate"><span class="pre">deployment_parser()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#mtap.deployment.ServiceDeploymentException"><code class="docutils literal notranslate"><span class="pre">ServiceDeploymentException</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="serialization.html">mtap.serialization</a></li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="mtap.html"
title="previous chapter">mtap</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="serialization.html"
title="next chapter">mtap.serialization</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/deployment.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="serialization.html" title="mtap.serialization"
>next</a> |</li>
<li class="right" >
<a href="mtap.html" title="mtap"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">MTAP 1.0.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">mtap.deployment</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2019, Regents of the University of Minnesota..
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
</body>
</html>