@schemastore/workflows 0.0.5 → 0.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +22 -6
  2. package/index.d.ts +531 -1253
  3. package/package.json +4 -4
package/index.d.ts CHANGED
@@ -8,15 +8,26 @@
8
8
  /**
9
9
  * Orchestrate Workflows consisting of Google Cloud APIs, SaaS APIs or private API endpoints.
10
10
  */
11
- export type GoogleCloudWorkflowsConfigFile =
12
- | StepArray
11
+ export type GoogleCloudWorkflows =
13
12
  | {
14
- [k: string]: Subworkflow;
15
- };
13
+ main: {
14
+ /**
15
+ * The name of the parameter variable.
16
+ *
17
+ * @minItems 0
18
+ * @maxItems 1
19
+ */
20
+ params?: [] | [string];
21
+ steps?: StepArray;
22
+ };
23
+ [k: string]: SubworkflowUndefined;
24
+ }
25
+ | StepArray6;
16
26
  /**
17
- * A list of steps.
27
+ * An array of objects with a single step.
18
28
  *
19
29
  * @minItems 1
30
+ * @maxItems 100000
20
31
  */
21
32
  export type StepArray = [
22
33
  {
@@ -27,9 +38,44 @@ export type StepArray = [
27
38
  }[]
28
39
  ];
29
40
  /**
30
- * A list of steps to run in this switch statement.
41
+ * A list of variable assignment maps.
42
+ *
43
+ * @minItems 1
44
+ * @maxItems 50
45
+ */
46
+ export type Assign = [
47
+ {
48
+ [k: string]: unknown | undefined;
49
+ },
50
+ ...{
51
+ [k: string]: unknown | undefined;
52
+ }[]
53
+ ];
54
+ /**
55
+ * Run a function and return a result.
56
+ */
57
+ export type Call =
58
+ | ("http.get" | "http.post" | "http.put" | "http.patch" | "http.delete" | "http.request")
59
+ | ("sys.sleep" | "sys.sleep_until" | "sys.log")
60
+ | ("events.await_callback" | "events.create_callback_endpoint")
61
+ | string
62
+ | string;
63
+ /**
64
+ * Define what step Workflows should execute next.
65
+ */
66
+ export type Next = string | "end" | "continue" | "break";
67
+ /**
68
+ * A switch block. A selection mechanism that allows the value of an expression to control the flow of a workflow's execution. If a value matches, that condition's statement is executed.
69
+ *
70
+ * @minItems 1
71
+ * @maxItems 50
72
+ */
73
+ export type Switch = [Condition, ...Condition[]];
74
+ /**
75
+ * An array of objects with a single step.
31
76
  *
32
77
  * @minItems 1
78
+ * @maxItems 100000
33
79
  */
34
80
  export type StepArray1 = [
35
81
  {
@@ -40,10 +86,32 @@ export type StepArray1 = [
40
86
  }[]
41
87
  ];
42
88
  /**
43
- * Steps for loop
44
- * https://cloud.google.com/workflows/docs/reference/syntax/iteration
89
+ * Iterates over a sequence of numbers or through a collection of data, such as a list or map.
90
+ */
91
+ export type For = {
92
+ /**
93
+ * A loop variable name. Contains the value of the currently iterated element.
94
+ */
95
+ value: string;
96
+ /**
97
+ * An index variable name. Contains the value to the current offset of the iteration.
98
+ */
99
+ index?: string;
100
+ /**
101
+ * An expression that evaluates into a list or a list definition. Required, if not using 'range'.
102
+ */
103
+ in?: unknown[] | string;
104
+ /**
105
+ * A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
106
+ */
107
+ range?: [number, number] | string;
108
+ steps: StepArray2;
109
+ } & For1;
110
+ /**
111
+ * An array of objects with a single step.
45
112
  *
46
113
  * @minItems 1
114
+ * @maxItems 100000
47
115
  */
48
116
  export type StepArray2 = [
49
117
  {
@@ -53,10 +121,312 @@ export type StepArray2 = [
53
121
  [k: string]: Step;
54
122
  }[]
55
123
  ];
124
+ export type For1 =
125
+ | {
126
+ [k: string]: unknown | undefined;
127
+ }
128
+ | {
129
+ [k: string]: unknown | undefined;
130
+ };
131
+ /**
132
+ * Define a part of your workflow where two or more steps can execute concurrently. A 'parallel' step waits until all the steps defined within it have completed or are interrupted by an unhandled exception; execution then continues.
133
+ */
134
+ export type Parallel = {
135
+ /**
136
+ * The action for other branches when an exception occurs. Optional. The default policy, 'continueAll', results in no further action, and all other branches will attempt to run.
137
+ */
138
+ exception_policy?: "continueAll";
139
+ /**
140
+ * A list of writable variables with parent scope that allow assignments within the 'parallel' step.
141
+ */
142
+ shared?: string[];
143
+ /**
144
+ * The maximum number of branches and iterations that can concurrently execute within a single workflow execution before further branches and iterations are queued to wait. This applies to a single 'parallel' step only and does not cascade. Must be a positive integer and can be either a literal value or an expression.
145
+ */
146
+ concurrency_limit?: number;
147
+ branches?: Branches;
148
+ for?: For2;
149
+ } & Parallel1;
150
+ /**
151
+ * Branches that can run concurrently. Required, if not using 'for'.
152
+ *
153
+ * @minItems 2
154
+ * @maxItems 10
155
+ */
156
+ export type Branches =
157
+ | [
158
+ {
159
+ [k: string]: Step;
160
+ },
161
+ {
162
+ [k: string]: Step;
163
+ }
164
+ ]
165
+ | [
166
+ {
167
+ [k: string]: Step;
168
+ },
169
+ {
170
+ [k: string]: Step;
171
+ },
172
+ {
173
+ [k: string]: Step;
174
+ }
175
+ ]
176
+ | [
177
+ {
178
+ [k: string]: Step;
179
+ },
180
+ {
181
+ [k: string]: Step;
182
+ },
183
+ {
184
+ [k: string]: Step;
185
+ },
186
+ {
187
+ [k: string]: Step;
188
+ }
189
+ ]
190
+ | [
191
+ {
192
+ [k: string]: Step;
193
+ },
194
+ {
195
+ [k: string]: Step;
196
+ },
197
+ {
198
+ [k: string]: Step;
199
+ },
200
+ {
201
+ [k: string]: Step;
202
+ },
203
+ {
204
+ [k: string]: Step;
205
+ }
206
+ ]
207
+ | [
208
+ {
209
+ [k: string]: Step;
210
+ },
211
+ {
212
+ [k: string]: Step;
213
+ },
214
+ {
215
+ [k: string]: Step;
216
+ },
217
+ {
218
+ [k: string]: Step;
219
+ },
220
+ {
221
+ [k: string]: Step;
222
+ },
223
+ {
224
+ [k: string]: Step;
225
+ }
226
+ ]
227
+ | [
228
+ {
229
+ [k: string]: Step;
230
+ },
231
+ {
232
+ [k: string]: Step;
233
+ },
234
+ {
235
+ [k: string]: Step;
236
+ },
237
+ {
238
+ [k: string]: Step;
239
+ },
240
+ {
241
+ [k: string]: Step;
242
+ },
243
+ {
244
+ [k: string]: Step;
245
+ },
246
+ {
247
+ [k: string]: Step;
248
+ }
249
+ ]
250
+ | [
251
+ {
252
+ [k: string]: Step;
253
+ },
254
+ {
255
+ [k: string]: Step;
256
+ },
257
+ {
258
+ [k: string]: Step;
259
+ },
260
+ {
261
+ [k: string]: Step;
262
+ },
263
+ {
264
+ [k: string]: Step;
265
+ },
266
+ {
267
+ [k: string]: Step;
268
+ },
269
+ {
270
+ [k: string]: Step;
271
+ },
272
+ {
273
+ [k: string]: Step;
274
+ }
275
+ ]
276
+ | [
277
+ {
278
+ [k: string]: Step;
279
+ },
280
+ {
281
+ [k: string]: Step;
282
+ },
283
+ {
284
+ [k: string]: Step;
285
+ },
286
+ {
287
+ [k: string]: Step;
288
+ },
289
+ {
290
+ [k: string]: Step;
291
+ },
292
+ {
293
+ [k: string]: Step;
294
+ },
295
+ {
296
+ [k: string]: Step;
297
+ },
298
+ {
299
+ [k: string]: Step;
300
+ },
301
+ {
302
+ [k: string]: Step;
303
+ }
304
+ ]
305
+ | [
306
+ {
307
+ [k: string]: Step;
308
+ },
309
+ {
310
+ [k: string]: Step;
311
+ },
312
+ {
313
+ [k: string]: Step;
314
+ },
315
+ {
316
+ [k: string]: Step;
317
+ },
318
+ {
319
+ [k: string]: Step;
320
+ },
321
+ {
322
+ [k: string]: Step;
323
+ },
324
+ {
325
+ [k: string]: Step;
326
+ },
327
+ {
328
+ [k: string]: Step;
329
+ },
330
+ {
331
+ [k: string]: Step;
332
+ },
333
+ {
334
+ [k: string]: Step;
335
+ }
336
+ ];
337
+ /**
338
+ * Iterates over a sequence of numbers or through a collection of data, such as a list or map.
339
+ */
340
+ export type For2 = {
341
+ /**
342
+ * A loop variable name. Contains the value of the currently iterated element.
343
+ */
344
+ value: string;
345
+ /**
346
+ * An index variable name. Contains the value to the current offset of the iteration.
347
+ */
348
+ index?: string;
349
+ /**
350
+ * An expression that evaluates into a list or a list definition. Required, if not using 'range'.
351
+ */
352
+ in?: unknown[] | string;
353
+ /**
354
+ * A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
355
+ */
356
+ range?: [number, number] | string;
357
+ steps: StepArray2;
358
+ } & (
359
+ | {
360
+ [k: string]: unknown | undefined;
361
+ }
362
+ | {
363
+ [k: string]: unknown | undefined;
364
+ }
365
+ );
366
+ export type Parallel1 =
367
+ | {
368
+ [k: string]: unknown | undefined;
369
+ }
370
+ | {
371
+ [k: string]: unknown | undefined;
372
+ };
373
+ /**
374
+ * Raise an exception.
375
+ */
376
+ export type Raise =
377
+ | string
378
+ | {
379
+ /**
380
+ * Error code.
381
+ */
382
+ code?: number;
383
+ /**
384
+ * Error message string.
385
+ */
386
+ message?: string;
387
+ [k: string]: unknown | undefined;
388
+ };
389
+ /**
390
+ * A try/except structure for error handling.
391
+ */
392
+ export type Try = Step1 | StepArray4;
393
+ /**
394
+ * Define a retry policy to retry steps that return a specific error code.
395
+ */
396
+ export type Retry =
397
+ | {
398
+ /**
399
+ * Defines which error codes will be retried. Options include ${http.default_retry_predicate}, ${http.default_retry_predicate_non_idempotent}, or a custom predicate defined as a subworkflow.
400
+ */
401
+ predicate?: string;
402
+ /**
403
+ * Maximum number of times a step will be retried, not counting the initial step execution attempt.
404
+ */
405
+ max_retries?: number;
406
+ /**
407
+ * Block that controls how retries occur.
408
+ */
409
+ backoff?: {
410
+ /**
411
+ * Delay in seconds between the initial failure and the first retry.
412
+ */
413
+ initial_delay?: number;
414
+ /**
415
+ * Maximum delay in seconds between retries.
416
+ */
417
+ max_delay?: number;
418
+ /**
419
+ * Multiplier applied to the previous delay to calculate the delay for the subsequent retry.
420
+ */
421
+ multiplier?: number;
422
+ };
423
+ }
424
+ | string;
56
425
  /**
57
- * A list of steps
426
+ * An array of objects with a single step.
58
427
  *
59
428
  * @minItems 1
429
+ * @maxItems 100000
60
430
  */
61
431
  export type StepArray3 = [
62
432
  {
@@ -70,6 +440,7 @@ export type StepArray3 = [
70
440
  * An array of objects with a single step.
71
441
  *
72
442
  * @minItems 1
443
+ * @maxItems 100000
73
444
  */
74
445
  export type StepArray4 = [
75
446
  {
@@ -83,6 +454,7 @@ export type StepArray4 = [
83
454
  * An array of objects with a single step.
84
455
  *
85
456
  * @minItems 1
457
+ * @maxItems 100000
86
458
  */
87
459
  export type StepArray5 = [
88
460
  {
@@ -92,6 +464,20 @@ export type StepArray5 = [
92
464
  [k: string]: Step;
93
465
  }[]
94
466
  ];
467
+ /**
468
+ * An array of objects with a single step.
469
+ *
470
+ * @minItems 1
471
+ * @maxItems 100000
472
+ */
473
+ export type StepArray6 = [
474
+ {
475
+ [k: string]: Step;
476
+ },
477
+ ...{
478
+ [k: string]: Step;
479
+ }[]
480
+ ];
95
481
 
96
482
  /**
97
483
  * A single workflow step.
@@ -100,1311 +486,203 @@ export type StepArray5 = [
100
486
  * via the `patternProperty` "^.*$".
101
487
  */
102
488
  export interface Step {
489
+ assign?: Assign;
490
+ call?: Call;
491
+ args?: Args;
492
+ result?: Result;
493
+ next?: Next;
494
+ switch?: Switch;
495
+ for?: For1;
496
+ parallel?: Parallel1;
497
+ raise?: Raise;
498
+ try?: Try;
499
+ retry?: Retry;
500
+ except?: Except;
501
+ return?: Return;
502
+ steps?: StepArray1;
503
+ }
504
+ /**
505
+ * Pass arguments and their values when calling a function that accepts parameters.
506
+ */
507
+ export interface Args {
508
+ url?: string | string;
103
509
  /**
104
- * Required
105
- */
106
- call?: ("http.get" | "http.post" | "http.request" | "sys.sleep") | string;
107
- /**
108
- * Arguments to a workflow step.
109
- */
110
- args?: {
111
- url?: string | string;
112
- /**
113
- * Required if using call type http.request. The type of HTTP request method to use.
114
- */
115
- method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
116
- /**
117
- * Request headers.
118
- */
119
- headers?: {
120
- [k: string]: unknown;
121
- };
122
- /**
123
- * Request body.
124
- */
125
- body?: {
126
- [k: string]: unknown;
127
- };
128
- /**
129
- * Request query parameters.
130
- */
131
- query?: {
132
- [k: string]: unknown;
133
- };
134
- /**
135
- * Required if the API being called requires authentication.
136
- */
137
- auth?: {
138
- /**
139
- * The type of authentication.
140
- */
141
- type?: "OIDC" | "OAuth2";
142
- };
143
- /**
144
- * Time in seconds. How long a request is allowed to run before throwing an exception.
145
- */
146
- timeout?: number;
147
- /**
148
- * The number of seconds to sleep.
149
- */
150
- seconds?: number;
151
- };
152
- /**
153
- * Define a dictionary.
154
- */
155
- assign?: {
156
- [k: string]: unknown;
157
- }[];
158
- /**
159
- * Variable name where the result of an HTTP invocation step is stored.
160
- */
161
- result?: string;
162
- /**
163
- * A switch block.
164
- */
165
- switch?: {
166
- /**
167
- * An expression to switch on.
168
- */
169
- condition: string;
170
- /**
171
- * The next step to jump to. "end" to terminate.
172
- */
173
- next?: string;
174
- steps?: StepArray1;
175
- /**
176
- * Stop a workflow's execution and return a value, variable, or expression.
177
- */
178
- return?: {
179
- [k: string]: unknown;
180
- };
181
- /**
182
- * Raise an exception.
183
- */
184
- raise?:
185
- | string
186
- | {
187
- [k: string]: unknown;
188
- };
189
- }[];
190
- /**
191
- * The next step to jump to. "end" to terminate.
510
+ * The type of HTTP request method to use. Required if using call type http.request.
192
511
  */
193
- next?: string;
512
+ method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
194
513
  /**
195
- * Stop a workflow's execution and return a value, variable, or expression.
514
+ * Header fields to supply input to the API.
196
515
  */
197
- return?: {
198
- [k: string]: unknown;
516
+ headers?: {
517
+ [k: string]: unknown | undefined;
199
518
  };
200
- try?: Step1;
201
519
  /**
202
- * Optional. If omitted, all other fields are required. Options include ${http.default_retry} and ${http.default_retry_non_idempotent}. Allows you to specify a default retry policy to use. If you specify a retry policy, omit all other fields in the retry block.
520
+ * Body fields to supply input to the API.
203
521
  */
204
- retry?: {
205
- /**
206
- * Required if you don't select a default retry policy. Defines which error codes will be retried. Options include ${http.default_retry_predicate}, ${http.default_retry_predicate_non_idempotent}, or a custom predicate defined as a subworkflow.
207
- */
208
- predicate?: string;
209
- /**
210
- * Maximum number of times a step will be retried.
211
- */
212
- max_retries?: number;
213
- /**
214
- * Block that controls how retries occur.
215
- */
216
- backoff?: {
217
- /**
218
- * Delay in seconds between the initial failure and the first retry.
219
- */
220
- initial_delay?: number;
221
- /**
222
- * Maximum delay in seconds between retries.
223
- */
224
- max_delay?: number;
225
- /**
226
- * Multiplier applied to the previous delay to calculate the delay for the subsequent retry.
227
- */
228
- multiplier?: number;
229
- };
230
- };
231
- /**
232
- * Except a try clause.
233
- */
234
- except?:
235
- | Step2
522
+ body?:
236
523
  | {
237
- /**
238
- * Name of a dictionary variable that contains the error message.
239
- */
240
- as?: string;
241
- steps?: StepArray4;
242
- };
524
+ [k: string]: unknown | undefined;
525
+ }
526
+ | null
527
+ | string
528
+ | string;
243
529
  /**
244
- * Raise an exception.
530
+ * Query fields to supply input to the API.
245
531
  */
246
- raise?:
247
- | string
532
+ query?:
248
533
  | {
249
- [k: string]: unknown;
250
- };
251
- for?: For;
534
+ [k: string]: unknown | undefined;
535
+ }
536
+ | string;
252
537
  /**
253
- * Run branches or iterations in parallel
538
+ * Required if the API being called requires authentication.
254
539
  */
255
- parallel?: {
540
+ auth?: {
256
541
  /**
257
- * The action for other branches when an exception occurs
542
+ * The type of authentication.
258
543
  */
259
- exception_policy?: "continueAll";
544
+ type?: "OIDC" | "OAuth2";
260
545
  /**
261
- * A list of shared variables
546
+ * Specify token scope to limit an application's access to a user's account.
262
547
  */
263
- shared?: string[];
548
+ scope?: unknown[] | string;
264
549
  /**
265
- * An upper limit for branches/iterations to perform concurrently
550
+ * Specify token scope to limit an application's access to a user's account.
266
551
  */
267
- concurrency_limit?: number;
552
+ scopes?: unknown[] | string | string;
268
553
  /**
269
- * A list of branches that will run concurrently
270
- *
271
- * @minItems 2
272
- * @maxItems 10
554
+ * Specifies the audience for the OIDC token. By default, it's set to the same value as url; however, it should be set to your service's root URL.
273
555
  */
274
- branches?:
275
- | [
276
- {
277
- steps?: StepArray3;
278
- [k: string]: unknown;
279
- },
280
- {
281
- steps?: StepArray3;
282
- [k: string]: unknown;
283
- }
284
- ]
285
- | [
286
- {
287
- steps?: StepArray3;
288
- [k: string]: unknown;
289
- },
290
- {
291
- steps?: StepArray3;
292
- [k: string]: unknown;
293
- },
294
- {
295
- steps?: StepArray3;
296
- [k: string]: unknown;
297
- }
298
- ]
299
- | [
300
- {
301
- steps?: StepArray3;
302
- [k: string]: unknown;
303
- },
304
- {
305
- steps?: StepArray3;
306
- [k: string]: unknown;
307
- },
308
- {
309
- steps?: StepArray3;
310
- [k: string]: unknown;
311
- },
312
- {
313
- steps?: StepArray3;
314
- [k: string]: unknown;
315
- }
316
- ]
317
- | [
318
- {
319
- steps?: StepArray3;
320
- [k: string]: unknown;
321
- },
322
- {
323
- steps?: StepArray3;
324
- [k: string]: unknown;
325
- },
326
- {
327
- steps?: StepArray3;
328
- [k: string]: unknown;
329
- },
330
- {
331
- steps?: StepArray3;
332
- [k: string]: unknown;
333
- },
334
- {
335
- steps?: StepArray3;
336
- [k: string]: unknown;
337
- }
338
- ]
339
- | [
340
- {
341
- steps?: StepArray3;
342
- [k: string]: unknown;
343
- },
344
- {
345
- steps?: StepArray3;
346
- [k: string]: unknown;
347
- },
348
- {
349
- steps?: StepArray3;
350
- [k: string]: unknown;
351
- },
352
- {
353
- steps?: StepArray3;
354
- [k: string]: unknown;
355
- },
356
- {
357
- steps?: StepArray3;
358
- [k: string]: unknown;
359
- },
360
- {
361
- steps?: StepArray3;
362
- [k: string]: unknown;
363
- }
364
- ]
365
- | [
366
- {
367
- steps?: StepArray3;
368
- [k: string]: unknown;
369
- },
370
- {
371
- steps?: StepArray3;
372
- [k: string]: unknown;
373
- },
374
- {
375
- steps?: StepArray3;
376
- [k: string]: unknown;
377
- },
378
- {
379
- steps?: StepArray3;
380
- [k: string]: unknown;
381
- },
382
- {
383
- steps?: StepArray3;
384
- [k: string]: unknown;
385
- },
386
- {
387
- steps?: StepArray3;
388
- [k: string]: unknown;
389
- },
390
- {
391
- steps?: StepArray3;
392
- [k: string]: unknown;
393
- }
394
- ]
395
- | [
396
- {
397
- steps?: StepArray3;
398
- [k: string]: unknown;
399
- },
400
- {
401
- steps?: StepArray3;
402
- [k: string]: unknown;
403
- },
404
- {
405
- steps?: StepArray3;
406
- [k: string]: unknown;
407
- },
408
- {
409
- steps?: StepArray3;
410
- [k: string]: unknown;
411
- },
412
- {
413
- steps?: StepArray3;
414
- [k: string]: unknown;
415
- },
416
- {
417
- steps?: StepArray3;
418
- [k: string]: unknown;
419
- },
420
- {
421
- steps?: StepArray3;
422
- [k: string]: unknown;
423
- },
424
- {
425
- steps?: StepArray3;
426
- [k: string]: unknown;
427
- }
428
- ]
429
- | [
430
- {
431
- steps?: StepArray3;
432
- [k: string]: unknown;
433
- },
434
- {
435
- steps?: StepArray3;
436
- [k: string]: unknown;
437
- },
438
- {
439
- steps?: StepArray3;
440
- [k: string]: unknown;
441
- },
442
- {
443
- steps?: StepArray3;
444
- [k: string]: unknown;
445
- },
446
- {
447
- steps?: StepArray3;
448
- [k: string]: unknown;
449
- },
450
- {
451
- steps?: StepArray3;
452
- [k: string]: unknown;
453
- },
454
- {
455
- steps?: StepArray3;
456
- [k: string]: unknown;
457
- },
458
- {
459
- steps?: StepArray3;
460
- [k: string]: unknown;
461
- },
462
- {
463
- steps?: StepArray3;
464
- [k: string]: unknown;
465
- }
466
- ]
467
- | [
468
- {
469
- steps?: StepArray3;
470
- [k: string]: unknown;
471
- },
472
- {
473
- steps?: StepArray3;
474
- [k: string]: unknown;
475
- },
476
- {
477
- steps?: StepArray3;
478
- [k: string]: unknown;
479
- },
480
- {
481
- steps?: StepArray3;
482
- [k: string]: unknown;
483
- },
484
- {
485
- steps?: StepArray3;
486
- [k: string]: unknown;
487
- },
488
- {
489
- steps?: StepArray3;
490
- [k: string]: unknown;
491
- },
492
- {
493
- steps?: StepArray3;
494
- [k: string]: unknown;
495
- },
496
- {
497
- steps?: StepArray3;
498
- [k: string]: unknown;
499
- },
500
- {
501
- steps?: StepArray3;
502
- [k: string]: unknown;
503
- },
504
- {
505
- steps?: StepArray3;
506
- [k: string]: unknown;
507
- }
508
- ];
509
- for?: For1;
556
+ audience?: string | string;
510
557
  };
511
- }
512
- /**
513
- * Try a single step or a list of steps.
514
- */
515
- export interface Step1 {
516
558
  /**
517
- * Required
559
+ * Time in seconds. How long a request is allowed to run before throwing an exception. Default and maximum values vary by call.
518
560
  */
519
- call?: ("http.get" | "http.post" | "http.request" | "sys.sleep") | string;
561
+ timeout?: number;
520
562
  /**
521
- * Arguments to a workflow step.
563
+ * Connector-specific parameters.
522
564
  */
523
- args?: {
524
- url?: string | string;
525
- /**
526
- * Required if using call type http.request. The type of HTTP request method to use.
527
- */
528
- method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
529
- /**
530
- * Request headers.
531
- */
532
- headers?: {
533
- [k: string]: unknown;
534
- };
535
- /**
536
- * Request body.
537
- */
538
- body?: {
539
- [k: string]: unknown;
540
- };
541
- /**
542
- * Request query parameters.
543
- */
544
- query?: {
545
- [k: string]: unknown;
546
- };
547
- /**
548
- * Required if the API being called requires authentication.
549
- */
550
- auth?: {
551
- /**
552
- * The type of authentication.
553
- */
554
- type?: "OIDC" | "OAuth2";
555
- };
565
+ connector_params?: {
556
566
  /**
557
- * Time in seconds. How long a request is allowed to run before throwing an exception.
567
+ * Time in seconds. The end-to-end duration the connector call is allowed to run for before throwing a timeout exception.
558
568
  */
559
569
  timeout?: number;
560
570
  /**
561
- * The number of seconds to sleep.
562
- */
563
- seconds?: number;
564
- };
565
- /**
566
- * Define a dictionary.
567
- */
568
- assign?: {
569
- [k: string]: unknown;
570
- }[];
571
- /**
572
- * Variable name where the result of an HTTP invocation step is stored.
573
- */
574
- result?: string;
575
- /**
576
- * A switch block.
577
- */
578
- switch?: {
579
- /**
580
- * An expression to switch on.
581
- */
582
- condition: string;
583
- /**
584
- * The next step to jump to. "end" to terminate.
571
+ * Polling policy.
585
572
  */
586
- next?: string;
587
- steps?: StepArray1;
588
- /**
589
- * Stop a workflow's execution and return a value, variable, or expression.
590
- */
591
- return?: {
592
- [k: string]: unknown;
593
- };
594
- /**
595
- * Raise an exception.
596
- */
597
- raise?:
598
- | string
599
- | {
600
- [k: string]: unknown;
601
- };
602
- }[];
603
- /**
604
- * The next step to jump to. "end" to terminate.
605
- */
606
- next?: string;
607
- /**
608
- * Stop a workflow's execution and return a value, variable, or expression.
609
- */
610
- return?: {
611
- [k: string]: unknown;
612
- };
613
- try?: Step1;
614
- /**
615
- * Optional. If omitted, all other fields are required. Options include ${http.default_retry} and ${http.default_retry_non_idempotent}. Allows you to specify a default retry policy to use. If you specify a retry policy, omit all other fields in the retry block.
616
- */
617
- retry?: {
618
- /**
619
- * Required if you don't select a default retry policy. Defines which error codes will be retried. Options include ${http.default_retry_predicate}, ${http.default_retry_predicate_non_idempotent}, or a custom predicate defined as a subworkflow.
620
- */
621
- predicate?: string;
622
- /**
623
- * Maximum number of times a step will be retried.
624
- */
625
- max_retries?: number;
626
- /**
627
- * Block that controls how retries occur.
628
- */
629
- backoff?: {
573
+ polling_policy?: {
630
574
  /**
631
- * Delay in seconds between the initial failure and the first retry.
575
+ * Time in seconds. Only applies to long-running operation calls.
632
576
  */
633
577
  initial_delay?: number;
634
578
  /**
635
- * Maximum delay in seconds between retries.
579
+ * Time in seconds. Only applies to long-running operation calls.
636
580
  */
637
- max_delay?: number;
581
+ multiplier?: number;
638
582
  /**
639
- * Multiplier applied to the previous delay to calculate the delay for the subsequent retry.
583
+ * Time in seconds. Only applies to long-running operation calls.
640
584
  */
641
- multiplier?: number;
585
+ max_delay?: number;
586
+ [k: string]: unknown | undefined;
642
587
  };
643
- };
644
- /**
645
- * Except a try clause.
646
- */
647
- except?:
648
- | Step2
649
- | {
650
- /**
651
- * Name of a dictionary variable that contains the error message.
652
- */
653
- as?: string;
654
- steps?: StepArray4;
655
- };
656
- /**
657
- * Raise an exception.
658
- */
659
- raise?:
660
- | string
661
- | {
662
- [k: string]: unknown;
663
- };
664
- for?: For;
665
- /**
666
- * Run branches or iterations in parallel
667
- */
668
- parallel?: {
669
- /**
670
- * The action for other branches when an exception occurs
671
- */
672
- exception_policy?: "continueAll";
673
- /**
674
- * A list of shared variables
675
- */
676
- shared?: string[];
677
588
  /**
678
- * An upper limit for branches/iterations to perform concurrently
589
+ * If set to True, the connector invocation call is non-blocking if the initial request to manage or update the resource succeeds
679
590
  */
680
- concurrency_limit?: number;
591
+ skip_polling?: boolean;
681
592
  /**
682
- * A list of branches that will run concurrently
683
- *
684
- * @minItems 2
685
- * @maxItems 10
593
+ * OAuth2 scopes to pass to the Google API.
686
594
  */
687
- branches?:
688
- | [
689
- {
690
- steps?: StepArray3;
691
- [k: string]: unknown;
692
- },
693
- {
694
- steps?: StepArray3;
695
- [k: string]: unknown;
696
- }
697
- ]
698
- | [
699
- {
700
- steps?: StepArray3;
701
- [k: string]: unknown;
702
- },
703
- {
704
- steps?: StepArray3;
705
- [k: string]: unknown;
706
- },
707
- {
708
- steps?: StepArray3;
709
- [k: string]: unknown;
710
- }
711
- ]
712
- | [
713
- {
714
- steps?: StepArray3;
715
- [k: string]: unknown;
716
- },
717
- {
718
- steps?: StepArray3;
719
- [k: string]: unknown;
720
- },
721
- {
722
- steps?: StepArray3;
723
- [k: string]: unknown;
724
- },
725
- {
726
- steps?: StepArray3;
727
- [k: string]: unknown;
728
- }
729
- ]
730
- | [
731
- {
732
- steps?: StepArray3;
733
- [k: string]: unknown;
734
- },
735
- {
736
- steps?: StepArray3;
737
- [k: string]: unknown;
738
- },
739
- {
740
- steps?: StepArray3;
741
- [k: string]: unknown;
742
- },
743
- {
744
- steps?: StepArray3;
745
- [k: string]: unknown;
746
- },
747
- {
748
- steps?: StepArray3;
749
- [k: string]: unknown;
750
- }
751
- ]
752
- | [
753
- {
754
- steps?: StepArray3;
755
- [k: string]: unknown;
756
- },
757
- {
758
- steps?: StepArray3;
759
- [k: string]: unknown;
760
- },
761
- {
762
- steps?: StepArray3;
763
- [k: string]: unknown;
764
- },
765
- {
766
- steps?: StepArray3;
767
- [k: string]: unknown;
768
- },
769
- {
770
- steps?: StepArray3;
771
- [k: string]: unknown;
772
- },
773
- {
774
- steps?: StepArray3;
775
- [k: string]: unknown;
776
- }
777
- ]
778
- | [
779
- {
780
- steps?: StepArray3;
781
- [k: string]: unknown;
782
- },
783
- {
784
- steps?: StepArray3;
785
- [k: string]: unknown;
786
- },
787
- {
788
- steps?: StepArray3;
789
- [k: string]: unknown;
790
- },
791
- {
792
- steps?: StepArray3;
793
- [k: string]: unknown;
794
- },
795
- {
796
- steps?: StepArray3;
797
- [k: string]: unknown;
798
- },
799
- {
800
- steps?: StepArray3;
801
- [k: string]: unknown;
802
- },
803
- {
804
- steps?: StepArray3;
805
- [k: string]: unknown;
806
- }
807
- ]
808
- | [
809
- {
810
- steps?: StepArray3;
811
- [k: string]: unknown;
812
- },
813
- {
814
- steps?: StepArray3;
815
- [k: string]: unknown;
816
- },
817
- {
818
- steps?: StepArray3;
819
- [k: string]: unknown;
820
- },
821
- {
822
- steps?: StepArray3;
823
- [k: string]: unknown;
824
- },
825
- {
826
- steps?: StepArray3;
827
- [k: string]: unknown;
828
- },
829
- {
830
- steps?: StepArray3;
831
- [k: string]: unknown;
832
- },
833
- {
834
- steps?: StepArray3;
835
- [k: string]: unknown;
836
- },
837
- {
838
- steps?: StepArray3;
839
- [k: string]: unknown;
840
- }
841
- ]
842
- | [
843
- {
844
- steps?: StepArray3;
845
- [k: string]: unknown;
846
- },
847
- {
848
- steps?: StepArray3;
849
- [k: string]: unknown;
850
- },
851
- {
852
- steps?: StepArray3;
853
- [k: string]: unknown;
854
- },
855
- {
856
- steps?: StepArray3;
857
- [k: string]: unknown;
858
- },
859
- {
860
- steps?: StepArray3;
861
- [k: string]: unknown;
862
- },
863
- {
864
- steps?: StepArray3;
865
- [k: string]: unknown;
866
- },
867
- {
868
- steps?: StepArray3;
869
- [k: string]: unknown;
870
- },
871
- {
872
- steps?: StepArray3;
873
- [k: string]: unknown;
874
- },
875
- {
876
- steps?: StepArray3;
877
- [k: string]: unknown;
878
- }
879
- ]
880
- | [
881
- {
882
- steps?: StepArray3;
883
- [k: string]: unknown;
884
- },
885
- {
886
- steps?: StepArray3;
887
- [k: string]: unknown;
888
- },
889
- {
890
- steps?: StepArray3;
891
- [k: string]: unknown;
892
- },
893
- {
894
- steps?: StepArray3;
895
- [k: string]: unknown;
896
- },
897
- {
898
- steps?: StepArray3;
899
- [k: string]: unknown;
900
- },
901
- {
902
- steps?: StepArray3;
903
- [k: string]: unknown;
904
- },
905
- {
906
- steps?: StepArray3;
907
- [k: string]: unknown;
908
- },
909
- {
910
- steps?: StepArray3;
911
- [k: string]: unknown;
912
- },
913
- {
914
- steps?: StepArray3;
915
- [k: string]: unknown;
916
- },
917
- {
918
- steps?: StepArray3;
919
- [k: string]: unknown;
920
- }
921
- ];
922
- for?: For1;
595
+ scopes?: unknown[] | string | string;
596
+ [k: string]: unknown | undefined;
923
597
  };
598
+ [k: string]: unknown | undefined;
924
599
  }
925
600
  /**
926
- * A single workflow step.
601
+ * Assign the result from a call to this variable.
927
602
  */
928
- export interface Step2 {
929
- /**
930
- * Required
931
- */
932
- call?: ("http.get" | "http.post" | "http.request" | "sys.sleep") | string;
933
- /**
934
- * Arguments to a workflow step.
935
- */
936
- args?: {
937
- url?: string | string;
938
- /**
939
- * Required if using call type http.request. The type of HTTP request method to use.
940
- */
941
- method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
942
- /**
943
- * Request headers.
944
- */
945
- headers?: {
946
- [k: string]: unknown;
947
- };
948
- /**
949
- * Request body.
950
- */
951
- body?: {
952
- [k: string]: unknown;
953
- };
954
- /**
955
- * Request query parameters.
956
- */
957
- query?: {
958
- [k: string]: unknown;
959
- };
960
- /**
961
- * Required if the API being called requires authentication.
962
- */
963
- auth?: {
964
- /**
965
- * The type of authentication.
966
- */
967
- type?: "OIDC" | "OAuth2";
968
- };
969
- /**
970
- * Time in seconds. How long a request is allowed to run before throwing an exception.
971
- */
972
- timeout?: number;
973
- /**
974
- * The number of seconds to sleep.
975
- */
976
- seconds?: number;
977
- };
978
- /**
979
- * Define a dictionary.
980
- */
981
- assign?: {
982
- [k: string]: unknown;
983
- }[];
984
- /**
985
- * Variable name where the result of an HTTP invocation step is stored.
986
- */
987
- result?: string;
988
- /**
989
- * A switch block.
990
- */
991
- switch?: {
992
- /**
993
- * An expression to switch on.
994
- */
995
- condition: string;
996
- /**
997
- * The next step to jump to. "end" to terminate.
998
- */
999
- next?: string;
1000
- steps?: StepArray1;
1001
- /**
1002
- * Stop a workflow's execution and return a value, variable, or expression.
1003
- */
1004
- return?: {
1005
- [k: string]: unknown;
1006
- };
1007
- /**
1008
- * Raise an exception.
1009
- */
1010
- raise?:
1011
- | string
1012
- | {
1013
- [k: string]: unknown;
1014
- };
1015
- }[];
1016
- /**
1017
- * The next step to jump to. "end" to terminate.
1018
- */
1019
- next?: string;
1020
- /**
1021
- * Stop a workflow's execution and return a value, variable, or expression.
1022
- */
1023
- return?: {
1024
- [k: string]: unknown;
1025
- };
1026
- try?: Step1;
1027
- /**
1028
- * Optional. If omitted, all other fields are required. Options include ${http.default_retry} and ${http.default_retry_non_idempotent}. Allows you to specify a default retry policy to use. If you specify a retry policy, omit all other fields in the retry block.
1029
- */
1030
- retry?: {
1031
- /**
1032
- * Required if you don't select a default retry policy. Defines which error codes will be retried. Options include ${http.default_retry_predicate}, ${http.default_retry_predicate_non_idempotent}, or a custom predicate defined as a subworkflow.
1033
- */
1034
- predicate?: string;
1035
- /**
1036
- * Maximum number of times a step will be retried.
1037
- */
1038
- max_retries?: number;
1039
- /**
1040
- * Block that controls how retries occur.
1041
- */
1042
- backoff?: {
1043
- /**
1044
- * Delay in seconds between the initial failure and the first retry.
1045
- */
1046
- initial_delay?: number;
1047
- /**
1048
- * Maximum delay in seconds between retries.
1049
- */
1050
- max_delay?: number;
1051
- /**
1052
- * Multiplier applied to the previous delay to calculate the delay for the subsequent retry.
1053
- */
1054
- multiplier?: number;
1055
- };
1056
- };
1057
- /**
1058
- * Except a try clause.
1059
- */
1060
- except?:
1061
- | Step2
1062
- | {
1063
- /**
1064
- * Name of a dictionary variable that contains the error message.
1065
- */
1066
- as?: string;
1067
- steps?: StepArray4;
1068
- };
1069
- /**
1070
- * Raise an exception.
1071
- */
1072
- raise?:
1073
- | string
1074
- | {
1075
- [k: string]: unknown;
1076
- };
603
+ export interface Result {
604
+ [k: string]: unknown | undefined;
605
+ }
606
+ /**
607
+ * Define conditional expressions for a switch block.
608
+ */
609
+ export interface Condition {
610
+ /**
611
+ * An expression to switch on.
612
+ */
613
+ condition: string | boolean;
614
+ steps?: StepArray1;
615
+ assign?: Assign;
616
+ call?: Call;
617
+ args?: Args;
618
+ result?: Result;
619
+ next?: Next;
620
+ switch?: Switch;
1077
621
  for?: For;
1078
- /**
1079
- * Run branches or iterations in parallel
1080
- */
1081
- parallel?: {
1082
- /**
1083
- * The action for other branches when an exception occurs
1084
- */
1085
- exception_policy?: "continueAll";
1086
- /**
1087
- * A list of shared variables
1088
- */
1089
- shared?: string[];
1090
- /**
1091
- * An upper limit for branches/iterations to perform concurrently
1092
- */
1093
- concurrency_limit?: number;
1094
- /**
1095
- * A list of branches that will run concurrently
1096
- *
1097
- * @minItems 2
1098
- * @maxItems 10
1099
- */
1100
- branches?:
1101
- | [
1102
- {
1103
- steps?: StepArray3;
1104
- [k: string]: unknown;
1105
- },
1106
- {
1107
- steps?: StepArray3;
1108
- [k: string]: unknown;
1109
- }
1110
- ]
1111
- | [
1112
- {
1113
- steps?: StepArray3;
1114
- [k: string]: unknown;
1115
- },
1116
- {
1117
- steps?: StepArray3;
1118
- [k: string]: unknown;
1119
- },
1120
- {
1121
- steps?: StepArray3;
1122
- [k: string]: unknown;
1123
- }
1124
- ]
1125
- | [
1126
- {
1127
- steps?: StepArray3;
1128
- [k: string]: unknown;
1129
- },
1130
- {
1131
- steps?: StepArray3;
1132
- [k: string]: unknown;
1133
- },
1134
- {
1135
- steps?: StepArray3;
1136
- [k: string]: unknown;
1137
- },
1138
- {
1139
- steps?: StepArray3;
1140
- [k: string]: unknown;
1141
- }
1142
- ]
1143
- | [
1144
- {
1145
- steps?: StepArray3;
1146
- [k: string]: unknown;
1147
- },
1148
- {
1149
- steps?: StepArray3;
1150
- [k: string]: unknown;
1151
- },
1152
- {
1153
- steps?: StepArray3;
1154
- [k: string]: unknown;
1155
- },
1156
- {
1157
- steps?: StepArray3;
1158
- [k: string]: unknown;
1159
- },
1160
- {
1161
- steps?: StepArray3;
1162
- [k: string]: unknown;
1163
- }
1164
- ]
1165
- | [
1166
- {
1167
- steps?: StepArray3;
1168
- [k: string]: unknown;
1169
- },
1170
- {
1171
- steps?: StepArray3;
1172
- [k: string]: unknown;
1173
- },
1174
- {
1175
- steps?: StepArray3;
1176
- [k: string]: unknown;
1177
- },
1178
- {
1179
- steps?: StepArray3;
1180
- [k: string]: unknown;
1181
- },
1182
- {
1183
- steps?: StepArray3;
1184
- [k: string]: unknown;
1185
- },
1186
- {
1187
- steps?: StepArray3;
1188
- [k: string]: unknown;
1189
- }
1190
- ]
1191
- | [
1192
- {
1193
- steps?: StepArray3;
1194
- [k: string]: unknown;
1195
- },
1196
- {
1197
- steps?: StepArray3;
1198
- [k: string]: unknown;
1199
- },
1200
- {
1201
- steps?: StepArray3;
1202
- [k: string]: unknown;
1203
- },
1204
- {
1205
- steps?: StepArray3;
1206
- [k: string]: unknown;
1207
- },
1208
- {
1209
- steps?: StepArray3;
1210
- [k: string]: unknown;
1211
- },
1212
- {
1213
- steps?: StepArray3;
1214
- [k: string]: unknown;
1215
- },
1216
- {
1217
- steps?: StepArray3;
1218
- [k: string]: unknown;
1219
- }
1220
- ]
1221
- | [
1222
- {
1223
- steps?: StepArray3;
1224
- [k: string]: unknown;
1225
- },
1226
- {
1227
- steps?: StepArray3;
1228
- [k: string]: unknown;
1229
- },
1230
- {
1231
- steps?: StepArray3;
1232
- [k: string]: unknown;
1233
- },
1234
- {
1235
- steps?: StepArray3;
1236
- [k: string]: unknown;
1237
- },
1238
- {
1239
- steps?: StepArray3;
1240
- [k: string]: unknown;
1241
- },
1242
- {
1243
- steps?: StepArray3;
1244
- [k: string]: unknown;
1245
- },
1246
- {
1247
- steps?: StepArray3;
1248
- [k: string]: unknown;
1249
- },
1250
- {
1251
- steps?: StepArray3;
1252
- [k: string]: unknown;
1253
- }
1254
- ]
1255
- | [
1256
- {
1257
- steps?: StepArray3;
1258
- [k: string]: unknown;
1259
- },
1260
- {
1261
- steps?: StepArray3;
1262
- [k: string]: unknown;
1263
- },
1264
- {
1265
- steps?: StepArray3;
1266
- [k: string]: unknown;
1267
- },
1268
- {
1269
- steps?: StepArray3;
1270
- [k: string]: unknown;
1271
- },
1272
- {
1273
- steps?: StepArray3;
1274
- [k: string]: unknown;
1275
- },
1276
- {
1277
- steps?: StepArray3;
1278
- [k: string]: unknown;
1279
- },
1280
- {
1281
- steps?: StepArray3;
1282
- [k: string]: unknown;
1283
- },
1284
- {
1285
- steps?: StepArray3;
1286
- [k: string]: unknown;
1287
- },
1288
- {
1289
- steps?: StepArray3;
1290
- [k: string]: unknown;
1291
- }
1292
- ]
1293
- | [
1294
- {
1295
- steps?: StepArray3;
1296
- [k: string]: unknown;
1297
- },
1298
- {
1299
- steps?: StepArray3;
1300
- [k: string]: unknown;
1301
- },
1302
- {
1303
- steps?: StepArray3;
1304
- [k: string]: unknown;
1305
- },
1306
- {
1307
- steps?: StepArray3;
1308
- [k: string]: unknown;
1309
- },
1310
- {
1311
- steps?: StepArray3;
1312
- [k: string]: unknown;
1313
- },
1314
- {
1315
- steps?: StepArray3;
1316
- [k: string]: unknown;
1317
- },
1318
- {
1319
- steps?: StepArray3;
1320
- [k: string]: unknown;
1321
- },
1322
- {
1323
- steps?: StepArray3;
1324
- [k: string]: unknown;
1325
- },
1326
- {
1327
- steps?: StepArray3;
1328
- [k: string]: unknown;
1329
- },
1330
- {
1331
- steps?: StepArray3;
1332
- [k: string]: unknown;
1333
- }
1334
- ];
1335
- for?: For1;
1336
- };
622
+ parallel?: Parallel;
623
+ raise?: Raise;
624
+ try?: Try;
625
+ retry?: Retry;
626
+ except?: Except;
627
+ return?: Return;
628
+ [k: string]: unknown | undefined;
1337
629
  }
1338
630
  /**
1339
- * Iterates over a sequence of numbers or through a collection of data
1340
- * https://cloud.google.com/workflows/docs/reference/syntax/syntax-search
631
+ * A step.
1341
632
  */
1342
- export interface For {
1343
- /**
1344
- * A loop variable name
1345
- * https://cloud.google.com/workflows/docs/reference/syntax/iteration
1346
- */
1347
- value?: string;
1348
- /**
1349
- * An index variable name
1350
- * https://cloud.google.com/workflows/docs/reference/syntax/iteration
1351
- */
1352
- index?: string;
1353
- /**
1354
- * A number's range
1355
- * https://cloud.google.com/workflows/docs/reference/syntax/iteration
1356
- *
1357
- * @minItems 2
1358
- * @maxItems 2
1359
- */
1360
- range?: [number, number];
1361
- /**
1362
- * A list expression
1363
- * https://cloud.google.com/workflows/docs/reference/syntax/iteration
1364
- */
1365
- in?: unknown[];
1366
- steps?: StepArray2;
633
+ export interface Step1 {
634
+ assign?: Assign;
635
+ call?: Call;
636
+ args?: Args;
637
+ result?: Result;
638
+ next?: Next;
639
+ switch?: Switch;
640
+ for?: For1;
641
+ parallel?: Parallel1;
642
+ raise?: Raise;
643
+ try?: Try;
644
+ retry?: Retry;
645
+ except?: Except;
646
+ return?: Return;
647
+ steps?: StepArray1;
1367
648
  }
1368
649
  /**
1369
- * Iterates over a sequence of numbers or through a collection of data
1370
- * https://cloud.google.com/workflows/docs/reference/syntax/syntax-search
650
+ * A try/except structure for error handling.
1371
651
  */
1372
- export interface For1 {
1373
- /**
1374
- * A loop variable name
1375
- * https://cloud.google.com/workflows/docs/reference/syntax/iteration
1376
- */
1377
- value?: string;
1378
- /**
1379
- * An index variable name
1380
- * https://cloud.google.com/workflows/docs/reference/syntax/iteration
1381
- */
1382
- index?: string;
652
+ export interface Except {
1383
653
  /**
1384
- * A number's range
1385
- * https://cloud.google.com/workflows/docs/reference/syntax/iteration
1386
- *
1387
- * @minItems 2
1388
- * @maxItems 2
1389
- */
1390
- range?: [number, number];
1391
- /**
1392
- * A list expression
1393
- * https://cloud.google.com/workflows/docs/reference/syntax/iteration
654
+ * The name of a map variable that contains the error message.
1394
655
  */
1395
- in?: unknown[];
1396
- steps?: StepArray2;
656
+ as?: string;
657
+ steps?: StepArray3;
658
+ }
659
+ /**
660
+ * Stop a workflow's execution and return a value, variable, or expression.
661
+ */
662
+ export interface Return {
663
+ [k: string]: unknown | undefined;
1397
664
  }
1398
665
  /**
1399
666
  * A subworkflow.
1400
- *
1401
- * This interface was referenced by `undefined`'s JSON-Schema definition
1402
- * via the `patternProperty` "^.*$".
1403
667
  */
1404
668
  export interface Subworkflow {
1405
669
  /**
1406
- * A list of parameters.
1407
- */
1408
- params?: string[];
670
+ * The name of the parameter variable.
671
+ *
672
+ * @minItems 0
673
+ * @maxItems 10
674
+ */
675
+ params?:
676
+ | []
677
+ | [unknown]
678
+ | [unknown, unknown]
679
+ | [unknown, unknown, unknown]
680
+ | [unknown, unknown, unknown, unknown]
681
+ | [unknown, unknown, unknown, unknown, unknown]
682
+ | [unknown, unknown, unknown, unknown, unknown, unknown]
683
+ | [unknown, unknown, unknown, unknown, unknown, unknown, unknown]
684
+ | [unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]
685
+ | [unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]
686
+ | [unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown];
1409
687
  steps?: StepArray5;
1410
688
  }