Skip to content

Commit bbe99d6

Browse files
feat(workflowexecutions): update the api
#### workflowexecutions:v1 The following keys were added: - resources.projects.resources.locations.resources.workflows.resources.executions.methods.list.parameters.filter (Total Keys: 2) - resources.projects.resources.locations.resources.workflows.resources.executions.methods.list.parameters.orderBy (Total Keys: 2) - schemas.Execution.properties.labels (Total Keys: 2)
1 parent abf217f commit bbe99d6

File tree

4 files changed

+41
-4
lines changed

4 files changed

+41
-4
lines changed

docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h2>Instance Methods</h2>
8787
<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
8888
<p class="firstline">Returns an execution of the given name.</p>
8989
<p class="toc_element">
90-
<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
90+
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
9191
<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>
9292
<p class="toc_element">
9393
<code><a href="#list_next">list_next()</a></code></p>
@@ -135,6 +135,9 @@ <h3>Method Details</h3>
135135
],
136136
},
137137
},
138+
&quot;labels&quot;: { # 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.
139+
&quot;a_key&quot;: &quot;A String&quot;,
140+
},
138141
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
139142
&quot;result&quot;: &quot;A String&quot;, # Output only. Output of the execution represented as a JSON string. The value can only be present if the execution&#x27;s state is `SUCCEEDED`.
140143
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
@@ -187,6 +190,9 @@ <h3>Method Details</h3>
187190
],
188191
},
189192
},
193+
&quot;labels&quot;: { # 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.
194+
&quot;a_key&quot;: &quot;A String&quot;,
195+
},
190196
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
191197
&quot;result&quot;: &quot;A String&quot;, # Output only. Output of the execution represented as a JSON string. The value can only be present if the execution&#x27;s state is `SUCCEEDED`.
192198
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
@@ -232,6 +238,9 @@ <h3>Method Details</h3>
232238
],
233239
},
234240
},
241+
&quot;labels&quot;: { # 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.
242+
&quot;a_key&quot;: &quot;A String&quot;,
243+
},
235244
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
236245
&quot;result&quot;: &quot;A String&quot;, # Output only. Output of the execution represented as a JSON string. The value can only be present if the execution&#x27;s state is `SUCCEEDED`.
237246
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
@@ -289,6 +298,9 @@ <h3>Method Details</h3>
289298
],
290299
},
291300
},
301+
&quot;labels&quot;: { # 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.
302+
&quot;a_key&quot;: &quot;A String&quot;,
303+
},
292304
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
293305
&quot;result&quot;: &quot;A String&quot;, # Output only. Output of the execution represented as a JSON string. The value can only be present if the execution&#x27;s state is `SUCCEEDED`.
294306
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
@@ -306,11 +318,13 @@ <h3>Method Details</h3>
306318
</div>
307319

308320
<div class="method">
309-
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
321+
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
310322
<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).
311323

312324
Args:
313325
parent: string, Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow} (required)
326+
filter: string, Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.
327+
orderBy: string, Optional. The orderding applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.
314328
pageSize: integer, Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it&#x27;s 1000 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.
315329
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.
316330
view: string, Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.
@@ -350,6 +364,9 @@ <h3>Method Details</h3>
350364
],
351365
},
352366
},
367+
&quot;labels&quot;: { # 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.
368+
&quot;a_key&quot;: &quot;A String&quot;,
369+
},
353370
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
354371
&quot;result&quot;: &quot;A String&quot;, # Output only. Output of the execution represented as a JSON string. The value can only be present if the execution&#x27;s state is `SUCCEEDED`.
355372
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.

docs/dyn/workflowexecutions_v1.projects.locations.workflows.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,9 @@ <h3>Method Details</h3>
144144
],
145145
},
146146
},
147+
&quot;labels&quot;: { # 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.
148+
&quot;a_key&quot;: &quot;A String&quot;,
149+
},
147150
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
148151
&quot;result&quot;: &quot;A String&quot;, # Output only. Output of the execution represented as a JSON string. The value can only be present if the execution&#x27;s state is `SUCCEEDED`.
149152
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.

googleapiclient/discovery_cache/documents/workflowexecutions.v1.json

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,16 @@
248248
"parent"
249249
],
250250
"parameters": {
251+
"filter": {
252+
"description": "Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.",
253+
"location": "query",
254+
"type": "string"
255+
},
256+
"orderBy": {
257+
"description": "Optional. The orderding applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.",
258+
"location": "query",
259+
"type": "string"
260+
},
251261
"pageSize": {
252262
"description": "Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 1000 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.",
253263
"format": "int32",
@@ -299,7 +309,7 @@
299309
}
300310
}
301311
},
302-
"revision": "20230110",
312+
"revision": "20230117",
303313
"rootUrl": "https://workflowexecutions.googleapis.com/",
304314
"schemas": {
305315
"CancelExecutionRequest": {
@@ -366,6 +376,13 @@
366376
"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`.",
367377
"readOnly": true
368378
},
379+
"labels": {
380+
"additionalProperties": {
381+
"type": "string"
382+
},
383+
"description": "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.",
384+
"type": "object"
385+
},
369386
"name": {
370387
"description": "Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}",
371388
"readOnly": true,

googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@
269269
}
270270
}
271271
},
272-
"revision": "20230110",
272+
"revision": "20230117",
273273
"rootUrl": "https://workflowexecutions.googleapis.com/",
274274
"schemas": {
275275
"CancelExecutionRequest": {

0 commit comments

Comments
 (0)