@schemastore/workflows 0.0.7 → 1.0.1

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 (4) hide show
  1. package/LICENSE +674 -21
  2. package/README.md +6 -20
  3. package/index.d.ts +592 -386
  4. package/package.json +5 -9
package/index.d.ts CHANGED
@@ -1,22 +1,28 @@
1
1
  /* eslint-disable */
2
- /**
3
- * This file was automatically generated by json-schema-to-typescript.
4
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
5
- * and run json-schema-to-typescript to regenerate this file.
6
- */
7
2
 
8
3
  /**
9
4
  * Orchestrate Workflows consisting of Google Cloud APIs, SaaS APIs or private API endpoints.
10
5
  */
11
- export type GoogleCloudWorkflowsConfigFile =
12
- | StepArray
6
+ export type GoogleCloudWorkflows =
13
7
  | {
14
- [k: string]: Subworkflow;
15
- };
8
+ main: {
9
+ /**
10
+ * The name of the parameter variable.
11
+ *
12
+ * @minItems 0
13
+ * @maxItems 1
14
+ */
15
+ params?: [] | [string];
16
+ steps?: StepArray;
17
+ };
18
+ [k: string]: Subworkflow | undefined;
19
+ }
20
+ | StepArray6;
16
21
  /**
17
- * A list of steps.
22
+ * An array of objects with a single step.
18
23
  *
19
24
  * @minItems 1
25
+ * @maxItems 100000
20
26
  */
