Skip to content

Commit

Permalink
feat(workflowexecutions): update the api
Browse files Browse the repository at this point in the history
#### 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)
  • Loading branch information
yoshi-automation committed Jan 31, 2023
1 parent abf217f commit bbe99d6
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 4 deletions.
Expand Up @@ -87,7 +87,7 @@ <h2>Instance Methods</h2>
<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>
<code><a href="#list">list(parent, filter=None, orderBy=None, 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>
Expand Down Expand Up @@ -135,6 +135,9 @@ <h3>Method Details</h3>
],
},
},
&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.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
&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`.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
Expand Down Expand Up @@ -187,6 +190,9 @@ <h3>Method Details</h3>
],
},
},
&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.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
&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`.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
Expand Down Expand Up @@ -232,6 +238,9 @@ <h3>Method Details</h3>
],
},
},
&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.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
&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`.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
Expand Down Expand Up @@ -289,6 +298,9 @@ <h3>Method Details</h3>
],
},
},
&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.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
&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`.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
Expand All @@ -306,11 +318,13 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<code class="details" id="list">list(parent, filter=None, orderBy=None, 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)
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.
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.
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.
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.
Expand Down Expand Up @@ -350,6 +364,9 @@ <h3>Method Details</h3>
],
},
},
&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.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
&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`.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
Expand Down
Expand Up @@ -144,6 +144,9 @@ <h3>Method Details</h3>
],
},
},
&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.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
&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`.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
Expand Down
Expand Up @@ -248,6 +248,16 @@
"parent"
],
"parameters": {
"filter": {
"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.",
"location": "query",
"type": "string"
},
"orderBy": {
"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.",
"location": "query",
"type": "string"
},
"pageSize": {
"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.",
"format": "int32",
Expand Down Expand Up @@ -299,7 +309,7 @@
}
}
},
"revision": "20230110",
"revision": "20230117",
"rootUrl": "https://workflowexecutions.googleapis.com/",
"schemas": {
"CancelExecutionRequest": {
Expand Down Expand Up @@ -366,6 +376,13 @@
"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
},
"labels": {
"additionalProperties": {
"type": "string"
},
"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.",
"type": "object"
},
"name": {
"description": "Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}",
"readOnly": true,
Expand Down
Expand Up @@ -269,7 +269,7 @@
}
}
},
"revision": "20230110",
"revision": "20230117",
"rootUrl": "https://workflowexecutions.googleapis.com/",
"schemas": {
"CancelExecutionRequest": {
Expand Down

0 comments on commit bbe99d6

Please sign in to comment.