@maxim_mazurok/gapi.client.workflowexecutions-v1 0.1.20260223 → 0.2.20260303
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.
- package/index.d.ts +91 -40
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://workflowexecutions.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260303
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -57,7 +57,11 @@ declare namespace gapi.client {
|
|
|
57
57
|
/** Input parameters of the execution represented as a JSON string. The size limit is 32KB. *Note*: If you are using the REST API directly to run your workflow, you must escape any JSON string value of `argument`. Example: `'{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'` */
|
|
58
58
|
argument?: string;
|
|
59
59
|
/** The call logging level associated to this execution. */
|
|
60
|
-
callLogLevel?:
|
|
60
|
+
callLogLevel?:
|
|
61
|
+
| 'CALL_LOG_LEVEL_UNSPECIFIED'
|
|
62
|
+
| 'LOG_ALL_CALLS'
|
|
63
|
+
| 'LOG_ERRORS_ONLY'
|
|
64
|
+
| 'LOG_NONE';
|
|
61
65
|
/** Output only. Marks the creation of the execution. */
|
|
62
66
|
createTime?: string;
|
|
63
67
|
/** Optional. If set to true, the execution will not be backlogged when the concurrency quota is exhausted. The backlog execution starts when the concurrency quota becomes available. */
|
|
@@ -69,7 +73,10 @@ declare namespace gapi.client {
|
|
|
69
73
|
/** Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is `FAILED` or `CANCELLED`. */
|
|
70
74
|
error?: Error;
|
|
71
75
|
/** Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution. */
|
|
72
|
-
executionHistoryLevel?:
|
|
76
|
+
executionHistoryLevel?:
|
|
77
|
+
| 'EXECUTION_HISTORY_LEVEL_UNSPECIFIED'
|
|
78
|
+
| 'EXECUTION_HISTORY_BASIC'
|
|
79
|
+
| 'EXECUTION_HISTORY_DETAILED';
|
|
73
80
|
/** Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. */
|
|
74
81
|
labels?: {[P in string]: string};
|
|
75
82
|
/** Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} */
|
|
@@ -79,7 +86,14 @@ declare namespace gapi.client {
|
|
|
79
86
|
/** Output only. Marks the beginning of execution. Note that this will be the same as `createTime` for executions that start immediately. */
|
|
80
87
|
startTime?: string;
|
|
81
88
|
/** Output only. Current state of the execution. */
|
|
82
|
-
state?:
|
|
89
|
+
state?:
|
|
90
|
+
| 'STATE_UNSPECIFIED'
|
|
91
|
+
| 'ACTIVE'
|
|
92
|
+
| 'SUCCEEDED'
|
|
93
|
+
| 'FAILED'
|
|
94
|
+
| 'CANCELLED'
|
|
95
|
+
| 'UNAVAILABLE'
|
|
96
|
+
| 'QUEUED';
|
|
83
97
|
/** Output only. Error regarding the state of the Execution resource. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions. */
|
|
84
98
|
stateError?: StateError;
|
|
85
99
|
/** Output only. Status tracks the current steps and progress data of this execution. */
|
|
@@ -157,7 +171,7 @@ declare namespace gapi.client {
|
|
|
157
171
|
/** Provides specifics about the error. */
|
|
158
172
|
details?: string;
|
|
159
173
|
/** The type of this state error. */
|
|
160
|
-
type?:
|
|
174
|
+
type?: 'TYPE_UNSPECIFIED' | 'KMS_ERROR';
|
|
161
175
|
}
|
|
162
176
|
interface Status {
|
|
163
177
|
/** A list of currently executing or last executed step names for the workflow execution currently running. If the workflow has succeeded or failed, this is the last attempted or executed step. Presently, if the current step is inside a subworkflow, the list only includes that step. In the future, the list will contain items for each step in the call stack, starting with the outermost step in the `main` subworkflow, and ending with the most deeply nested step. */
|
|
@@ -183,13 +197,38 @@ declare namespace gapi.client {
|
|
|
183
197
|
/** Output only. The name of the routine this step entry belongs to. A routine name is the subworkflow name defined in the YAML source code. The top level routine name is `main`. */
|
|
184
198
|
routine?: string;
|
|
185
199
|
/** Output only. The state of the step entry. */
|
|
186
|
-
state?:
|
|
200
|
+
state?:
|
|
201
|
+
| 'STATE_UNSPECIFIED'
|
|
202
|
+
| 'STATE_IN_PROGRESS'
|
|
203
|
+
| 'STATE_SUCCEEDED'
|
|
204
|
+
| 'STATE_FAILED'
|
|
205
|
+
| 'STATE_CANCELLED';
|
|
187
206
|
/** Output only. The name of the step this step entry belongs to. */
|
|
188
207
|
step?: string;
|
|
189
208
|
/** Output only. The StepEntryMetadata associated with this step. */
|
|
190
209
|
stepEntryMetadata?: StepEntryMetadata;
|
|
191
210
|
/** Output only. The type of the step this step entry belongs to. */
|
|
192
|
-
stepType?:
|
|
211
|
+
stepType?:
|
|
212
|
+
| 'STEP_TYPE_UNSPECIFIED'
|
|
213
|
+
| 'STEP_ASSIGN'
|
|
214
|
+
| 'STEP_STD_LIB_CALL'
|
|
215
|
+
| 'STEP_CONNECTOR_CALL'
|
|
216
|
+
| 'STEP_SUBWORKFLOW_CALL'
|
|
217
|
+
| 'STEP_CALL'
|
|
218
|
+
| 'STEP_SWITCH'
|
|
219
|
+
| 'STEP_CONDITION'
|
|
220
|
+
| 'STEP_FOR'
|
|
221
|
+
| 'STEP_FOR_ITERATION'
|
|
222
|
+
| 'STEP_PARALLEL_FOR'
|
|
223
|
+
| 'STEP_PARALLEL_BRANCH'
|
|
224
|
+
| 'STEP_PARALLEL_BRANCH_ENTRY'
|
|
225
|
+
| 'STEP_TRY_RETRY_EXCEPT'
|
|
226
|
+
| 'STEP_TRY'
|
|
227
|
+
| 'STEP_RETRY'
|
|
228
|
+
| 'STEP_EXCEPT'
|
|
229
|
+
| 'STEP_RETURN'
|
|
230
|
+
| 'STEP_RAISE'
|
|
231
|
+
| 'STEP_GOTO';
|
|
193
232
|
/** Output only. The most recently updated time of the step entry. */
|
|
194
233
|
updateTime?: string;
|
|
195
234
|
/** Output only. The VariableData associated with this step. */
|
|
@@ -201,7 +240,13 @@ declare namespace gapi.client {
|
|
|
201
240
|
/** Progress number represents the current state of the current progress. eg: A step entry represents the 4th iteration in a progress of PROGRESS_TYPE_FOR. Note: This field is only populated when an iteration exists and the starting value is 1. */
|
|
202
241
|
progressNumber?: string;
|
|
203
242
|
/** Progress type of this step entry. */
|
|
204
|
-
progressType?:
|
|
243
|
+
progressType?:
|
|
244
|
+
| 'PROGRESS_TYPE_UNSPECIFIED'
|
|
245
|
+
| 'PROGRESS_TYPE_FOR'
|
|
246
|
+
| 'PROGRESS_TYPE_SWITCH'
|
|
247
|
+
| 'PROGRESS_TYPE_RETRY'
|
|
248
|
+
| 'PROGRESS_TYPE_PARALLEL_FOR'
|
|
249
|
+
| 'PROGRESS_TYPE_PARALLEL_BRANCH';
|
|
205
250
|
/** Child thread id that this step entry belongs to. */
|
|
206
251
|
threadId?: string;
|
|
207
252
|
}
|
|
@@ -223,11 +268,11 @@ declare namespace gapi.client {
|
|
|
223
268
|
/** Returns a list of active callbacks that belong to the execution with the given name. The returned callbacks are ordered by callback ID. */
|
|
224
269
|
list(request?: {
|
|
225
270
|
/** V1 error format. */
|
|
226
|
-
'$.xgafv'?:
|
|
271
|
+
'$.xgafv'?: '1' | '2';
|
|
227
272
|
/** OAuth access token. */
|
|
228
273
|
access_token?: string;
|
|
229
274
|
/** Data format for response. */
|
|
230
|
-
alt?:
|
|
275
|
+
alt?: 'json' | 'media' | 'proto';
|
|
231
276
|
/** JSONP */
|
|
232
277
|
callback?: string;
|
|
233
278
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -256,11 +301,11 @@ declare namespace gapi.client {
|
|
|
256
301
|
/** Gets a step entry. */
|
|
257
302
|
get(request?: {
|
|
258
303
|
/** V1 error format. */
|
|
259
|
-
'$.xgafv'?:
|
|
304
|
+
'$.xgafv'?: '1' | '2';
|
|
260
305
|
/** OAuth access token. */
|
|
261
306
|
access_token?: string;
|
|
262
307
|
/** Data format for response. */
|
|
263
|
-
alt?:
|
|
308
|
+
alt?: 'json' | 'media' | 'proto';
|
|
264
309
|
/** JSONP */
|
|
265
310
|
callback?: string;
|
|
266
311
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -280,16 +325,19 @@ declare namespace gapi.client {
|
|
|
280
325
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
281
326
|
uploadType?: string;
|
|
282
327
|
/** Deprecated field. */
|
|
283
|
-
view?:
|
|
328
|
+
view?:
|
|
329
|
+
| 'EXECUTION_ENTRY_VIEW_UNSPECIFIED'
|
|
330
|
+
| 'EXECUTION_ENTRY_VIEW_BASIC'
|
|
331
|
+
| 'EXECUTION_ENTRY_VIEW_DETAILED';
|
|
284
332
|
}): Request<StepEntry>;
|
|
285
333
|
/** Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time. */
|
|
286
334
|
list(request?: {
|
|
287
335
|
/** V1 error format. */
|
|
288
|
-
'$.xgafv'?:
|
|
336
|
+
'$.xgafv'?: '1' | '2';
|
|
289
337
|
/** OAuth access token. */
|
|
290
338
|
access_token?: string;
|
|
291
339
|
/** Data format for response. */
|
|
292
|
-
alt?:
|
|
340
|
+
alt?: 'json' | 'media' | 'proto';
|
|
293
341
|
/** JSONP */
|
|
294
342
|
callback?: string;
|
|
295
343
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -319,18 +367,21 @@ declare namespace gapi.client {
|
|
|
319
367
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
320
368
|
uploadType?: string;
|
|
321
369
|
/** Deprecated field. */
|
|
322
|
-
view?:
|
|
370
|
+
view?:
|
|
371
|
+
| 'EXECUTION_ENTRY_VIEW_UNSPECIFIED'
|
|
372
|
+
| 'EXECUTION_ENTRY_VIEW_BASIC'
|
|
373
|
+
| 'EXECUTION_ENTRY_VIEW_DETAILED';
|
|
323
374
|
}): Request<ListStepEntriesResponse>;
|
|
324
375
|
}
|
|
325
376
|
interface ExecutionsResource {
|
|
326
377
|
/** Cancels an execution of the given name. */
|
|
327
378
|
cancel(request: {
|
|
328
379
|
/** V1 error format. */
|
|
329
|
-
'$.xgafv'?:
|
|
380
|
+
'$.xgafv'?: '1' | '2';
|
|
330
381
|
/** OAuth access token. */
|
|
331
382
|
access_token?: string;
|
|
332
383
|
/** Data format for response. */
|
|
333
|
-
alt?:
|
|
384
|
+
alt?: 'json' | 'media' | 'proto';
|
|
334
385
|
/** JSONP */
|
|
335
386
|
callback?: string;
|
|
336
387
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -355,11 +406,11 @@ declare namespace gapi.client {
|
|
|
355
406
|
cancel(
|
|
356
407
|
request: {
|
|
357
408
|
/** V1 error format. */
|
|
358
|
-
'$.xgafv'?:
|
|
409
|
+
'$.xgafv'?: '1' | '2';
|
|
359
410
|
/** OAuth access token. */
|
|
360
411
|
access_token?: string;
|
|
361
412
|
/** Data format for response. */
|
|
362
|
-
alt?:
|
|
413
|
+
alt?: 'json' | 'media' | 'proto';
|
|
363
414
|
/** JSONP */
|
|
364
415
|
callback?: string;
|
|
365
416
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -384,11 +435,11 @@ declare namespace gapi.client {
|
|
|
384
435
|
/** Creates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow. */
|
|
385
436
|
create(request: {
|
|
386
437
|
/** V1 error format. */
|
|
387
|
-
'$.xgafv'?:
|
|
438
|
+
'$.xgafv'?: '1' | '2';
|
|
388
439
|
/** OAuth access token. */
|
|
389
440
|
access_token?: string;
|
|
390
441
|
/** Data format for response. */
|
|
391
|
-
alt?:
|
|
442
|
+
alt?: 'json' | 'media' | 'proto';
|
|
392
443
|
/** JSONP */
|
|
393
444
|
callback?: string;
|
|
394
445
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -413,11 +464,11 @@ declare namespace gapi.client {
|
|
|
413
464
|
create(
|
|
414
465
|
request: {
|
|
415
466
|
/** V1 error format. */
|
|
416
|
-
'$.xgafv'?:
|
|
467
|
+
'$.xgafv'?: '1' | '2';
|
|
417
468
|
/** OAuth access token. */
|
|
418
469
|
access_token?: string;
|
|
419
470
|
/** Data format for response. */
|
|
420
|
-
alt?:
|
|
471
|
+
alt?: 'json' | 'media' | 'proto';
|
|
421
472
|
/** JSONP */
|
|
422
473
|
callback?: string;
|
|
423
474
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -442,11 +493,11 @@ declare namespace gapi.client {
|
|
|
442
493
|
/** Deletes all step entries for an execution. */
|
|
443
494
|
deleteExecutionHistory(request: {
|
|
444
495
|
/** V1 error format. */
|
|
445
|
-
'$.xgafv'?:
|
|
496
|
+
'$.xgafv'?: '1' | '2';
|
|
446
497
|
/** OAuth access token. */
|
|
447
498
|
access_token?: string;
|
|
448
499
|
/** Data format for response. */
|
|
449
|
-
alt?:
|
|
500
|
+
alt?: 'json' | 'media' | 'proto';
|
|
450
501
|
/** JSONP */
|
|
451
502
|
callback?: string;
|
|
452
503
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -471,11 +522,11 @@ declare namespace gapi.client {
|
|
|
471
522
|
deleteExecutionHistory(
|
|
472
523
|
request: {
|
|
473
524
|
/** V1 error format. */
|
|
474
|
-
'$.xgafv'?:
|
|
525
|
+
'$.xgafv'?: '1' | '2';
|
|
475
526
|
/** OAuth access token. */
|
|
476
527
|
access_token?: string;
|
|
477
528
|
/** Data format for response. */
|
|
478
|
-
alt?:
|
|
529
|
+
alt?: 'json' | 'media' | 'proto';
|
|
479
530
|
/** JSONP */
|
|
480
531
|
callback?: string;
|
|
481
532
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -500,11 +551,11 @@ declare namespace gapi.client {
|
|
|
500
551
|
/** Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods. */
|
|
501
552
|
exportData(request?: {
|
|
502
553
|
/** V1 error format. */
|
|
503
|
-
'$.xgafv'?:
|
|
554
|
+
'$.xgafv'?: '1' | '2';
|
|
504
555
|
/** OAuth access token. */
|
|
505
556
|
access_token?: string;
|
|
506
557
|
/** Data format for response. */
|
|
507
|
-
alt?:
|
|
558
|
+
alt?: 'json' | 'media' | 'proto';
|
|
508
559
|
/** JSONP */
|
|
509
560
|
callback?: string;
|
|
510
561
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -527,11 +578,11 @@ declare namespace gapi.client {
|
|
|
527
578
|
/** Returns an execution of the given name. */
|
|
528
579
|
get(request?: {
|
|
529
580
|
/** V1 error format. */
|
|
530
|
-
'$.xgafv'?:
|
|
581
|
+
'$.xgafv'?: '1' | '2';
|
|
531
582
|
/** OAuth access token. */
|
|
532
583
|
access_token?: string;
|
|
533
584
|
/** Data format for response. */
|
|
534
|
-
alt?:
|
|
585
|
+
alt?: 'json' | 'media' | 'proto';
|
|
535
586
|
/** JSONP */
|
|
536
587
|
callback?: string;
|
|
537
588
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -551,16 +602,16 @@ declare namespace gapi.client {
|
|
|
551
602
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
552
603
|
uploadType?: string;
|
|
553
604
|
/** Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view. */
|
|
554
|
-
view?:
|
|
605
|
+
view?: 'EXECUTION_VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
555
606
|
}): Request<Execution>;
|
|
556
607
|
/** Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first). */
|
|
557
608
|
list(request?: {
|
|
558
609
|
/** V1 error format. */
|
|
559
|
-
'$.xgafv'?:
|
|
610
|
+
'$.xgafv'?: '1' | '2';
|
|
560
611
|
/** OAuth access token. */
|
|
561
612
|
access_token?: string;
|
|
562
613
|
/** Data format for response. */
|
|
563
|
-
alt?:
|
|
614
|
+
alt?: 'json' | 'media' | 'proto';
|
|
564
615
|
/** JSONP */
|
|
565
616
|
callback?: string;
|
|
566
617
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -588,7 +639,7 @@ declare namespace gapi.client {
|
|
|
588
639
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
589
640
|
uploadType?: string;
|
|
590
641
|
/** Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view. */
|
|
591
|
-
view?:
|
|
642
|
+
view?: 'EXECUTION_VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
592
643
|
}): Request<ListExecutionsResponse>;
|
|
593
644
|
callbacks: CallbacksResource;
|
|
594
645
|
stepEntries: StepEntriesResource;
|
|
@@ -597,11 +648,11 @@ declare namespace gapi.client {
|
|
|
597
648
|
/** Triggers a new execution using the latest revision of the given workflow by a Pub/Sub push notification. */
|
|
598
649
|
triggerPubsubExecution(request: {
|
|
599
650
|
/** V1 error format. */
|
|
600
|
-
'$.xgafv'?:
|
|
651
|
+
'$.xgafv'?: '1' | '2';
|
|
601
652
|
/** OAuth access token. */
|
|
602
653
|
access_token?: string;
|
|
603
654
|
/** Data format for response. */
|
|
604
|
-
alt?:
|
|
655
|
+
alt?: 'json' | 'media' | 'proto';
|
|
605
656
|
/** JSONP */
|
|
606
657
|
callback?: string;
|
|
607
658
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -626,11 +677,11 @@ declare namespace gapi.client {
|
|
|
626
677
|
triggerPubsubExecution(
|
|
627
678
|
request: {
|
|
628
679
|
/** V1 error format. */
|
|
629
|
-
'$.xgafv'?:
|
|
680
|
+
'$.xgafv'?: '1' | '2';
|
|
630
681
|
/** OAuth access token. */
|
|
631
682
|
access_token?: string;
|
|
632
683
|
/** Data format for response. */
|
|
633
|
-
alt?:
|
|
684
|
+
alt?: 'json' | 'media' | 'proto';
|
|
634
685
|
/** JSONP */
|
|
635
686
|
callback?: string;
|
|
636
687
|
/** Selector specifying which fields to include in a partial response. */
|