21
27
  export type StepArray = [
22
28
  {
@@ -27,37 +33,46 @@ export type StepArray = [
27
33
  }[]
28
34
  ];
29
35
  /**
30
- * A list of steps to run in this switch statement.
36
+ * A list of variable assignment maps.
31
37
  *
32
38
  * @minItems 1
39
+ * @maxItems 50
33
40
  */
34
- export type StepArray1 = [
41
+ export type Assign = [
35
42
  {
36
- [k: string]: Step;
43
+ [k: string]: unknown | undefined;
37
44
  },
38
45
  ...{
39
- [k: string]: Step;
46
+ [k: string]: unknown | undefined;
40
47
  }[]
41
48
  ];
42
49
  /**
43
- * An array of objects with a single step.
50
+ * Run a function and return a result.
51
+ */
52
+ export type Call =
53
+ | ('http.get' | 'http.post' | 'http.put' | 'http.patch' | 'http.delete' | 'http.request')
54
+ | ('sys.sleep' | 'sys.sleep_until' | 'sys.log')
55
+ | ('events.await_callback' | 'events.create_callback_endpoint')
56
+ | string
57
+ | string;
58
+ /**
59
+ * Define what step Workflows should execute next.
60
+ */
61
+ export type Next = string | 'end' | 'continue' | 'break';
62
+ /**
63
+ * 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.
44
64
  *
45
65
  * @minItems 1
66
+ * @maxItems 50
46
67
  */
47
- export type StepArray2 = [
48
- {
49
- [k: string]: Step;
50
- },
51
- ...{
52
- [k: string]: Step;
53
- }[]
54
- ];
68
+ export type Switch = [Condition, ...Condition[]];
55
69
  /**
56
70
  * An array of objects with a single step.
57
71
  *
58
72
  * @minItems 1
73
+ * @maxItems 100000
59
74
  */
60
- export type StepArray3 = [
75
+ export type StepArray1 = [
61
76
  {
62
77
  [k: string]: Step;
63
78
  },
@@ -65,479 +80,670 @@ export type StepArray3 = [
65
80
  [k: string]: Step;
66
81
  }[]
67
82
  ];
68
-
69
83
  /**
70
- * A single workflow step.
71
- *
72
- * This interface was referenced by `undefined`'s JSON-Schema definition
73
- * via the `patternProperty` "^.*$".
84
+ * Iterates over a sequence of numbers or through a collection of data, such as a list or map.
74
85
  */
75
- export interface Step {
86
+ export type For = {
87
+ /**
88
+ * A loop variable name. Contains the value of the currently iterated element.
89
+ */
90
+ value: string;
91
+ /**
92
+ * An index variable name. Contains the value to the current offset of the iteration.
93
+ */
94
+ index?: string;
76
95
  /**
77
- * Required
96
+ * An expression that evaluates into a list or a list definition. Required, if not using 'range'.
78
97
  */
79
- call?: ("http.get" | "http.post" | "http.request" | "sys.sleep") | string;
98
+ in?: unknown[] | string;
80
99
  /**
81
- * Arguments to a workflow step.
100
+ * A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
82
101
  */
83
- args?: {
84
- url?: string | string;
102
+ range?: [number, number] | string;
103
+ steps: StepArray2;
104
+ } & For1 & {
85
105
  /**
86
- * Required if using call type http.request. The type of HTTP request method to use.
106
+ * A loop variable name. Contains the value of the currently iterated element.
87
107
  */
88
- method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
108
+ value: string;
89
109
  /**
90
- * Request headers.
110
+ * An index variable name. Contains the value to the current offset of the iteration.
91
111
  */
92
- headers?: {
93
- [k: string]: unknown | undefined;
94
- };
112
+ index?: string;
95
113
  /**
96
- * Request body.
114
+ * An expression that evaluates into a list or a list definition. Required, if not using 'range'.
97
115
  */
98
- body?: {
99
- [k: string]: unknown | undefined;
100
- };
116
+ in?: unknown[] | string;
101
117
  /**
102
- * Request query parameters.
118
+ * A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
103
119
  */
104
- query?: {
105
- [k: string]: unknown | undefined;
106
- };
120
+ range?: [number, number] | string;
121
+ steps: StepArray2;
122
+ } & For1 & {
107
123
  /**
108
- * Required if the API being called requires authentication.
124
+ * A loop variable name. Contains the value of the currently iterated element.
109
125
  */
110
- auth?: {
111
- /**
112
- * The type of authentication.
113
- */
114
- type?: "OIDC" | "OAuth2";
115
- };
126
+ value: string;
116
127
  /**
117
- * Time in seconds. How long a request is allowed to run before throwing an exception.
128
+ * An index variable name. Contains the value to the current offset of the iteration.
118
129
  */
119
- timeout?: number;
130
+ index?: string;
120
131
  /**
121
- * The number of seconds to sleep.
132
+ * An expression that evaluates into a list or a list definition. Required, if not using 'range'.
122
133
  */
123
- seconds?: number;
124
- };
134
+ in?: unknown[] | string;
135
+ /**
136
+ * A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
137
+ */
138
+ range?: [number, number] | string;
139
+ steps: StepArray2;
140
+ } & For1;
141
+ /**
142
+ * Each iteration the steps will be executed.
143
+ *
144
+ * @minItems 1
145
+ * @maxItems 100000
146
+ */
147
+ export type StepArray2 = [
148
+ {
149
+ [k: string]: Step;
150
+ },
151
+ ...{
152
+ [k: string]: Step;
153
+ }[]
154
+ ];
155
+ export type For1 =
156
+ | {
157
+ [k: string]: unknown | undefined;
158
+ }
159
+ | {
160
+ [k: string]: unknown | undefined;
161
+ };
162
+ /**
163
+ * 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.
164
+ */
165
+ export type Parallel = {
125
166
  /**
126
- * Define a dictionary.
167
+ * 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.
127
168
  */
128
- assign?: {
129
- [k: string]: unknown | undefined;
130
- }[];
169
+ exception_policy?: 'continueAll';
131
170
  /**
132
- * Variable name where the result of an HTTP invocation step is stored.
171
+ * A list of writable variables with parent scope that allow assignments within the 'parallel' step.
133
172
  */
134
- result?: string;
173
+ shared?: string[];
135
174
  /**
136
- * A switch block.
175
+ * 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.
137
176
  */
138
- switch?: {
139
- /**
140
- * An expression to switch on.
141
- */
142
- condition: string;
177
+ concurrency_limit?: number;
178
+ branches?: Branches;
179
+ for?: For2;
180
+ } & Parallel1 & {
143
181
  /**
144
- * The next step to jump to. "end" to terminate.
182
+ * 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.
145
183
  */
146
- next?: string;
147
- steps?: StepArray1;
184
+ exception_policy?: 'continueAll';
148
185
  /**
149
- * Stop a workflow's execution and return a value, variable, or expression.
186
+ * A list of writable variables with parent scope that allow assignments within the 'parallel' step.
150
187
  */
151
- return?: {
152
- [k: string]: unknown | undefined;
153
- };
188
+ shared?: string[];
154
189
  /**
155
- * Raise an exception.
190
+ * 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.
156
191
  */
157
- raise?:
158
- | string
159
- | {
160
- [k: string]: unknown | undefined;
161
- };
162
- }[];
163
- /**
164
- * The next step to jump to. "end" to terminate.
165
- */
166
- next?: string;
167
- /**
168
- * Stop a workflow's execution and return a value, variable, or expression.
169
- */
170
- return?: {
171
- [k: string]: unknown | undefined;
172
- };
173
- try?: Step1;
174
- /**
175
- * 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.
176
- */
177
- retry?: {
192
+ concurrency_limit?: number;
193
+ branches?: Branches;
194
+ for?: For2;
195
+ } & Parallel1 & {
178
196
  /**
179
- * 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.
197
+ * 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.
180
198
  */
181
- predicate?: string;
199
+ exception_policy?: 'continueAll';
182
200
  /**
183
- * Maximum number of times a step will be retried.
201
+ * A list of writable variables with parent scope that allow assignments within the 'parallel' step.
184
202
  */
185
- max_retries?: number;
203
+ shared?: string[];
186
204
  /**
187
- * Block that controls how retries occur.
205
+ * 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.
188
206
  */
189
- backoff?: {
190
- /**
191
- * Delay in seconds between the initial failure and the first retry.
192
- */
193
- initial_delay?: number;
194
- /**
195
- * Maximum delay in seconds between retries.
196
- */
197
- max_delay?: number;
198
- /**
199
- * Multiplier applied to the previous delay to calculate the delay for the subsequent retry.
200
- */
201
- multiplier?: number;
202
- };
203
- };
207
+ concurrency_limit?: number;
208
+ branches?: Branches;
209
+ for?: For2;
210
+ } & Parallel1;
211
+ /**
212
+ * Branches that can run concurrently. Required, if not using 'for'.
213
+ *
214
+ * @minItems 2
215
+ * @maxItems 10
216
+ */
217
+ export type Branches =
218
+ | [
219
+ {
220
+ [k: string]: Step;
221
+ },
222
+ {
223
+ [k: string]: Step;
224
+ }
225
+ ]
226
+ | [
227
+ {
228
+ [k: string]: Step;
229
+ },
230
+ {
231
+ [k: string]: Step;
232
+ },
233
+ {
234
+ [k: string]: Step;
235
+ }
236
+ ]
237
+ | [
238
+ {
239
+ [k: string]: Step;
240
+ },
241
+ {
242
+ [k: string]: Step;
243
+ },
244
+ {
245
+ [k: string]: Step;
246
+ },
247
+ {
248
+ [k: string]: Step;
249
+ }
250
+ ]
251
+ | [
252
+ {
253
+ [k: string]: Step;
254
+ },
255
+ {
256
+ [k: string]: Step;
257
+ },
258
+ {
259
+ [k: string]: Step;
260
+ },
261
+ {
262
+ [k: string]: Step;
263
+ },
264
+ {
265
+ [k: string]: Step;
266
+ }
267
+ ]
268
+ | [
269
+ {
270
+ [k: string]: Step;
271
+ },
272
+ {
273
+ [k: string]: Step;
274
+ },
275
+ {
276
+ [k: string]: Step;
277
+ },
278
+ {
279
+ [k: string]: Step;
280
+ },
281
+ {
282
+ [k: string]: Step;
283
+ },
284
+ {
285
+ [k: string]: Step;
286
+ }
287
+ ]
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
+ [k: string]: Step;
306
+ },
307
+ {
308
+ [k: string]: Step;
309
+ }
310
+ ]
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
+ {
339
+ [k: string]: Step;
340
+ },
341
+ {
342
+ [k: string]: Step;
343
+ },
344
+ {
345
+ [k: string]: Step;
346
+ },
347
+ {
348
+ [k: string]: Step;
349
+ },
350
+ {
351
+ [k: string]: Step;
352
+ },
353
+ {
354
+ [k: string]: Step;
355
+ },
356
+ {
357
+ [k: string]: Step;
358
+ },
359
+ {
360
+ [k: string]: Step;
361
+ },
362
+ {
363
+ [k: string]: Step;
364
+ }
365
+ ]
366
+ | [
367
+ {
368
+ [k: string]: Step;
369
+ },
370
+ {
371
+ [k: string]: Step;
372
+ },
373
+ {
374
+ [k: string]: Step;
375
+ },
376
+ {
377
+ [k: string]: Step;
378
+ },
379
+ {
380
+ [k: string]: Step;
381
+ },
382
+ {
383
+ [k: string]: Step;
384
+ },
385
+ {
386
+ [k: string]: Step;
387
+ },
388
+ {
389
+ [k: string]: Step;
390
+ },
391
+ {
392
+ [k: string]: Step;
393
+ },
394
+ {
395
+ [k: string]: Step;
396
+ }
397
+ ];
398
+ /**
399
+ * A loop where iterations can run concurrently. Required, if not using 'branches'.
400
+ */
401
+ export type For2 = {
204
402
  /**
205
- * Except a try clause.
403
+ * A loop variable name. Contains the value of the currently iterated element.
206
404
  */
207
- except?:
208
- | Step2
209
- | {
210
- /**
211
- * Name of a dictionary variable that contains the error message.
212
- */
213
- as?: string;
214
- steps?: StepArray2;
215
- };
405
+ value: string;
216
406
  /**
217
- * Raise an exception.
407
+ * An index variable name. Contains the value to the current offset of the iteration.
218
408
  */
219
- raise?:
220
- | string
221
- | {
222
- [k: string]: unknown | undefined;
223
- };
224
- }
225
- /**
226
- * Try a single step or a list of steps.
227
- */
228
- export interface Step1 {
409
+ index?: string;
229
410
  /**
230
- * Required
411
+ * An expression that evaluates into a list or a list definition. Required, if not using 'range'.
231
412
  */
232
- call?: ("http.get" | "http.post" | "http.request" | "sys.sleep") | string;
413
+ in?: unknown[] | string;
233
414
  /**
234
- * Arguments to a workflow step.
415
+ * A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
235
416
  */
236
- args?: {
237
- url?: string | string;
238
- /**
239
- * Required if using call type http.request. The type of HTTP request method to use.
240
- */
241
- method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
242
- /**
243
- * Request headers.
244
- */
245
- headers?: {
417
+ range?: [number, number] | string;
418
+ steps: StepArray2;
419
+ } & (
420
+ | {
246
421
  [k: string]: unknown | undefined;
247
- };
248
- /**
249
- * Request body.
250
- */
251
- body?: {
422
+ }
423
+ | {
252
424
  [k: string]: unknown | undefined;
253
- };
254
- /**
255
- * Request query parameters.
256
- */
257
- query?: {
425
+ }
426
+ );
427
+ export type Parallel1 =
428
+ | {
429
+ [k: string]: unknown | undefined;
430
+ }
431
+ | {
258
432
  [k: string]: unknown | undefined;
259
433
  };
260
- /**
261
- * Required if the API being called requires authentication.
262
- */
263
- auth?: {
434
+ /**
435
+ * Raise an exception.
436
+ */
437
+ export type Raise =
438
+ | string
439
+ | {
264
440
  /**
265
- * The type of authentication.
441
+ * Error code.
266
442
  */
267
- type?: "OIDC" | "OAuth2";
268
- };
269
- /**
270
- * Time in seconds. How long a request is allowed to run before throwing an exception.
271
- */
272
- timeout?: number;
273
- /**
274
- * The number of seconds to sleep.
275
- */
276
- seconds?: number;
277
- };
278
- /**
279
- * Define a dictionary.
280
- */
281
- assign?: {
282
- [k: string]: unknown | undefined;
283
- }[];
284
- /**
285
- * Variable name where the result of an HTTP invocation step is stored.
286
- */
287
- result?: string;
288
- /**
289
- * A switch block.
290
- */
291
- switch?: {
292
- /**
293
- * An expression to switch on.
294
- */
295
- condition: string;
296
- /**
297
- * The next step to jump to. "end" to terminate.
298
- */
299
- next?: string;
300
- steps?: StepArray1;
301
- /**
302
- * Stop a workflow's execution and return a value, variable, or expression.
303
- */
304
- return?: {
443
+ code?: number;
444
+ /**
445
+ * Error message string.
446
+ */
447
+ message?: string;
305
448
  [k: string]: unknown | undefined;
306
449
  };
307
- /**
308
- * Raise an exception.
309
- */
310
- raise?:
311
- | string
312
- | {
313
- [k: string]: unknown | undefined;
314
- };
315
- }[];
316
- /**
317
- * The next step to jump to. "end" to terminate.
318
- */
319
- next?: string;
320
- /**
321
- * Stop a workflow's execution and return a value, variable, or expression.
322
- */
323
- return?: {
324
- [k: string]: unknown | undefined;
325
- };
326
- try?: Step1;
327
- /**
328
- * 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.
329
- */
330
- retry?: {
331
- /**
332
- * 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.
333
- */
334
- predicate?: string;
335
- /**
336
- * Maximum number of times a step will be retried.
337
- */
338
- max_retries?: number;
339
- /**
340
- * Block that controls how retries occur.
341
- */
342
- backoff?: {
450
+ /**
451
+ * A try/except structure for error handling.
452
+ */
453
+ export type Try = Step1 | StepArray4;
454
+ /**
455
+ * Define a retry policy to retry steps that return a specific error code.
456
+ */
457
+ export type Retry =
458
+ | {
343
459
  /**
344
- * Delay in seconds between the initial failure and the first retry.
460
+ * 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.
345
461
  */
346
- initial_delay?: number;
462
+ predicate?: string;
347
463
  /**
348
- * Maximum delay in seconds between retries.
464
+ * Maximum number of times a step will be retried, not counting the initial step execution attempt.
349
465
  */
350
- max_delay?: number;
466
+ max_retries?: number;
351
467
  /**
352
- * Multiplier applied to the previous delay to calculate the delay for the subsequent retry.
468
+ * Block that controls how retries occur.
353
469
  */
354
- multiplier?: number;
355
- };
356
- };
357
- /**
358
- * Except a try clause.
359
- */
360
- except?:
361
- | Step2
362
- | {
470
+ backoff?: {
363
471
  /**
364
- * Name of a dictionary variable that contains the error message.
472
+ * Delay in seconds between the initial failure and the first retry.
365
473
  */
366
- as?: string;
367
- steps?: StepArray2;
368
- };
369
- /**
370
- * Raise an exception.
371
- */
372
- raise?:
373
- | string
374
- | {
375
- [k: string]: unknown | undefined;
474
+ initial_delay?: number;
475
+ /**
476
+ * Maximum delay in seconds between retries.
477
+ */
478
+ max_delay?: number;
479
+ /**
480
+ * Multiplier applied to the previous delay to calculate the delay for the subsequent retry.
481
+ */
482
+ multiplier?: number;
376
483
  };
377
- }
484
+ }
485
+ | string;
486
+ /**
487
+ * A list of steps.
488
+ *
489
+ * @minItems 1
490
+ * @maxItems 100000
491
+ */
492
+ export type StepArray3 = [
493
+ {
494
+ [k: string]: Step;
495
+ },
496
+ ...{
497
+ [k: string]: Step;
498
+ }[]
499
+ ];
500
+ /**
501
+ * A list of steps.
502
+ *
503
+ * @minItems 1
504
+ * @maxItems 100000
505
+ */
506
+ export type StepArray4 = [
507
+ {
508
+ [k: string]: Step;
509
+ },
510
+ ...{
511
+ [k: string]: Step;
512
+ }[]
513
+ ];
514
+ /**
515
+ * An array of objects with a single step.
516
+ *
517
+ * @minItems 1
518
+ * @maxItems 100000
519
+ */
520
+ export type StepArray5 = [
521
+ {
522
+ [k: string]: Step;
523
+ },
524
+ ...{
525
+ [k: string]: Step;
526
+ }[]
527
+ ];
528
+ /**
529
+ * An array of objects with a single step.
530
+ *
531
+ * @minItems 1
532
+ * @maxItems 100000
533
+ */
534
+ export type StepArray6 = [
535
+ {
536
+ [k: string]: Step;
537
+ },
538
+ ...{
539
+ [k: string]: Step;
540
+ }[]
541
+ ];
542
+
378
543
  /**
379
544
  * A single workflow step.
545
+ *
546
+ * This interface was referenced by `undefined`'s JSON-Schema definition
547
+ * via the `patternProperty` "^.*$".
380
548
  */
381
- export interface Step2 {
549
+ export interface Step {
550
+ assign?: Assign;
551
+ call?: Call;
552
+ args?: Args;
553
+ result?: Result;
554
+ next?: Next;
555
+ switch?: Switch;
556
+ for?: For;
557
+ parallel?: Parallel;
558
+ raise?: Raise;
559
+ try?: Try;
560
+ retry?: Retry;
561
+ except?: Except;
562
+ return?: Return;
563
+ steps?: StepArray1;
564
+ }
565
+ /**
566
+ * Pass arguments and their values when calling a function that accepts parameters.
567
+ */
568
+ export interface Args {
569
+ url?: string | string;
382
570
  /**
383
- * Required
571
+ * The type of HTTP request method to use. Required if using call type http.request.
384
572
  */
385
- call?: ("http.get" | "http.post" | "http.request" | "sys.sleep") | string;
573
+ method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
386
574
  /**
387
- * Arguments to a workflow step.
575
+ * Header fields to supply input to the API.
388
576
  */
389
- args?: {
390
- url?: string | string;
391
- /**
392
- * Required if using call type http.request. The type of HTTP request method to use.
393
- */
394
- method?: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
395
- /**
396
- * Request headers.
397
- */
398
- headers?: {
399
- [k: string]: unknown | undefined;
400
- };
401
- /**
402
- * Request body.
403
- */
404
- body?: {
405
- [k: string]: unknown | undefined;
406
- };
407
- /**
408
- * Request query parameters.
409
- */
410
- query?: {
411
- [k: string]: unknown | undefined;
412
- };
413
- /**
414
- * Required if the API being called requires authentication.
415
- */
416
- auth?: {
417
- /**
418
- * The type of authentication.
419
- */
420
- type?: "OIDC" | "OAuth2";
421
- };
422
- /**
423
- * Time in seconds. How long a request is allowed to run before throwing an exception.
424
- */
425
- timeout?: number;
426
- /**
427
- * The number of seconds to sleep.
428
- */
429
- seconds?: number;
577
+ headers?: {
578
+ [k: string]: unknown | undefined;
430
579
  };
431
580
  /**
432
- * Define a dictionary.
581
+ * Body fields to supply input to the API.
433
582
  */
434
- assign?: {
435
- [k: string]: unknown | undefined;
436
- }[];
583
+ body?:
584
+ | {
585
+ [k: string]: unknown | undefined;
586
+ }
587
+ | null
588
+ | string
589
+ | string;
437
590
  /**
438
- * Variable name where the result of an HTTP invocation step is stored.
591
+ * Query fields to supply input to the API.
439
592
  */
440
- result?: string;
593
+ query?:
594
+ | {
595
+ [k: string]: unknown | undefined;
596
+ }
597
+ | string;
441
598
  /**
442
- * A switch block.
599
+ * Required if the API being called requires authentication.
443
600
  */
444
- switch?: {
601
+ auth?: {
445
602
  /**
446
- * An expression to switch on.
603
+ * The type of authentication.
447
604
  */
448
- condition: string;
605
+ type?: 'OIDC' | 'OAuth2';
449
606
  /**
450
- * The next step to jump to. "end" to terminate.
607
+ * Specify token scope to limit an application's access to a user's account.
451
608
  */
452
- next?: string;
453
- steps?: StepArray1;
609
+ scope?: unknown[] | string;
454
610
  /**
455
- * Stop a workflow's execution and return a value, variable, or expression.
611
+ * Specify token scope to limit an application's access to a user's account.
456
612
  */
457
- return?: {
458
- [k: string]: unknown | undefined;
459
- };
613
+ scopes?: unknown[] | string | string;
460
614
  /**
461
- * Raise an exception.
615
+ * 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.
462
616
  */
463
- raise?:
464
- | string
465
- | {
466
- [k: string]: unknown | undefined;
467
- };
468
- }[];
469
- /**
470
- * The next step to jump to. "end" to terminate.
471
- */
472
- next?: string;
617
+ audience?: string | string;
618
+ };
473
619
  /**
474
- * Stop a workflow's execution and return a value, variable, or expression.
620
+ * Time in seconds. How long a request is allowed to run before throwing an exception. Default and maximum values vary by call.
475
621
  */
476
- return?: {
477
- [k: string]: unknown | undefined;
478
- };
479
- try?: Step1;
622
+ timeout?: number;
480
623
  /**
481
- * 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.
624
+ * Connector-specific parameters.
482
625
  */
483
- retry?: {
484
- /**
485
- * 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.
486
- */
487
- predicate?: string;
626
+ connector_params?: {
488
627
  /**
489
- * Maximum number of times a step will be retried.
628
+ * Time in seconds. The end-to-end duration the connector call is allowed to run for before throwing a timeout exception.
490
629
  */
491
- max_retries?: number;
630
+ timeout?: number;
492
631
  /**
493
- * Block that controls how retries occur.
632
+ * Polling policy.
494
633
  */
495
- backoff?: {
634
+ polling_policy?: {
496
635
  /**
497
- * Delay in seconds between the initial failure and the first retry.
636
+ * Time in seconds. Only applies to long-running operation calls.
498
637
  */
499
638
  initial_delay?: number;
500
639
  /**
501
- * Maximum delay in seconds between retries.
640
+ * Time in seconds. Only applies to long-running operation calls.
502
641
  */
503
- max_delay?: number;
642
+ multiplier?: number;
504
643
  /**
505
- * Multiplier applied to the previous delay to calculate the delay for the subsequent retry.
644
+ * Time in seconds. Only applies to long-running operation calls.
506
645
  */
507
- multiplier?: number;
646
+ max_delay?: number;
647
+ [k: string]: unknown | undefined;
508
648
  };
649
+ /**
650
+ * If set to True, the connector invocation call is non-blocking if the initial request to manage or update the resource succeeds
651
+ */
652
+ skip_polling?: boolean;
653
+ /**
654
+ * OAuth2 scopes to pass to the Google API.
655
+ */
656
+ scopes?: unknown[] | string | string;
657
+ [k: string]: unknown | undefined;
509
658
  };
659
+ [k: string]: unknown | undefined;
660
+ }
661
+ /**
662
+ * Assign the result from a call to this variable.
663
+ */
664
+ export interface Result {
665
+ [k: string]: unknown | undefined;
666
+ }
667
+ /**
668
+ * Define conditional expressions for a switch block.
669
+ */
670
+ export interface Condition {
510
671
  /**
511
- * Except a try clause.
672
+ * An expression to switch on.
512
673
  */
513
- except?:
514
- | Step2
515
- | {
516
- /**
517
- * Name of a dictionary variable that contains the error message.
518
- */
519
- as?: string;
520
- steps?: StepArray2;
521
- };
674
+ condition: string | boolean;
675
+ steps?: StepArray1;
676
+ assign?: Assign;
677
+ call?: Call;
678
+ args?: Args;
679
+ result?: Result;
680
+ next?: Next;
681
+ switch?: Switch;
682
+ for?: For;
683
+ parallel?: Parallel;
684
+ raise?: Raise;
685
+ try?: Try;
686
+ retry?: Retry;
687
+ except?: Except;
688
+ return?: Return;
689
+ [k: string]: unknown | undefined;
690
+ }
691
+ /**
692
+ * A step.
693
+ */
694
+ export interface Step1 {
695
+ assign?: Assign;
696
+ call?: Call;
697
+ args?: Args;
698
+ result?: Result;
699
+ next?: Next;
700
+ switch?: Switch;
701
+ for?: For;
702
+ parallel?: Parallel;
703
+ raise?: Raise;
704
+ try?: Try;
705
+ retry?: Retry;
706
+ except?: Except;
707
+ return?: Return;
708
+ steps?: StepArray1;
709
+ }
710
+ /**
711
+ * A try/except structure for error handling.
712
+ */
713
+ export interface Except {
522
714
  /**
523
- * Raise an exception.
715
+ * The name of a map variable that contains the error message.
524
716
  */
525
- raise?:
526
- | string
527
- | {
528
- [k: string]: unknown | undefined;
529
- };
717
+ as?: string;
718
+ steps?: StepArray3;
719
+ }
720
+ /**
721
+ * Stop a workflow's execution and return a value, variable, or expression.
722
+ */
723
+ export interface Return {
724
+ [k: string]: unknown | undefined;
530
725
  }
531
726
  /**
532
727
  * A subworkflow.
533
- *
534
- * This interface was referenced by `undefined`'s JSON-Schema definition
535
- * via the `patternProperty` "^.*$".
536
728
  */
537
729
  export interface Subworkflow {
538
730
  /**
539
- * A list of parameters.
731
+ * The name of the parameter variable.
732
+ *
733
+ * @minItems 0
734
+ * @maxItems 10
540
735
  */
541
- params?: string[];
542
- steps?: StepArray3;
736
+ params?:
737
+ | []
738
+ | [unknown]
739
+ | [unknown, unknown]
740
+ | [unknown, unknown, unknown]
741
+ | [unknown, unknown, unknown, unknown]
742
+ | [unknown, unknown, unknown, unknown, unknown]
743
+ | [unknown, unknown, unknown, unknown, unknown, unknown]
744
+ | [unknown, unknown, unknown, unknown, unknown, unknown, unknown]
745
+ | [unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]
746
+ | [unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]
747
+ | [unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown];
748
+ steps?: StepArray5;
543
749
  }