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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="workflowexecutions_v1beta.html">Workflow Executions API</a> . <a href="workflowexecutions_v1beta.projects.html">projects</a> . <a href="workflowexecutions_v1beta.projects.locations.html">locations</a> . <a href="workflowexecutions_v1beta.projects.locations.workflows.html">workflows</a> . <a href="workflowexecutions_v1beta.projects.locations.workflows.executions.html">executions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels an execution of the given name.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new execution using the latest revision of the given workflow.</p>
<p class="toc_element">
<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns an execution of the given name.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">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).</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
<pre>Cancels an execution of the given name.
Args:
name: string, Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} (required)
body: object, The request body.
The object takes the form of:
{ # Request for the CancelExecution method.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A running instance of a [Workflow](/workflows/docs/reference/rest/v1beta/projects.locations.workflows).
"argument": "A String", # 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\"}"}'`
"callLogLevel": "A String", # The call logging level associated to this execution.
"endTime": "A String", # Output only. Marks the end of execution, successful or not.
"error": { # Error describes why the execution was abnormally terminated. # 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`.
"context": "A String", # Human-readable stack trace string.
"payload": "A String", # Error message and data returned represented as a JSON string.
"stackTrace": { # A collection of stack elements (frames) where an error occurred. # Stack trace with detailed information of where error was generated.
"elements": [ # An array of stack elements.
{ # A single stack element (frame) where an error occurred.
"position": { # Position contains source position information about the stack trace element such as line number, column number and length of the code block in bytes. # The source position information of the stack trace element.
"column": "A String", # The source code column position (of the line) the current instruction was generated from.
"length": "A String", # The number of bytes of source code making up this stack trace element.
"line": "A String", # The source code line number the current instruction was generated from.
},
"routine": "A String", # The routine where the error occurred.
"step": "A String", # The step the error occurred at.
},
],
},
},
"name": "A String", # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
"result": "A String", # Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is `SUCCEEDED`.
"startTime": "A String", # Output only. Marks the beginning of execution.
"state": "A String", # Output only. Current state of the execution.
"status": { # Represents the current status of this execution. # Output only. Status tracks the current steps and progress data of this execution.
"currentSteps": [ # 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.
{ # Represents a step of the workflow this execution is running.
"routine": "A String", # Name of a routine within the workflow.
"step": "A String", # Name of a step within the routine.
},
],
},
"workflowRevisionId": "A String", # Output only. Revision of the workflow this execution is using.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new execution using the latest revision of the given workflow.
Args:
parent: string, 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. (required)
body: object, The request body.
The object takes the form of:
{ # A running instance of a [Workflow](/workflows/docs/reference/rest/v1beta/projects.locations.workflows).
"argument": "A String", # 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\"}"}'`
"callLogLevel": "A String", # The call logging level associated to this execution.
"endTime": "A String", # Output only. Marks the end of execution, successful or not.
"error": { # Error describes why the execution was abnormally terminated. # 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`.
"context": "A String", # Human-readable stack trace string.
"payload": "A String", # Error message and data returned represented as a JSON string.
"stackTrace": { # A collection of stack elements (frames) where an error occurred. # Stack trace with detailed information of where error was generated.
"elements": [ # An array of stack elements.
{ # A single stack element (frame) where an error occurred.
"position": { # Position contains source position information about the stack trace element such as line number, column number and length of the code block in bytes. # The source position information of the stack trace element.
"column": "A String", # The source code column position (of the line) the current instruction was generated from.
"length": "A String", # The number of bytes of source code making up this stack trace element.
"line": "A String", # The source code line number the current instruction was generated from.
},
"routine": "A String", # The routine where the error occurred.
"step": "A String", # The step the error occurred at.
},
],
},
},
"name": "A String", # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
"result": "A String", # Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is `SUCCEEDED`.
"startTime": "A String", # Output only. Marks the beginning of execution.
"state": "A String", # Output only. Current state of the execution.
"status": { # Represents the current status of this execution. # Output only. Status tracks the current steps and progress data of this execution.
"currentSteps": [ # 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.
{ # Represents a step of the workflow this execution is running.
"routine": "A String", # Name of a routine within the workflow.
"step": "A String", # Name of a step within the routine.
},
],
},
"workflowRevisionId": "A String", # Output only. Revision of the workflow this execution is using.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A running instance of a [Workflow](/workflows/docs/reference/rest/v1beta/projects.locations.workflows).
"argument": "A String", # 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\"}"}'`
"callLogLevel": "A String", # The call logging level associated to this execution.
"endTime": "A String", # Output only. Marks the end of execution, successful or not.
"error": { # Error describes why the execution was abnormally terminated. # 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`.
"context": "A String", # Human-readable stack trace string.
"payload": "A String", # Error message and data returned represented as a JSON string.
"stackTrace": { # A collection of stack elements (frames) where an error occurred. # Stack trace with detailed information of where error was generated.
"elements": [ # An array of stack elements.
{ # A single stack element (frame) where an error occurred.
"position": { # Position contains source position information about the stack trace element such as line number, column number and length of the code block in bytes. # The source position information of the stack trace element.
"column": "A String", # The source code column position (of the line) the current instruction was generated from.
"length": "A String", # The number of bytes of source code making up this stack trace element.
"line": "A String", # The source code line number the current instruction was generated from.
},
"routine": "A String", # The routine where the error occurred.
"step": "A String", # The step the error occurred at.
},
],
},
},
"name": "A String", # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
"result": "A String", # Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is `SUCCEEDED`.
"startTime": "A String", # Output only. Marks the beginning of execution.
"state": "A String", # Output only. Current state of the execution.
"status": { # Represents the current status of this execution. # Output only. Status tracks the current steps and progress data of this execution.
"currentSteps": [ # 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.
{ # Represents a step of the workflow this execution is running.
"routine": "A String", # Name of a routine within the workflow.
"step": "A String", # Name of a step within the routine.
},
],
},
"workflowRevisionId": "A String", # Output only. Revision of the workflow this execution is using.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
<pre>Returns an execution of the given name.
Args:
name: string, Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} (required)
view: string, Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view.
Allowed values
EXECUTION_VIEW_UNSPECIFIED - The default / unset value.
BASIC - Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id.
FULL - Includes all data.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A running instance of a [Workflow](/workflows/docs/reference/rest/v1beta/projects.locations.workflows).
"argument": "A String", # 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\"}"}'`
"callLogLevel": "A String", # The call logging level associated to this execution.
"endTime": "A String", # Output only. Marks the end of execution, successful or not.
"error": { # Error describes why the execution was abnormally terminated. # 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`.
"context": "A String", # Human-readable stack trace string.
"payload": "A String", # Error message and data returned represented as a JSON string.
"stackTrace": { # A collection of stack elements (frames) where an error occurred. # Stack trace with detailed information of where error was generated.
"elements": [ # An array of stack elements.
{ # A single stack element (frame) where an error occurred.
"position": { # Position contains source position information about the stack trace element such as line number, column number and length of the code block in bytes. # The source position information of the stack trace element.
"column": "A String", # The source code column position (of the line) the current instruction was generated from.
"length": "A String", # The number of bytes of source code making up this stack trace element.
"line": "A String", # The source code line number the current instruction was generated from.
},
"routine": "A String", # The routine where the error occurred.
"step": "A String", # The step the error occurred at.
},
],
},
},
"name": "A String", # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
"result": "A String", # Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is `SUCCEEDED`.
"startTime": "A String", # Output only. Marks the beginning of execution.
"state": "A String", # Output only. Current state of the execution.
"status": { # Represents the current status of this execution. # Output only. Status tracks the current steps and progress data of this execution.
"currentSteps": [ # 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.
{ # Represents a step of the workflow this execution is running.
"routine": "A String", # Name of a routine within the workflow.
"step": "A String", # Name of a step within the routine.
},
],
},
"workflowRevisionId": "A String", # Output only. Revision of the workflow this execution is using.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>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).
Args:
parent: string, Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow} (required)
pageSize: integer, 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.
pageToken: string, 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.
view: string, Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.
Allowed values
EXECUTION_VIEW_UNSPECIFIED - The default / unset value.
BASIC - Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id.
FULL - Includes all data.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for the ListExecutions method.
"executions": [ # The executions which match the request.
{ # A running instance of a [Workflow](/workflows/docs/reference/rest/v1beta/projects.locations.workflows).
"argument": "A String", # 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\"}"}'`
"callLogLevel": "A String", # The call logging level associated to this execution.
"endTime": "A String", # Output only. Marks the end of execution, successful or not.
"error": { # Error describes why the execution was abnormally terminated. # 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`.
"context": "A String", # Human-readable stack trace string.
"payload": "A String", # Error message and data returned represented as a JSON string.
"stackTrace": { # A collection of stack elements (frames) where an error occurred. # Stack trace with detailed information of where error was generated.
"elements": [ # An array of stack elements.
{ # A single stack element (frame) where an error occurred.
"position": { # Position contains source position information about the stack trace element such as line number, column number and length of the code block in bytes. # The source position information of the stack trace element.
"column": "A String", # The source code column position (of the line) the current instruction was generated from.
"length": "A String", # The number of bytes of source code making up this stack trace element.
"line": "A String", # The source code line number the current instruction was generated from.
},
"routine": "A String", # The routine where the error occurred.
"step": "A String", # The step the error occurred at.
},
],
},
},
"name": "A String", # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
"result": "A String", # Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is `SUCCEEDED`.
"startTime": "A String", # Output only. Marks the beginning of execution.
"state": "A String", # Output only. Current state of the execution.
"status": { # Represents the current status of this execution. # Output only. Status tracks the current steps and progress data of this execution.
"currentSteps": [ # 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.
{ # Represents a step of the workflow this execution is running.
"routine": "A String", # Name of a routine within the workflow.
"step": "A String", # Name of a step within the routine.
},
],
},
"workflowRevisionId": "A String", # Output only. Revision of the workflow this execution is using.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
