forked from temporalio/sdk-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmessage_pb2.pyi
More file actions
1115 lines (1055 loc) · 44.3 KB
/
Copy pathmessage_pb2.pyi
File metadata and controls
1115 lines (1055 loc) · 44.3 KB
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
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
@generated by mypy-protobuf. Do not edit manually!
isort:skip_file
The MIT License
Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""
import builtins
import collections.abc
import google.protobuf.descriptor
import google.protobuf.duration_pb2
import google.protobuf.internal.containers
import google.protobuf.message
import sys
import temporalio.api.common.v1.message_pb2
import temporalio.api.enums.v1.command_type_pb2
import temporalio.api.enums.v1.workflow_pb2
import temporalio.api.failure.v1.message_pb2
import temporalio.api.taskqueue.v1.message_pb2
if sys.version_info >= (3, 8):
import typing as typing_extensions
else:
import typing_extensions
DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
class ScheduleActivityTaskCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
ACTIVITY_ID_FIELD_NUMBER: builtins.int
ACTIVITY_TYPE_FIELD_NUMBER: builtins.int
TASK_QUEUE_FIELD_NUMBER: builtins.int
HEADER_FIELD_NUMBER: builtins.int
INPUT_FIELD_NUMBER: builtins.int
SCHEDULE_TO_CLOSE_TIMEOUT_FIELD_NUMBER: builtins.int
SCHEDULE_TO_START_TIMEOUT_FIELD_NUMBER: builtins.int
START_TO_CLOSE_TIMEOUT_FIELD_NUMBER: builtins.int
HEARTBEAT_TIMEOUT_FIELD_NUMBER: builtins.int
RETRY_POLICY_FIELD_NUMBER: builtins.int
REQUEST_EAGER_EXECUTION_FIELD_NUMBER: builtins.int
USE_COMPATIBLE_VERSION_FIELD_NUMBER: builtins.int
activity_id: builtins.str
@property
def activity_type(self) -> temporalio.api.common.v1.message_pb2.ActivityType: ...
@property
def task_queue(self) -> temporalio.api.taskqueue.v1.message_pb2.TaskQueue: ...
@property
def header(self) -> temporalio.api.common.v1.message_pb2.Header: ...
@property
def input(self) -> temporalio.api.common.v1.message_pb2.Payloads: ...
@property
def schedule_to_close_timeout(self) -> google.protobuf.duration_pb2.Duration:
"""Indicates how long the caller is willing to wait for activity completion. The "schedule" time
is when the activity is initially scheduled, not when the most recent retry is scheduled.
Limits how long retries will be attempted. Either this or `start_to_close_timeout` must be
specified. When not specified, defaults to the workflow execution timeout.
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: "to" is used to indicate interval. --)
"""
@property
def schedule_to_start_timeout(self) -> google.protobuf.duration_pb2.Duration:
"""Limits the time an activity task can stay in a task queue before a worker picks it up. The
"schedule" time is when the most recent retry is scheduled. This timeout should usually not
be set: it's useful in specific scenarios like worker-specific task queues. This timeout is
always non retryable, as all a retry would achieve is to put it back into the same queue.
Defaults to `schedule_to_close_timeout` or workflow execution timeout if that is not
specified. More info:
https://docs.temporal.io/docs/content/what-is-a-schedule-to-start-timeout/
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: "to" is used to indicate interval. --)
"""
@property
def start_to_close_timeout(self) -> google.protobuf.duration_pb2.Duration:
"""Maximum time an activity is allowed to execute after being picked up by a worker. This
timeout is always retryable. Either this or `schedule_to_close_timeout` must be specified.
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: "to" is used to indicate interval. --)
"""
@property
def heartbeat_timeout(self) -> google.protobuf.duration_pb2.Duration:
"""Maximum permitted time between successful worker heartbeats."""
@property
def retry_policy(self) -> temporalio.api.common.v1.message_pb2.RetryPolicy:
"""Activities are provided by a default retry policy which is controlled through the service's
dynamic configuration. Retries will be attempted until `schedule_to_close_timeout` has
elapsed. To disable retries set retry_policy.maximum_attempts to 1.
"""
request_eager_execution: builtins.bool
"""Request to start the activity directly bypassing matching service and worker polling
The slot for executing the activity should be reserved when setting this field to true.
"""
use_compatible_version: builtins.bool
"""If this is set, the workflow executing this command wishes to start the activity using
a version compatible with the version that this workflow most recently ran on, if such
behavior is possible.
"""
def __init__(
self,
*,
activity_id: builtins.str = ...,
activity_type: temporalio.api.common.v1.message_pb2.ActivityType | None = ...,
task_queue: temporalio.api.taskqueue.v1.message_pb2.TaskQueue | None = ...,
header: temporalio.api.common.v1.message_pb2.Header | None = ...,
input: temporalio.api.common.v1.message_pb2.Payloads | None = ...,
schedule_to_close_timeout: google.protobuf.duration_pb2.Duration | None = ...,
schedule_to_start_timeout: google.protobuf.duration_pb2.Duration | None = ...,
start_to_close_timeout: google.protobuf.duration_pb2.Duration | None = ...,
heartbeat_timeout: google.protobuf.duration_pb2.Duration | None = ...,
retry_policy: temporalio.api.common.v1.message_pb2.RetryPolicy | None = ...,
request_eager_execution: builtins.bool = ...,
use_compatible_version: builtins.bool = ...,
) -> None: ...
def HasField(
self,
field_name: typing_extensions.Literal[
"activity_type",
b"activity_type",
"header",
b"header",
"heartbeat_timeout",
b"heartbeat_timeout",
"input",
b"input",
"retry_policy",
b"retry_policy",
"schedule_to_close_timeout",
b"schedule_to_close_timeout",
"schedule_to_start_timeout",
b"schedule_to_start_timeout",
"start_to_close_timeout",
b"start_to_close_timeout",
"task_queue",
b"task_queue",
],
) -> builtins.bool: ...
def ClearField(
self,
field_name: typing_extensions.Literal[
"activity_id",
b"activity_id",
"activity_type",
b"activity_type",
"header",
b"header",
"heartbeat_timeout",
b"heartbeat_timeout",
"input",
b"input",
"request_eager_execution",
b"request_eager_execution",
"retry_policy",
b"retry_policy",
"schedule_to_close_timeout",
b"schedule_to_close_timeout",
"schedule_to_start_timeout",
b"schedule_to_start_timeout",
"start_to_close_timeout",
b"start_to_close_timeout",
"task_queue",
b"task_queue",
"use_compatible_version",
b"use_compatible_version",
],
) -> None: ...
global___ScheduleActivityTaskCommandAttributes = ScheduleActivityTaskCommandAttributes
class RequestCancelActivityTaskCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
SCHEDULED_EVENT_ID_FIELD_NUMBER: builtins.int
scheduled_event_id: builtins.int
"""The `ACTIVITY_TASK_SCHEDULED` event id for the activity being cancelled."""
def __init__(
self,
*,
scheduled_event_id: builtins.int = ...,
) -> None: ...
def ClearField(
self,
field_name: typing_extensions.Literal[
"scheduled_event_id", b"scheduled_event_id"
],
) -> None: ...
global___RequestCancelActivityTaskCommandAttributes = (
RequestCancelActivityTaskCommandAttributes
)
class StartTimerCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
TIMER_ID_FIELD_NUMBER: builtins.int
START_TO_FIRE_TIMEOUT_FIELD_NUMBER: builtins.int
timer_id: builtins.str
"""An id for the timer, currently live timers must have different ids. Typically autogenerated
by the SDK.
"""
@property
def start_to_fire_timeout(self) -> google.protobuf.duration_pb2.Duration:
"""How long until the timer fires, producing a `TIMER_FIRED` event.
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: "to" is used to indicate interval. --)
"""
def __init__(
self,
*,
timer_id: builtins.str = ...,
start_to_fire_timeout: google.protobuf.duration_pb2.Duration | None = ...,
) -> None: ...
def HasField(
self,
field_name: typing_extensions.Literal[
"start_to_fire_timeout", b"start_to_fire_timeout"
],
) -> builtins.bool: ...
def ClearField(
self,
field_name: typing_extensions.Literal[
"start_to_fire_timeout", b"start_to_fire_timeout", "timer_id", b"timer_id"
],
) -> None: ...
global___StartTimerCommandAttributes = StartTimerCommandAttributes
class CompleteWorkflowExecutionCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
RESULT_FIELD_NUMBER: builtins.int
@property
def result(self) -> temporalio.api.common.v1.message_pb2.Payloads: ...
def __init__(
self,
*,
result: temporalio.api.common.v1.message_pb2.Payloads | None = ...,
) -> None: ...
def HasField(
self, field_name: typing_extensions.Literal["result", b"result"]
) -> builtins.bool: ...
def ClearField(
self, field_name: typing_extensions.Literal["result", b"result"]
) -> None: ...
global___CompleteWorkflowExecutionCommandAttributes = (
CompleteWorkflowExecutionCommandAttributes
)
class FailWorkflowExecutionCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
FAILURE_FIELD_NUMBER: builtins.int
@property
def failure(self) -> temporalio.api.failure.v1.message_pb2.Failure: ...
def __init__(
self,
*,
failure: temporalio.api.failure.v1.message_pb2.Failure | None = ...,
) -> None: ...
def HasField(
self, field_name: typing_extensions.Literal["failure", b"failure"]
) -> builtins.bool: ...
def ClearField(
self, field_name: typing_extensions.Literal["failure", b"failure"]
) -> None: ...
global___FailWorkflowExecutionCommandAttributes = FailWorkflowExecutionCommandAttributes
class CancelTimerCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
TIMER_ID_FIELD_NUMBER: builtins.int
timer_id: builtins.str
"""The same timer id from the start timer command"""
def __init__(
self,
*,
timer_id: builtins.str = ...,
) -> None: ...
def ClearField(
self, field_name: typing_extensions.Literal["timer_id", b"timer_id"]
) -> None: ...
global___CancelTimerCommandAttributes = CancelTimerCommandAttributes
class CancelWorkflowExecutionCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
DETAILS_FIELD_NUMBER: builtins.int
@property
def details(self) -> temporalio.api.common.v1.message_pb2.Payloads: ...
def __init__(
self,
*,
details: temporalio.api.common.v1.message_pb2.Payloads | None = ...,
) -> None: ...
def HasField(
self, field_name: typing_extensions.Literal["details", b"details"]
) -> builtins.bool: ...
def ClearField(
self, field_name: typing_extensions.Literal["details", b"details"]
) -> None: ...
global___CancelWorkflowExecutionCommandAttributes = (
CancelWorkflowExecutionCommandAttributes
)
class RequestCancelExternalWorkflowExecutionCommandAttributes(
google.protobuf.message.Message
):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
NAMESPACE_FIELD_NUMBER: builtins.int
WORKFLOW_ID_FIELD_NUMBER: builtins.int
RUN_ID_FIELD_NUMBER: builtins.int
CONTROL_FIELD_NUMBER: builtins.int
CHILD_WORKFLOW_ONLY_FIELD_NUMBER: builtins.int
REASON_FIELD_NUMBER: builtins.int
namespace: builtins.str
workflow_id: builtins.str
run_id: builtins.str
control: builtins.str
"""Deprecated."""
child_workflow_only: builtins.bool
"""Set this to true if the workflow being cancelled is a child of the workflow originating this
command. The request will be rejected if it is set to true and the target workflow is *not*
a child of the requesting workflow.
"""
reason: builtins.str
"""Reason for requesting the cancellation"""
def __init__(
self,
*,
namespace: builtins.str = ...,
workflow_id: builtins.str = ...,
run_id: builtins.str = ...,
control: builtins.str = ...,
child_workflow_only: builtins.bool = ...,
reason: builtins.str = ...,
) -> None: ...
def ClearField(
self,
field_name: typing_extensions.Literal[
"child_workflow_only",
b"child_workflow_only",
"control",
b"control",
"namespace",
b"namespace",
"reason",
b"reason",
"run_id",
b"run_id",
"workflow_id",
b"workflow_id",
],
) -> None: ...
global___RequestCancelExternalWorkflowExecutionCommandAttributes = (
RequestCancelExternalWorkflowExecutionCommandAttributes
)
class SignalExternalWorkflowExecutionCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
NAMESPACE_FIELD_NUMBER: builtins.int
EXECUTION_FIELD_NUMBER: builtins.int
SIGNAL_NAME_FIELD_NUMBER: builtins.int
INPUT_FIELD_NUMBER: builtins.int
CONTROL_FIELD_NUMBER: builtins.int
CHILD_WORKFLOW_ONLY_FIELD_NUMBER: builtins.int
HEADER_FIELD_NUMBER: builtins.int
namespace: builtins.str
@property
def execution(self) -> temporalio.api.common.v1.message_pb2.WorkflowExecution: ...
signal_name: builtins.str
"""The workflow author-defined name of the signal to send to the workflow."""
@property
def input(self) -> temporalio.api.common.v1.message_pb2.Payloads:
"""Serialized value(s) to provide with the signal."""
control: builtins.str
"""Deprecated"""
child_workflow_only: builtins.bool
"""Set this to true if the workflow being cancelled is a child of the workflow originating this
command. The request will be rejected if it is set to true and the target workflow is *not*
a child of the requesting workflow.
"""
@property
def header(self) -> temporalio.api.common.v1.message_pb2.Header:
"""Headers that are passed by the workflow that is sending a signal to the external
workflow that is receiving this signal.
"""
def __init__(
self,
*,
namespace: builtins.str = ...,
execution: temporalio.api.common.v1.message_pb2.WorkflowExecution | None = ...,
signal_name: builtins.str = ...,
input: temporalio.api.common.v1.message_pb2.Payloads | None = ...,
control: builtins.str = ...,
child_workflow_only: builtins.bool = ...,
header: temporalio.api.common.v1.message_pb2.Header | None = ...,
) -> None: ...
def HasField(
self,
field_name: typing_extensions.Literal[
"execution", b"execution", "header", b"header", "input", b"input"
],
) -> builtins.bool: ...
def ClearField(
self,
field_name: typing_extensions.Literal[
"child_workflow_only",
b"child_workflow_only",
"control",
b"control",
"execution",
b"execution",
"header",
b"header",
"input",
b"input",
"namespace",
b"namespace",
"signal_name",
b"signal_name",
],
) -> None: ...
global___SignalExternalWorkflowExecutionCommandAttributes = (
SignalExternalWorkflowExecutionCommandAttributes
)
class UpsertWorkflowSearchAttributesCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
SEARCH_ATTRIBUTES_FIELD_NUMBER: builtins.int
@property
def search_attributes(
self,
) -> temporalio.api.common.v1.message_pb2.SearchAttributes: ...
def __init__(
self,
*,
search_attributes: temporalio.api.common.v1.message_pb2.SearchAttributes
| None = ...,
) -> None: ...
def HasField(
self,
field_name: typing_extensions.Literal[
"search_attributes", b"search_attributes"
],
) -> builtins.bool: ...
def ClearField(
self,
field_name: typing_extensions.Literal[
"search_attributes", b"search_attributes"
],
) -> None: ...
global___UpsertWorkflowSearchAttributesCommandAttributes = (
UpsertWorkflowSearchAttributesCommandAttributes
)
class ModifyWorkflowPropertiesCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
UPSERTED_MEMO_FIELD_NUMBER: builtins.int
@property
def upserted_memo(self) -> temporalio.api.common.v1.message_pb2.Memo:
"""If set, update the workflow memo with the provided values. The values will be merged with
the existing memo. If the user wants to delete values, a default/empty Payload should be
used as the value for the key being deleted.
"""
def __init__(
self,
*,
upserted_memo: temporalio.api.common.v1.message_pb2.Memo | None = ...,
) -> None: ...
def HasField(
self, field_name: typing_extensions.Literal["upserted_memo", b"upserted_memo"]
) -> builtins.bool: ...
def ClearField(
self, field_name: typing_extensions.Literal["upserted_memo", b"upserted_memo"]
) -> None: ...
global___ModifyWorkflowPropertiesCommandAttributes = (
ModifyWorkflowPropertiesCommandAttributes
)
class RecordMarkerCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
class DetailsEntry(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
KEY_FIELD_NUMBER: builtins.int
VALUE_FIELD_NUMBER: builtins.int
key: builtins.str
@property
def value(self) -> temporalio.api.common.v1.message_pb2.Payloads: ...
def __init__(
self,
*,
key: builtins.str = ...,
value: temporalio.api.common.v1.message_pb2.Payloads | None = ...,
) -> None: ...
def HasField(
self, field_name: typing_extensions.Literal["value", b"value"]
) -> builtins.bool: ...
def ClearField(
self,
field_name: typing_extensions.Literal["key", b"key", "value", b"value"],
) -> None: ...
MARKER_NAME_FIELD_NUMBER: builtins.int
DETAILS_FIELD_NUMBER: builtins.int
HEADER_FIELD_NUMBER: builtins.int
FAILURE_FIELD_NUMBER: builtins.int
marker_name: builtins.str
@property
def details(
self,
) -> google.protobuf.internal.containers.MessageMap[
builtins.str, temporalio.api.common.v1.message_pb2.Payloads
]: ...
@property
def header(self) -> temporalio.api.common.v1.message_pb2.Header: ...
@property
def failure(self) -> temporalio.api.failure.v1.message_pb2.Failure: ...
def __init__(
self,
*,
marker_name: builtins.str = ...,
details: collections.abc.Mapping[
builtins.str, temporalio.api.common.v1.message_pb2.Payloads
]
| None = ...,
header: temporalio.api.common.v1.message_pb2.Header | None = ...,
failure: temporalio.api.failure.v1.message_pb2.Failure | None = ...,
) -> None: ...
def HasField(
self,
field_name: typing_extensions.Literal[
"failure", b"failure", "header", b"header"
],
) -> builtins.bool: ...
def ClearField(
self,
field_name: typing_extensions.Literal[
"details",
b"details",
"failure",
b"failure",
"header",
b"header",
"marker_name",
b"marker_name",
],
) -> None: ...
global___RecordMarkerCommandAttributes = RecordMarkerCommandAttributes
class ContinueAsNewWorkflowExecutionCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
WORKFLOW_TYPE_FIELD_NUMBER: builtins.int
TASK_QUEUE_FIELD_NUMBER: builtins.int
INPUT_FIELD_NUMBER: builtins.int
WORKFLOW_RUN_TIMEOUT_FIELD_NUMBER: builtins.int
WORKFLOW_TASK_TIMEOUT_FIELD_NUMBER: builtins.int
BACKOFF_START_INTERVAL_FIELD_NUMBER: builtins.int
RETRY_POLICY_FIELD_NUMBER: builtins.int
INITIATOR_FIELD_NUMBER: builtins.int
FAILURE_FIELD_NUMBER: builtins.int
LAST_COMPLETION_RESULT_FIELD_NUMBER: builtins.int
CRON_SCHEDULE_FIELD_NUMBER: builtins.int
HEADER_FIELD_NUMBER: builtins.int
MEMO_FIELD_NUMBER: builtins.int
SEARCH_ATTRIBUTES_FIELD_NUMBER: builtins.int
USE_COMPATIBLE_VERSION_FIELD_NUMBER: builtins.int
@property
def workflow_type(self) -> temporalio.api.common.v1.message_pb2.WorkflowType: ...
@property
def task_queue(self) -> temporalio.api.taskqueue.v1.message_pb2.TaskQueue: ...
@property
def input(self) -> temporalio.api.common.v1.message_pb2.Payloads: ...
@property
def workflow_run_timeout(self) -> google.protobuf.duration_pb2.Duration:
"""Timeout of a single workflow run."""
@property
def workflow_task_timeout(self) -> google.protobuf.duration_pb2.Duration:
"""Timeout of a single workflow task."""
@property
def backoff_start_interval(self) -> google.protobuf.duration_pb2.Duration:
"""How long the workflow start will be delayed - not really a "backoff" in the traditional sense."""
@property
def retry_policy(self) -> temporalio.api.common.v1.message_pb2.RetryPolicy: ...
initiator: temporalio.api.enums.v1.workflow_pb2.ContinueAsNewInitiator.ValueType
"""Should be removed"""
@property
def failure(self) -> temporalio.api.failure.v1.message_pb2.Failure:
"""Should be removed"""
@property
def last_completion_result(self) -> temporalio.api.common.v1.message_pb2.Payloads:
"""Should be removed"""
cron_schedule: builtins.str
"""Should be removed. Not necessarily unused but unclear and not exposed by SDKs."""
@property
def header(self) -> temporalio.api.common.v1.message_pb2.Header: ...
@property
def memo(self) -> temporalio.api.common.v1.message_pb2.Memo: ...
@property
def search_attributes(
self,
) -> temporalio.api.common.v1.message_pb2.SearchAttributes: ...
use_compatible_version: builtins.bool
"""If this is set, the workflow executing this command wishes to continue as new using a version
compatible with the version that this workflow most recently ran on.
"""
def __init__(
self,
*,
workflow_type: temporalio.api.common.v1.message_pb2.WorkflowType | None = ...,
task_queue: temporalio.api.taskqueue.v1.message_pb2.TaskQueue | None = ...,
input: temporalio.api.common.v1.message_pb2.Payloads | None = ...,
workflow_run_timeout: google.protobuf.duration_pb2.Duration | None = ...,
workflow_task_timeout: google.protobuf.duration_pb2.Duration | None = ...,
backoff_start_interval: google.protobuf.duration_pb2.Duration | None = ...,
retry_policy: temporalio.api.common.v1.message_pb2.RetryPolicy | None = ...,
initiator: temporalio.api.enums.v1.workflow_pb2.ContinueAsNewInitiator.ValueType = ...,
failure: temporalio.api.failure.v1.message_pb2.Failure | None = ...,
last_completion_result: temporalio.api.common.v1.message_pb2.Payloads
| None = ...,
cron_schedule: builtins.str = ...,
header: temporalio.api.common.v1.message_pb2.Header | None = ...,
memo: temporalio.api.common.v1.message_pb2.Memo | None = ...,
search_attributes: temporalio.api.common.v1.message_pb2.SearchAttributes
| None = ...,
use_compatible_version: builtins.bool = ...,
) -> None: ...
def HasField(
self,
field_name: typing_extensions.Literal[
"backoff_start_interval",
b"backoff_start_interval",
"failure",
b"failure",
"header",
b"header",
"input",
b"input",
"last_completion_result",
b"last_completion_result",
"memo",
b"memo",
"retry_policy",
b"retry_policy",
"search_attributes",
b"search_attributes",
"task_queue",
b"task_queue",
"workflow_run_timeout",
b"workflow_run_timeout",
"workflow_task_timeout",
b"workflow_task_timeout",
"workflow_type",
b"workflow_type",
],
) -> builtins.bool: ...
def ClearField(
self,
field_name: typing_extensions.Literal[
"backoff_start_interval",
b"backoff_start_interval",
"cron_schedule",
b"cron_schedule",
"failure",
b"failure",
"header",
b"header",
"initiator",
b"initiator",
"input",
b"input",
"last_completion_result",
b"last_completion_result",
"memo",
b"memo",
"retry_policy",
b"retry_policy",
"search_attributes",
b"search_attributes",
"task_queue",
b"task_queue",
"use_compatible_version",
b"use_compatible_version",
"workflow_run_timeout",
b"workflow_run_timeout",
"workflow_task_timeout",
b"workflow_task_timeout",
"workflow_type",
b"workflow_type",
],
) -> None: ...
global___ContinueAsNewWorkflowExecutionCommandAttributes = (
ContinueAsNewWorkflowExecutionCommandAttributes
)
class StartChildWorkflowExecutionCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
NAMESPACE_FIELD_NUMBER: builtins.int
WORKFLOW_ID_FIELD_NUMBER: builtins.int
WORKFLOW_TYPE_FIELD_NUMBER: builtins.int
TASK_QUEUE_FIELD_NUMBER: builtins.int
INPUT_FIELD_NUMBER: builtins.int
WORKFLOW_EXECUTION_TIMEOUT_FIELD_NUMBER: builtins.int
WORKFLOW_RUN_TIMEOUT_FIELD_NUMBER: builtins.int
WORKFLOW_TASK_TIMEOUT_FIELD_NUMBER: builtins.int
PARENT_CLOSE_POLICY_FIELD_NUMBER: builtins.int
CONTROL_FIELD_NUMBER: builtins.int
WORKFLOW_ID_REUSE_POLICY_FIELD_NUMBER: builtins.int
RETRY_POLICY_FIELD_NUMBER: builtins.int
CRON_SCHEDULE_FIELD_NUMBER: builtins.int
HEADER_FIELD_NUMBER: builtins.int
MEMO_FIELD_NUMBER: builtins.int
SEARCH_ATTRIBUTES_FIELD_NUMBER: builtins.int
USE_COMPATIBLE_VERSION_FIELD_NUMBER: builtins.int
namespace: builtins.str
workflow_id: builtins.str
@property
def workflow_type(self) -> temporalio.api.common.v1.message_pb2.WorkflowType: ...
@property
def task_queue(self) -> temporalio.api.taskqueue.v1.message_pb2.TaskQueue: ...
@property
def input(self) -> temporalio.api.common.v1.message_pb2.Payloads: ...
@property
def workflow_execution_timeout(self) -> google.protobuf.duration_pb2.Duration:
"""Total workflow execution timeout including retries and continue as new."""
@property
def workflow_run_timeout(self) -> google.protobuf.duration_pb2.Duration:
"""Timeout of a single workflow run."""
@property
def workflow_task_timeout(self) -> google.protobuf.duration_pb2.Duration:
"""Timeout of a single workflow task."""
parent_close_policy: temporalio.api.enums.v1.workflow_pb2.ParentClosePolicy.ValueType
"""Default: PARENT_CLOSE_POLICY_TERMINATE."""
control: builtins.str
workflow_id_reuse_policy: temporalio.api.enums.v1.workflow_pb2.WorkflowIdReusePolicy.ValueType
"""Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE."""
@property
def retry_policy(self) -> temporalio.api.common.v1.message_pb2.RetryPolicy: ...
cron_schedule: builtins.str
"""Establish a cron schedule for the child workflow."""
@property
def header(self) -> temporalio.api.common.v1.message_pb2.Header: ...
@property
def memo(self) -> temporalio.api.common.v1.message_pb2.Memo: ...
@property
def search_attributes(
self,
) -> temporalio.api.common.v1.message_pb2.SearchAttributes: ...
use_compatible_version: builtins.bool
"""If this is set, the workflow executing this command wishes to start the child workflow using
a version compatible with the version that this workflow most recently ran on, if such
behavior is possible.
"""
def __init__(
self,
*,
namespace: builtins.str = ...,
workflow_id: builtins.str = ...,
workflow_type: temporalio.api.common.v1.message_pb2.WorkflowType | None = ...,
task_queue: temporalio.api.taskqueue.v1.message_pb2.TaskQueue | None = ...,
input: temporalio.api.common.v1.message_pb2.Payloads | None = ...,
workflow_execution_timeout: google.protobuf.duration_pb2.Duration | None = ...,
workflow_run_timeout: google.protobuf.duration_pb2.Duration | None = ...,
workflow_task_timeout: google.protobuf.duration_pb2.Duration | None = ...,
parent_close_policy: temporalio.api.enums.v1.workflow_pb2.ParentClosePolicy.ValueType = ...,
control: builtins.str = ...,
workflow_id_reuse_policy: temporalio.api.enums.v1.workflow_pb2.WorkflowIdReusePolicy.ValueType = ...,
retry_policy: temporalio.api.common.v1.message_pb2.RetryPolicy | None = ...,
cron_schedule: builtins.str = ...,
header: temporalio.api.common.v1.message_pb2.Header | None = ...,
memo: temporalio.api.common.v1.message_pb2.Memo | None = ...,
search_attributes: temporalio.api.common.v1.message_pb2.SearchAttributes
| None = ...,
use_compatible_version: builtins.bool = ...,
) -> None: ...
def HasField(
self,
field_name: typing_extensions.Literal[
"header",
b"header",
"input",
b"input",
"memo",
b"memo",
"retry_policy",
b"retry_policy",
"search_attributes",
b"search_attributes",
"task_queue",
b"task_queue",
"workflow_execution_timeout",
b"workflow_execution_timeout",
"workflow_run_timeout",
b"workflow_run_timeout",
"workflow_task_timeout",
b"workflow_task_timeout",
"workflow_type",
b"workflow_type",
],
) -> builtins.bool: ...
def ClearField(
self,
field_name: typing_extensions.Literal[
"control",
b"control",
"cron_schedule",
b"cron_schedule",
"header",
b"header",
"input",
b"input",
"memo",
b"memo",
"namespace",
b"namespace",
"parent_close_policy",
b"parent_close_policy",
"retry_policy",
b"retry_policy",
"search_attributes",
b"search_attributes",
"task_queue",
b"task_queue",
"use_compatible_version",
b"use_compatible_version",
"workflow_execution_timeout",
b"workflow_execution_timeout",
"workflow_id",
b"workflow_id",
"workflow_id_reuse_policy",
b"workflow_id_reuse_policy",
"workflow_run_timeout",
b"workflow_run_timeout",
"workflow_task_timeout",
b"workflow_task_timeout",
"workflow_type",
b"workflow_type",
],
) -> None: ...
global___StartChildWorkflowExecutionCommandAttributes = (
StartChildWorkflowExecutionCommandAttributes
)
class ProtocolMessageCommandAttributes(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
MESSAGE_ID_FIELD_NUMBER: builtins.int
message_id: builtins.str
"""The message ID of the message to which this command is a pointer."""
def __init__(
self,
*,
message_id: builtins.str = ...,
) -> None: ...
def ClearField(
self, field_name: typing_extensions.Literal["message_id", b"message_id"]
) -> None: ...
global___ProtocolMessageCommandAttributes = ProtocolMessageCommandAttributes
class Command(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
COMMAND_TYPE_FIELD_NUMBER: builtins.int
SCHEDULE_ACTIVITY_TASK_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
START_TIMER_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
COMPLETE_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
FAIL_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
REQUEST_CANCEL_ACTIVITY_TASK_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
CANCEL_TIMER_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
CANCEL_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
RECORD_MARKER_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
CONTINUE_AS_NEW_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
START_CHILD_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
UPSERT_WORKFLOW_SEARCH_ATTRIBUTES_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
PROTOCOL_MESSAGE_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
MODIFY_WORKFLOW_PROPERTIES_COMMAND_ATTRIBUTES_FIELD_NUMBER: builtins.int
command_type: temporalio.api.enums.v1.command_type_pb2.CommandType.ValueType
@property
def schedule_activity_task_command_attributes(
self,
) -> global___ScheduleActivityTaskCommandAttributes: ...
@property
def start_timer_command_attributes(
self,
) -> global___StartTimerCommandAttributes: ...
@property
def complete_workflow_execution_command_attributes(
self,
) -> global___CompleteWorkflowExecutionCommandAttributes: ...
@property
def fail_workflow_execution_command_attributes(
self,
) -> global___FailWorkflowExecutionCommandAttributes: ...
@property
def request_cancel_activity_task_command_attributes(
self,
) -> global___RequestCancelActivityTaskCommandAttributes: ...
@property
def cancel_timer_command_attributes(
self,
) -> global___CancelTimerCommandAttributes: ...
@property
def cancel_workflow_execution_command_attributes(
self,
) -> global___CancelWorkflowExecutionCommandAttributes: ...
@property
def request_cancel_external_workflow_execution_command_attributes(
self,
) -> global___RequestCancelExternalWorkflowExecutionCommandAttributes: ...
@property
def record_marker_command_attributes(
self,
) -> global___RecordMarkerCommandAttributes: ...
@property
def continue_as_new_workflow_execution_command_attributes(
self,
) -> global___ContinueAsNewWorkflowExecutionCommandAttributes: ...
@property
def start_child_workflow_execution_command_attributes(
self,
) -> global___StartChildWorkflowExecutionCommandAttributes: ...
@property
def signal_external_workflow_execution_command_attributes(
self,
) -> global___SignalExternalWorkflowExecutionCommandAttributes: ...
@property
def upsert_workflow_search_attributes_command_attributes(
self,
) -> global___UpsertWorkflowSearchAttributesCommandAttributes: ...
@property
def protocol_message_command_attributes(
self,
) -> global___ProtocolMessageCommandAttributes: ...
@property
def modify_workflow_properties_command_attributes(
self,
) -> global___ModifyWorkflowPropertiesCommandAttributes:
"""16 is available for use - it was used as part of a prototype that never made it into a release"""
def __init__(
self,
*,
command_type: temporalio.api.enums.v1.command_type_pb2.CommandType.ValueType = ...,
schedule_activity_task_command_attributes: global___ScheduleActivityTaskCommandAttributes
| None = ...,
start_timer_command_attributes: global___StartTimerCommandAttributes
| None = ...,
complete_workflow_execution_command_attributes: global___CompleteWorkflowExecutionCommandAttributes
| None = ...,
fail_workflow_execution_command_attributes: global___FailWorkflowExecutionCommandAttributes
| None = ...,
request_cancel_activity_task_command_attributes: global___RequestCancelActivityTaskCommandAttributes
| None = ...,
cancel_timer_command_attributes: global___CancelTimerCommandAttributes
| None = ...,
cancel_workflow_execution_command_attributes: global___CancelWorkflowExecutionCommandAttributes
| None = ...,
request_cancel_external_workflow_execution_command_attributes: global___RequestCancelExternalWorkflowExecutionCommandAttributes
| None = ...,