-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
integrations_v1alpha.projects.locations.products.integrations.versions.html
8365 lines (8294 loc) · 698 KB
/
integrations_v1alpha.projects.locations.products.integrations.versions.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
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
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="integrations_v1alpha.html">Application Integration API</a> . <a href="integrations_v1alpha.projects.html">projects</a> . <a href="integrations_v1alpha.projects.locations.html">locations</a> . <a href="integrations_v1alpha.projects.locations.products.html">products</a> . <a href="integrations_v1alpha.projects.locations.products.integrations.html">integrations</a> . <a href="integrations_v1alpha.projects.locations.products.integrations.versions.html">versions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, createSampleIntegrations=None, newIntegration=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a integration with a draft version in the specified project.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.</p>
<p class="toc_element">
<code><a href="#download">download(name, fileFormat=None, files=None, x__xgafv=None)</a></code></p>
<p class="firstline">Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a integration in the specified project.</p>
<p class="toc_element">
<code><a href="#list">list(parent, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all integration versions in the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update a integration with a draft version in the specified project.</p>
<p class="toc_element">
<code><a href="#publish">publish(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.</p>
<p class="toc_element">
<code><a href="#takeoverEditLock">takeoverEditLock(integrationVersion, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.</p>
<p class="toc_element">
<code><a href="#unpublish">unpublish(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.</p>
<p class="toc_element">
<code><a href="#upload">upload(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, createSampleIntegrations=None, newIntegration=None, x__xgafv=None)</code>
<pre>Create a integration with a draft version in the specified project.
Args:
parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} (required)
body: object, The request body.
The object takes the form of:
{ # The integration version definition.
"cloudLoggingDetails": { # Cloud Logging details for execution info # Optional. Cloud Logging details for the integration version
"cloudLoggingSeverity": "A String", # Optional. Severity selected by the customer for the logs to be sent to Cloud Logging, for the integration version getting executed.
"enableCloudLogging": True or False, # Optional. Status of whether Cloud Logging is enabled or not for the integration version getting executed.
},
"createTime": "A String", # Output only. Auto-generated.
"databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
"description": "A String", # Optional. The integration description.
"enableVariableMasking": True or False, # Optional. True if variable masking feature should be turned on for this version
"errorCatcherConfigs": [ # Optional. Error Catch Task configuration for the integration. It's optional.
{ # Configuration detail of a error catch task
"description": "A String", # Optional. User-provided description intended to give more business context about the error catcher config.
"errorCatcherId": "A String", # Required. An error catcher id is string representation for the error catcher config. Within a workflow, error_catcher_id uniquely identifies an error catcher config among all error catcher configs for the workflow
"errorCatcherNumber": "A String", # Required. A number to uniquely identify each error catcher config within the workflow on UI.
"label": "A String", # Optional. The user created label for a particular error catcher. Optional.
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"startErrorTasks": [ # Required. The set of start tasks that are to be executed for the error catch flow
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
},
],
"integrationConfigParameters": [ # Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.
{ # Integration Config Parameter is defined in the integration config and are used to provide external configuration for integration. It provide information about data types of the expected parameters and provide any default values or value. They can also be used to add custom attributes.
"parameter": { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition. # Optional. Integration Parameter to provide the default value, data type and attributes required for the Integration config variables.
"containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
"dataType": "A String", # Type of the parameter.
"defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
"inputOutputType": "A String", # Specifies the input/output type for the parameter.
"isTransient": True or False, # Whether this parameter is a transient parameter.
"jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
"searchable": True or False, # Searchable in the execution log or not.
},
"value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
},
],
"integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
{ # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
"containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
"dataType": "A String", # Type of the parameter.
"defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
"displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
"inputOutputType": "A String", # Specifies the input/output type for the parameter.
"isTransient": True or False, # Whether this parameter is a transient parameter.
"jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
"searchable": True or False, # Searchable in the execution log or not.
},
],
"integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
"parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
{
"attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters.
"dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
"defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
"booleanValue": True or False,
"doubleArray": {
"values": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"values": [
"A String",
],
},
"intValue": "A String",
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"stringArray": {
"values": [
"A String",
],
},
"stringValue": "A String",
},
"isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
"logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See
"logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
"sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
"isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
"logType": [ # To which type(s) of logs the sanitize options apply.
"A String",
],
"privacy": "A String",
"sanitizeType": "A String",
},
"seedPeriod": "A String",
"seedScope": "A String",
"shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
"logAction": "A String",
"logType": [ # To which type(s) of logs the limits apply.
"A String",
],
"maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
"maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
"shortenerType": "A String",
},
},
"masked": True or False, # True if this workflow parameter should be masked in the logs
"readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not.
"searchable": "A String",
"taskVisibility": [ # List of tasks that can view this property, if empty then all.
"A String",
],
},
"children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
# Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
],
"containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
"dataType": "A String", # The data type of the parameter.
"defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"booleanArray": {
"booleanValues": [
True or False,
],
},
"booleanValue": True or False,
"doubleArray": {
"doubleValues": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"intValues": [
"A String",
],
},
"intValue": "A String",
"jsonValue": "A String",
"protoArray": {
"protoValues": [
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"serializedObjectValue": {
"objectValue": "A String",
},
"stringArray": {
"stringValues": [
"A String",
],
},
"stringValue": "A String",
},
"description": "A String", # Optional. The description about the parameter
"inOutType": "A String", # Specifies the input/output type for the parameter.
"isTransient": True or False, # Whether this parameter is a transient parameter.
"jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
"name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
"producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
"elementIdentifier": "A String", # Configuration of the edge.
"elementType": "A String", # Destination node where the edge ends. It can only be a task config.
},
"producer": "A String",
"protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
"protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
"required": True or False,
},
],
},
"lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"name": "A String", # Output only. Auto-generated primary key.
"origin": "A String", # Optional. The origin that indicates where this integration is coming from.
"parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
"runAsServiceAccount": "A String", # Optional. The run-as service account email, if set and auth config is not configured, that will be used to generate auth token to be used in Connector task, Rest caller task and Cloud function task.
"snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
"state": "A String", # Output only. User should not set it as an input.
"status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
"taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
{ # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String", # Optional. External task type of the task
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
"nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
"parameters": { # Optional. The customized parameters the user can pass to this task.
"a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
},
},
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
"maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"task": "A String", # Optional. The name for the task.
"taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
"taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
},
],
"taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
{ # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
"alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
{ # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event.
"aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
"alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
"alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
"clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
"durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
"errorEnumList": { # List of error enums for alerts.
"enumStrings": [
"A String",
],
"filterType": "A String",
},
"metricType": "A String",
"numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
"onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
"playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
"thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
"thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
"absolute": "A String",
"percentage": 42,
},
"warningEnumList": { # List of error enums for alerts.
"enumStrings": [
"A String",
],
"filterType": "A String",
},
},
],
"createTime": "A String", # Auto-generated.
"creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
"description": "A String", # User-provided description intended to give more business context about the task.
"disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
"errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"externalTaskType": "A String",
"failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
"jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
"label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
"lastModifiedTime": "A String", # Auto-generated.
"nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
{ # This message recursively combines constituent conditions using logical AND.
"conditions": [ # A set of individual constituent conditions.
{ # Condition that uses `operator` to evaluate the key against the value.
"eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
"operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
"value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
"booleanValue": True or False,
"doubleArray": {
"values": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"values": [
"A String",
],
},
"intValue": "A String",
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"stringArray": {
"values": [
"A String",
],
},
"stringValue": "A String",
},
},
],
},
],
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
"label": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskNumber": "A String", # Task number of the next task.
},
],
"nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
"parameters": { # The customized parameters the user can pass to this task.
"a_key": { # Key-value pair of EventBus parameters.
"dataType": "A String", # Explicitly getting the type of the parameter.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
"masked": True or False, # True if this parameter should be masked in the logs
"value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
"booleanArray": {
"booleanValues": [
True or False,
],
},
"booleanValue": True or False,
"doubleArray": {
"doubleValues": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"intValues": [
"A String",
],
},
"intValue": "A String",
"jsonValue": "A String",
"protoArray": {
"protoValues": [
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"serializedObjectValue": {
"objectValue": "A String",
},
"stringArray": {
"stringValues": [
"A String",
],
},
"stringValue": "A String",
},
},
},
"position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
"x": 42,
"y": 42,
},
"precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
"preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
"rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
"parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task.
"parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
{ # Key-value pair of EventBus parameters.
"dataType": "A String", # Explicitly getting the type of the parameter.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
"masked": True or False, # True if this parameter should be masked in the logs
"value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
"booleanArray": {
"booleanValues": [
True or False,
],
},
"booleanValue": True or False,
"doubleArray": {
"doubleValues": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"intValues": [
"A String",
],
},
"intValue": "A String",
"jsonValue": "A String",
"protoArray": {
"protoValues": [
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"serializedObjectValue": {
"objectValue": "A String",
},
"stringArray": {
"stringValues": [
"A String",
],
},
"stringValue": "A String",
},
},
],
},
"rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
"taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
"A String",
],
},
"successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
"finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
},
"synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
"intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
"maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
"retryStrategy": "A String", # Defines what happens to the task upon failure.
},
"taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
"disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
"metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on.
"activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
"admins": [
{ # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
"googleGroupEmail": "A String",
"userEmail": "A String",
},
],
"category": "A String",
"codeSearchLink": "A String", # The Code Search link to the Task Java file.
"defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
"defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
"description": "A String", # In a few sentences, describe the purpose and usage of the task.
"descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
"docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
"externalCategory": "A String",
"externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
"externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
"externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
"externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
"g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
"iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format.
"isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
"name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
"standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
"status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
"system": "A String",
"tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
"A String",
],
},
"paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
"parameters": [
{ # Key-value pair of EventBus task parameters. Next id: 13
"className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
"collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
"config": { # Optional fields, such as help text and other useful info.
"descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
"helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
"hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
"inputDisplayOption": "A String",
"isHidden": True or False, # Whether this field is hidden in the UI.
"label": "A String", # A user-friendly label for the parameter.
"parameterNameOption": "A String",
"subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
"uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
},
"dataType": "A String", # The data type of the parameter.
"defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
"booleanArray": {
"booleanValues": [
True or False,
],
},
"booleanValue": True or False,
"doubleArray": {
"doubleValues": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"intValues": [
"A String",
],
},
"intValue": "A String",
"jsonValue": "A String",
"protoArray": {
"protoValues": [
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"serializedObjectValue": {
"objectValue": "A String",
},
"stringArray": {
"stringValues": [
"A String",
],
},
"stringValue": "A String",
},
"isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
"isOutput": True or False,
"jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
"protoDef": { # Populated if this represents a proto or proto array.
"fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
"path": "A String", # Path to the proto file that contains the message type's definition.
},
"required": True or False, # If set, the user must provide an input value for this parameter.
"validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
"doubleRange": { # Range used to validate doubles and floats.
"max": 3.14, # The inclusive maximum of the acceptable range.
"min": 3.14, # The inclusive minimum of the acceptable range.
},
"intRange": { # Range used to validate longs and ints.
"max": "A String", # The inclusive maximum of the acceptable range.
"min": "A String", # The inclusive minimum of the acceptable range.
},
"stringRegex": { # Rule used to validate strings.
"exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
"regex": "A String", # The regex applied to the input value(s).
},
},
},
],
},
"stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
"dimensions": { # Dimensions that these stats have been aggregated on.
"clientId": "A String",
"enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
"errorEnumString": "A String",
"retryAttempt": "A String",
"taskName": "A String",
"taskNumber": "A String",
"triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
"warningEnumString": "A String",
"workflowId": "A String",
"workflowName": "A String",
},
"durationInSeconds": 3.14, # Average duration in seconds.
"errorRate": 3.14, # Average error rate.
"qps": 3.14, # Queries per second.
"warningRate": 3.14, # Average warning rate.
},
"taskType": "A String", # Defines the type of the task
"uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask.
"taskUiModuleConfigs": [ # Configurations of included config modules.
{ # Task author would use this type to configure a config module.
"moduleId": "A String", # ID of the config module.
},
],
},
},
"taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
"taskName": "A String", # The name for the task.
"taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
"taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field.
"taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
"taskType": "A String", # Defines the type of the task
},
],
"teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
"teardownTaskConfigs": [ # Required.
{
"creatorEmail": "A String", # The creator's email address.
"name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
"nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
"name": "A String", # Required. Name of the next teardown task.
},
"parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task.
"parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
{ # Key-value pair of EventBus parameters.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
"booleanArray": {
"booleanValues": [
True or False,
],
},
"booleanValue": True or False,
"doubleArray": {
"doubleValues": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"intValues": [
"A String",
],
},
"intValue": "A String",
"protoArray": {
"protoValues": [
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"serializedObjectValue": {
"objectValue": "A String",
},
"stringArray": {
"stringValues": [
"A String",
],
},
"stringValue": "A String",
},
},
],
},
"properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus.
"properties": [ # An unordered list of property entries.
{ # Key-value pair of EventBus property.
"key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
"value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
"booleanValue": True or False,
"doubleArray": {
"values": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"values": [
"A String",
],
},
"intValue": "A String",
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"stringArray": {
"values": [
"A String",
],
},
"stringValue": "A String",
},
},
],
},
"teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
},
],
},
"triggerConfigs": [ # Optional. Trigger configurations.
{ # Configuration detail of a trigger.
"alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
{ # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
"aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
"alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
"disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
"displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
"durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
"metricType": "A String", # The type of metric.
"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
"thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
"thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
"absolute": "A String", # Absolute value threshold.
"percentage": 42, # Percentage threshold.
},
},
],
"cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
"cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
"errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
"location": "A String", # Required. The location where associated cloud scheduler job will be created
"serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
},
"description": "A String", # Optional. User-provided description intended to give additional business context about the task.
"errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
"label": "A String", # Optional. The user created label for a particular trigger.
"nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
"position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
"x": 42, # Required. X axis of the coordinate
"y": 42, # Required. Y axis of the coordinate
},
"properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
"a_key": "A String",
},
"startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
{ # The task that is next in line to be executed, if the condition specified evaluated to true.
"condition": "A String", # Standard filter expression for this task to become an eligible next task.
"description": "A String", # User-provided description intended to give additional business context about the task.
"displayName": "A String", # User-provided label that is attached to this edge in the UI.
"taskConfigId": "A String", # ID of the next task.
"taskId": "A String", # Task number of the next task.
},
],
"trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
"triggerId": "A String", # Optional. The backend trigger ID.
"triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
"triggerType": "A String", # Optional. Type of trigger
},
],
"triggerConfigsInternal": [ # Optional. Trigger configurations.
{ # Configuration detail of a trigger. Next available id: 20
"alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
{ # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
"aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
"alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
"alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
"clientId": "A String", # Client associated with this alert configuration.
"durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
"errorEnumList": { # List of error enums for alerts.
"enumStrings": [
"A String",
],
"filterType": "A String",
},
"metricType": "A String",
"numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
"onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
"playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
"thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
"thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
"absolute": "A String",
"percentage": 42,
},
"warningEnumList": { # List of error enums for alerts.
"enumStrings": [
"A String",
],
"filterType": "A String",
},