Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6dc1b9bc894bf22494baa63f147ec6c3d140019 / . / googleapiclient / discovery_cache / documents / workflowexecutions.v1.json
blob: 29903f8e1509fa9e6a33f1db99adc60ff1de9d6e [file] [log] [blame]
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame^]1{
2 "parameters": {
3 "key": {
4 "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.",
5 "location": "query",
6 "type": "string"
7 },
8 "oauth_token": {
9 "location": "query",
10 "type": "string",
11 "description": "OAuth 2.0 token for the current user."
12 },
13 "quotaUser": {
14 "location": "query",
15 "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.",
16 "type": "string"
17 },
18 "callback": {
19 "description": "JSONP",
20 "location": "query",
21 "type": "string"
22 },
23 "upload_protocol": {
24 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
25 "type": "string",
26 "location": "query"
27 },
28 "uploadType": {
29 "type": "string",
30 "location": "query",
31 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
32 },
33 "prettyPrint": {
34 "default": "true",
35 "location": "query",
36 "type": "boolean",
37 "description": "Returns response with indentations and line breaks."
38 },
39 "alt": {
40 "enumDescriptions": [
41 "Responses with Content-Type of application/json",
42 "Media download with context-dependent Content-Type",
43 "Responses with Content-Type of application/x-protobuf"
44 ],
45 "default": "json",
46 "type": "string",
47 "enum": [
48 "json",
49 "media",
50 "proto"
51 ],
52 "location": "query",
53 "description": "Data format for response."
54 },
55 "$.xgafv": {
56 "description": "V1 error format.",
57 "enum": [
58 "1",
59 "2"
60 ],
61 "enumDescriptions": [
62 "v1 error format",
63 "v2 error format"
64 ],
65 "type": "string",
66 "location": "query"
67 },
68 "access_token": {
69 "description": "OAuth access token.",
70 "location": "query",
71 "type": "string"
72 },
73 "fields": {
74 "location": "query",
75 "type": "string",
76 "description": "Selector specifying which fields to include in a partial response."
77 }
78 },
79 "servicePath": "",
80 "auth": {
81 "oauth2": {
82 "scopes": {
83 "https://www.googleapis.com/auth/cloud-platform": {
84 "description": "View and manage your data across Google Cloud Platform services"
85 }
86 }
87 }
88 },
89 "discoveryVersion": "v1",
90 "revision": "20210118",
91 "version_module": true,
92 "documentationLink": "https://cloud.google.com/workflows",
93 "ownerDomain": "google.com",
94 "id": "workflowexecutions:v1",
95 "fullyEncodeReservedExpansion": true,
96 "title": "Workflow Executions API",
97 "resources": {
98 "projects": {
99 "resources": {
100 "locations": {
101 "resources": {
102 "workflows": {
103 "resources": {
104 "executions": {
105 "methods": {
106 "list": {
107 "parameters": {
108 "pageSize": {
109 "format": "int32",
110 "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.",
111 "location": "query",
112 "type": "integer"
113 },
114 "pageToken": {
115 "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.",
116 "type": "string",
117 "location": "query"
118 },
119 "parent": {
120 "type": "string",
121 "description": "Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}",
122 "required": true,
123 "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$",
124 "location": "path"
125 },
126 "view": {
127 "enumDescriptions": [
128 "The default / unset value.",
129 "Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id.",
130 "Includes all data."
131 ],
132 "description": "Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.",
133 "enum": [
134 "EXECUTION_VIEW_UNSPECIFIED",
135 "BASIC",
136 "FULL"
137 ],
138 "type": "string",
139 "location": "query"
140 }
141 },
142 "scopes": [
143 "https://www.googleapis.com/auth/cloud-platform"
144 ],
145 "response": {
146 "$ref": "ListExecutionsResponse"
147 },
148 "id": "workflowexecutions.projects.locations.workflows.executions.list",
149 "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).",
150 "path": "v1/{+parent}/executions",
151 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions",
152 "parameterOrder": [
153 "parent"
154 ],
155 "httpMethod": "GET"
156 },
157 "cancel": {
158 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}:cancel",
159 "path": "v1/{+name}:cancel",
160 "id": "workflowexecutions.projects.locations.workflows.executions.cancel",
161 "parameterOrder": [
162 "name"
163 ],
164 "response": {
165 "$ref": "Execution"
166 },
167 "parameters": {
168 "name": {
169 "required": true,
170 "type": "string",
171 "location": "path",
172 "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$",
173 "description": "Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}"
174 }
175 },
176 "request": {
177 "$ref": "CancelExecutionRequest"
178 },
179 "description": "Cancels an execution of the given name.",
180 "scopes": [
181 "https://www.googleapis.com/auth/cloud-platform"
182 ],
183 "httpMethod": "POST"
184 },
185 "get": {
186 "description": "Returns an execution of the given name.",
187 "httpMethod": "GET",
188 "scopes": [
189 "https://www.googleapis.com/auth/cloud-platform"
190 ],
191 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}",
192 "parameters": {
193 "name": {
194 "type": "string",
195 "required": true,
196 "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$",
197 "description": "Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}",
198 "location": "path"
199 },
200 "view": {
201 "enumDescriptions": [
202 "The default / unset value.",
203 "Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id.",
204 "Includes all data."
205 ],
206 "description": "Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view.",
207 "enum": [
208 "EXECUTION_VIEW_UNSPECIFIED",
209 "BASIC",
210 "FULL"
211 ],
212 "type": "string",
213 "location": "query"
214 }
215 },
216 "id": "workflowexecutions.projects.locations.workflows.executions.get",
217 "response": {
218 "$ref": "Execution"
219 },
220 "path": "v1/{+name}",
221 "parameterOrder": [
222 "name"
223 ]
224 },
225 "create": {
226 "httpMethod": "POST",
227 "response": {
228 "$ref": "Execution"
229 },
230 "path": "v1/{+parent}/executions",
231 "parameterOrder": [
232 "parent"
233 ],
234 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions",
235 "id": "workflowexecutions.projects.locations.workflows.executions.create",
236 "description": "Creates a new execution using the latest revision of the given workflow.",
237 "request": {
238 "$ref": "Execution"
239 },
240 "scopes": [
241 "https://www.googleapis.com/auth/cloud-platform"
242 ],
243 "parameters": {
244 "parent": {
245 "location": "path",
246 "required": true,
247 "type": "string",
248 "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.",
249 "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$"
250 }
251 }
252 }
253 }
254 }
255 }
256 }
257 }
258 }
259 }
260 }
261 },
262 "batchPath": "batch",
263 "description": "Execute workflows created with Workflows API.",
264 "canonicalName": "Workflow Executions",
265 "icons": {
266 "x32": "http://www.google.com/images/icons/product/search-32.gif",
267 "x16": "http://www.google.com/images/icons/product/search-16.gif"
268 },
269 "rootUrl": "https://workflowexecutions.googleapis.com/",
270 "basePath": "",
271 "ownerName": "Google",
272 "version": "v1",
273 "name": "workflowexecutions",
274 "protocol": "rest",
275 "baseUrl": "https://workflowexecutions.googleapis.com/",
276 "mtlsRootUrl": "https://workflowexecutions.mtls.googleapis.com/",
277 "kind": "discovery#restDescription",
278 "schemas": {
279 "CancelExecutionRequest": {
280 "description": "Request for the CancelExecution method.",
281 "id": "CancelExecutionRequest",
282 "type": "object",
283 "properties": {}
284 },
285 "Error": {
286 "description": "Error describes why the execution was abnormally terminated.",
287 "properties": {
288 "context": {
289 "type": "string",
290 "description": "Human readable error context, helpful for debugging purposes."
291 },
292 "payload": {
293 "description": "Error payload returned by the execution, represented as a JSON string.",
294 "type": "string"
295 }
296 },
297 "id": "Error",
298 "type": "object"
299 },
300 "ListExecutionsResponse": {
301 "type": "object",
302 "description": "Response for the ListExecutions method.",
303 "properties": {
304 "executions": {
305 "items": {
306 "$ref": "Execution"
307 },
308 "description": "The executions which match the request.",
309 "type": "array"
310 },
311 "nextPageToken": {
312 "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.",
313 "type": "string"
314 }
315 },
316 "id": "ListExecutionsResponse"
317 },
318 "Execution": {
319 "id": "Execution",
320 "description": "A running instance of a [Workflow](/workflows/docs/reference/rest/v1/projects.locations.workflows).",
321 "type": "object",
322 "properties": {
323 "result": {
324 "type": "string",
325 "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`.",
326 "readOnly": true
327 },
328 "endTime": {
329 "readOnly": true,
330 "type": "string",
331 "format": "google-datetime",
332 "description": "Output only. Marks the end of execution, successful or not."
333 },
334 "error": {
335 "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`.",
336 "readOnly": true,
337 "$ref": "Error"
338 },
339 "workflowRevisionId": {
340 "type": "string",
341 "readOnly": true,
342 "description": "Output only. Revision of the workflow this execution is using."
343 },
344 "startTime": {
345 "description": "Output only. Marks the beginning of execution.",
346 "readOnly": true,
347 "type": "string",
348 "format": "google-datetime"
349 },
350 "state": {
351 "readOnly": true,
352 "enum": [
353 "STATE_UNSPECIFIED",
354 "ACTIVE",
355 "SUCCEEDED",
356 "FAILED",
357 "CANCELLED"
358 ],
359 "type": "string",
360 "description": "Output only. Current state of the execution.",
361 "enumDescriptions": [
362 "Invalid state.",
363 "The execution is in progress.",
364 "The execution finished successfully.",
365 "The execution failed with an error.",
366 "The execution was stopped intentionally."
367 ]
368 },
369 "name": {
370 "type": "string",
371 "readOnly": true,
372 "description": "Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}"
373 },
374 "argument": {
375 "type": "string",
376 "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\\\"}\"}'`"
377 }
378 }
379 }
380 }
381}