1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="workflowexecutions_v1.html">Workflow Executions API</a> . <a href="workflowexecutions_v1.projects.html">projects</a> . <a href="workflowexecutions_v1.projects.locations.html">locations</a> . <a href="workflowexecutions_v1.projects.locations.workflows.html">workflows</a> . <a href="workflowexecutions_v1.projects.locations.workflows.executions.html">executions</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Cancels an execution of the given name.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a new execution using the latest revision of the given workflow.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Returns an execution of the given name.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> 91<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> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code> 98 <pre>Cancels an execution of the given name. 99 100Args: 101 name: string, Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} (required) 102 body: object, The request body. 103 The object takes the form of: 104 105{ # Request for the CancelExecution method. 106} 107 108 x__xgafv: string, V1 error format. 109 Allowed values 110 1 - v1 error format 111 2 - v2 error format 112 113Returns: 114 An object of the form: 115 116 { # A running instance of a [Workflow](/workflows/docs/reference/rest/v1/projects.locations.workflows). 117 "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\"}"}'` 118 "callLogLevel": "A String", # The call logging level associated to this execution. 119 "endTime": "A String", # Output only. Marks the end of execution, successful or not. 120 "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`. 121 "context": "A String", # Human-readable stack trace string. 122 "payload": "A String", # Error message and data returned represented as a JSON string. 123 "stackTrace": { # A collection of stack elements (frames) where an error occurred. # Stack trace with detailed information of where error was generated. 124 "elements": [ # An array of stack elements. 125 { # A single stack element (frame) where an error occurred. 126 "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. 127 "column": "A String", # The source code column position (of the line) the current instruction was generated from. 128 "length": "A String", # The number of bytes of source code making up this stack trace element. 129 "line": "A String", # The source code line number the current instruction was generated from. 130 }, 131 "routine": "A String", # The routine where the error occurred. 132 "step": "A String", # The step the error occurred at. 133 }, 134 ], 135 }, 136 }, 137 "name": "A String", # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} 138 "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`. 139 "startTime": "A String", # Output only. Marks the beginning of execution. 140 "state": "A String", # Output only. Current state of the execution. 141 "workflowRevisionId": "A String", # Output only. Revision of the workflow this execution is using. 142}</pre> 143</div> 144 145<div class="method"> 146 <code class="details" id="close">close()</code> 147 <pre>Close httplib2 connections.</pre> 148</div> 149 150<div class="method"> 151 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 152 <pre>Creates a new execution using the latest revision of the given workflow. 153 154Args: 155 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) 156 body: object, The request body. 157 The object takes the form of: 158 159{ # A running instance of a [Workflow](/workflows/docs/reference/rest/v1/projects.locations.workflows). 160 "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\"}"}'` 161 "callLogLevel": "A String", # The call logging level associated to this execution. 162 "endTime": "A String", # Output only. Marks the end of execution, successful or not. 163 "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`. 164 "context": "A String", # Human-readable stack trace string. 165 "payload": "A String", # Error message and data returned represented as a JSON string. 166 "stackTrace": { # A collection of stack elements (frames) where an error occurred. # Stack trace with detailed information of where error was generated. 167 "elements": [ # An array of stack elements. 168 { # A single stack element (frame) where an error occurred. 169 "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. 170 "column": "A String", # The source code column position (of the line) the current instruction was generated from. 171 "length": "A String", # The number of bytes of source code making up this stack trace element. 172 "line": "A String", # The source code line number the current instruction was generated from. 173 }, 174 "routine": "A String", # The routine where the error occurred. 175 "step": "A String", # The step the error occurred at. 176 }, 177 ], 178 }, 179 }, 180 "name": "A String", # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} 181 "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`. 182 "startTime": "A String", # Output only. Marks the beginning of execution. 183 "state": "A String", # Output only. Current state of the execution. 184 "workflowRevisionId": "A String", # Output only. Revision of the workflow this execution is using. 185} 186 187 x__xgafv: string, V1 error format. 188 Allowed values 189 1 - v1 error format 190 2 - v2 error format 191 192Returns: 193 An object of the form: 194 195 { # A running instance of a [Workflow](/workflows/docs/reference/rest/v1/projects.locations.workflows). 196 "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\"}"}'` 197 "callLogLevel": "A String", # The call logging level associated to this execution. 198 "endTime": "A String", # Output only. Marks the end of execution, successful or not. 199 "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`. 200 "context": "A String", # Human-readable stack trace string. 201 "payload": "A String", # Error message and data returned represented as a JSON string. 202 "stackTrace": { # A collection of stack elements (frames) where an error occurred. # Stack trace with detailed information of where error was generated. 203 "elements": [ # An array of stack elements. 204 { # A single stack element (frame) where an error occurred. 205 "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. 206 "column": "A String", # The source code column position (of the line) the current instruction was generated from. 207 "length": "A String", # The number of bytes of source code making up this stack trace element. 208 "line": "A String", # The source code line number the current instruction was generated from. 209 }, 210 "routine": "A String", # The routine where the error occurred. 211 "step": "A String", # The step the error occurred at. 212 }, 213 ], 214 }, 215 }, 216 "name": "A String", # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} 217 "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`. 218 "startTime": "A String", # Output only. Marks the beginning of execution. 219 "state": "A String", # Output only. Current state of the execution. 220 "workflowRevisionId": "A String", # Output only. Revision of the workflow this execution is using. 221}</pre> 222</div> 223 224<div class="method"> 225 <code class="details" id="get">get(name, view=None, x__xgafv=None)</code> 226 <pre>Returns an execution of the given name. 227 228Args: 229 name: string, Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} (required) 230 view: string, Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view. 231 Allowed values 232 EXECUTION_VIEW_UNSPECIFIED - The default / unset value. 233 BASIC - Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id. 234 FULL - Includes all data. 235 x__xgafv: string, V1 error format. 236 Allowed values 237 1 - v1 error format 238 2 - v2 error format 239 240Returns: 241 An object of the form: 242 243 { # A running instance of a [Workflow](/workflows/docs/reference/rest/v1/projects.locations.workflows). 244 "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\"}"}'` 245 "callLogLevel": "A String", # The call logging level associated to this execution. 246 "endTime": "A String", # Output only. Marks the end of execution, successful or not. 247 "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`. 248 "context": "A String", # Human-readable stack trace string. 249 "payload": "A String", # Error message and data returned represented as a JSON string. 250 "stackTrace": { # A collection of stack elements (frames) where an error occurred. # Stack trace with detailed information of where error was generated. 251 "elements": [ # An array of stack elements. 252 { # A single stack element (frame) where an error occurred. 253 "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. 254 "column": "A String", # The source code column position (of the line) the current instruction was generated from. 255 "length": "A String", # The number of bytes of source code making up this stack trace element. 256 "line": "A String", # The source code line number the current instruction was generated from. 257 }, 258 "routine": "A String", # The routine where the error occurred. 259 "step": "A String", # The step the error occurred at. 260 }, 261 ], 262 }, 263 }, 264 "name": "A String", # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} 265 "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`. 266 "startTime": "A String", # Output only. Marks the beginning of execution. 267 "state": "A String", # Output only. Current state of the execution. 268 "workflowRevisionId": "A String", # Output only. Revision of the workflow this execution is using. 269}</pre> 270</div> 271 272<div class="method"> 273 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> 274 <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). 275 276Args: 277 parent: string, Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow} (required) 278 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. 279 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. 280 view: string, Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view. 281 Allowed values 282 EXECUTION_VIEW_UNSPECIFIED - The default / unset value. 283 BASIC - Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id. 284 FULL - Includes all data. 285 x__xgafv: string, V1 error format. 286 Allowed values 287 1 - v1 error format 288 2 - v2 error format 289 290Returns: 291 An object of the form: 292 293 { # Response for the ListExecutions method. 294 "executions": [ # The executions which match the request. 295 { # A running instance of a [Workflow](/workflows/docs/reference/rest/v1/projects.locations.workflows). 296 "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\"}"}'` 297 "callLogLevel": "A String", # The call logging level associated to this execution. 298 "endTime": "A String", # Output only. Marks the end of execution, successful or not. 299 "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`. 300 "context": "A String", # Human-readable stack trace string. 301 "payload": "A String", # Error message and data returned represented as a JSON string. 302 "stackTrace": { # A collection of stack elements (frames) where an error occurred. # Stack trace with detailed information of where error was generated. 303 "elements": [ # An array of stack elements. 304 { # A single stack element (frame) where an error occurred. 305 "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. 306 "column": "A String", # The source code column position (of the line) the current instruction was generated from. 307 "length": "A String", # The number of bytes of source code making up this stack trace element. 308 "line": "A String", # The source code line number the current instruction was generated from. 309 }, 310 "routine": "A String", # The routine where the error occurred. 311 "step": "A String", # The step the error occurred at. 312 }, 313 ], 314 }, 315 }, 316 "name": "A String", # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} 317 "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`. 318 "startTime": "A String", # Output only. Marks the beginning of execution. 319 "state": "A String", # Output only. Current state of the execution. 320 "workflowRevisionId": "A String", # Output only. Revision of the workflow this execution is using. 321 }, 322 ], 323 "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. 324}</pre> 325</div> 326 327<div class="method"> 328 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 329 <pre>Retrieves the next page of results. 330 331Args: 332 previous_request: The request for the previous page. (required) 333 previous_response: The response from the request for the previous page. (required) 334 335Returns: 336 A request object that you can call 'execute()' on to request the next 337 page. Returns None if there are no more items in the collection. 338 </pre> 339</div> 340 341</body></html>