/
workflowexecutions-v1.json
454 lines (454 loc) · 18.3 KB
/
workflowexecutions-v1.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://workflowexecutions.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Workflow Executions",
"description": "Execute workflows created with Workflows API.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/workflows",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "workflowexecutions:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://workflowexecutions.mtls.googleapis.com/",
"name": "workflowexecutions",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"workflows": {
"resources": {
"executions": {
"methods": {
"cancel": {
"description": "Cancels an execution of the given name.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}:cancel",
"httpMethod": "POST",
"id": "workflowexecutions.projects.locations.workflows.executions.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "CancelExecutionRequest"
},
"response": {
"$ref": "Execution"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a new execution using the latest revision of the given workflow.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions",
"httpMethod": "POST",
"id": "workflowexecutions.projects.locations.workflows.executions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/executions",
"request": {
"$ref": "Execution"
},
"response": {
"$ref": "Execution"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns an execution of the given name.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}",
"httpMethod": "GET",
"id": "workflowexecutions.projects.locations.workflows.executions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view.",
"enum": [
"EXECUTION_VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
"The default / unset value.",
"Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id.",
"Includes all data."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Execution"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "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).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions",
"httpMethod": "GET",
"id": "workflowexecutions.projects.locations.workflows.executions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 10000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListExecutions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListExecutions` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.",
"enum": [
"EXECUTION_VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
"The default / unset value.",
"Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id.",
"Includes all data."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/executions",
"response": {
"$ref": "ListExecutionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
}
}
},
"revision": "20210817",
"rootUrl": "https://workflowexecutions.googleapis.com/",
"schemas": {
"CancelExecutionRequest": {
"description": "Request for the CancelExecution method.",
"id": "CancelExecutionRequest",
"properties": {},
"type": "object"
},
"Error": {
"description": "Error describes why the execution was abnormally terminated.",
"id": "Error",
"properties": {
"context": {
"description": "Human readable stack trace string.",
"type": "string"
},
"payload": {
"description": "Error message and data returned represented as a JSON string.",
"type": "string"
},
"stackTrace": {
"$ref": "StackTrace",
"description": "Stack trace with detailed information of where error was generated."
}
},
"type": "object"
},
"Execution": {
"description": "A running instance of a [Workflow](/workflows/docs/reference/rest/v1/projects.locations.workflows).",
"id": "Execution",
"properties": {
"argument": {
"description": "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\\\"}\"}'`",
"type": "string"
},
"callLogLevel": {
"description": "The call logging level associated to this execution.",
"enum": [
"CALL_LOG_LEVEL_UNSPECIFIED",
"LOG_ALL_CALLS",
"LOG_ERRORS_ONLY"
],
"enumDescriptions": [
"No call logging specified.",
"Log all call steps within workflows, all call returns, and all exceptions raised.",
"Log only exceptions that are raised from call steps within workflows."
],
"type": "string"
},
"endTime": {
"description": "Output only. Marks the end of execution, successful or not.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"error": {
"$ref": "Error",
"description": "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`.",
"readOnly": true
},
"name": {
"description": "Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}",
"readOnly": true,
"type": "string"
},
"result": {
"description": "Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is `SUCCEEDED`.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Output only. Marks the beginning of execution.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. Current state of the execution.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Invalid state.",
"The execution is in progress.",
"The execution finished successfully.",
"The execution failed with an error.",
"The execution was stopped intentionally."
],
"readOnly": true,
"type": "string"
},
"workflowRevisionId": {
"description": "Output only. Revision of the workflow this execution is using.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ListExecutionsResponse": {
"description": "Response for the ListExecutions method.",
"id": "ListExecutionsResponse",
"properties": {
"executions": {
"description": "The executions which match the request.",
"items": {
"$ref": "Execution"
},
"type": "array"
},
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"Position": {
"description": "Position contains source position information about the stack trace element such as line number, column number and length of the code block in bytes.",
"id": "Position",
"properties": {
"column": {
"description": "The source code column position (of the line) the current instruction was generated from.",
"format": "int64",
"type": "string"
},
"length": {
"description": "The length in bytes of text in this character group, e.g. digits of a number, string length, or AST (abstract syntax tree) node.",
"format": "int64",
"type": "string"
},
"line": {
"description": "The source code line number the current instruction was generated from.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"StackTrace": {
"description": "A collection of stack elements (frames) where an error occurred.",
"id": "StackTrace",
"properties": {
"elements": {
"description": "An array of Stack elements.",
"items": {
"$ref": "StackTraceElement"
},
"type": "array"
}
},
"type": "object"
},
"StackTraceElement": {
"description": "A single stack element (frame) where an error occurred.",
"id": "StackTraceElement",
"properties": {
"position": {
"$ref": "Position",
"description": "The source position information of the stacktrace element."
},
"routine": {
"description": "The routine where the error occurred.",
"type": "string"
},
"step": {
"description": "The step the error occurred at.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Workflow Executions API",
"version": "v1",
"version_module": true
}