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.description
- resources.projects.resources.locations.resources.workflows.resources.executions.methods.list.parameters.filter.location
- resources.projects.resources.locations.resources.workflows.resources.executions.methods.list.parameters.filter.type
- resources.projects.resources.locations.resources.workflows.resources.executions.methods.list.parameters.orderBy.description
- resources.projects.resources.locations.resources.workflows.resources.executions.methods.list.parameters.orderBy.location
- resources.projects.resources.locations.resources.workflows.resources.executions.methods.list.parameters.orderBy.type
- schemas.Execution.properties.labels.additionalProperties.type
- schemas.Execution.properties.labels.description
- schemas.Execution.properties.labels.type
  • Loading branch information
yoshi-automation authored and sofisl committed Feb 2, 2023
1 parent 99b557a commit 765ac58
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
19 changes: 18 additions & 1 deletion discovery/workflowexecutions-v1.json
Original file line number Diff line number Diff line change
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": "20221206",
"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
21 changes: 21 additions & 0 deletions src/apis/workflowexecutions/v1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,10 @@ export namespace workflowexecutions_v1 {
* 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`.
*/
error?: Schema$Error;
/**
* 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.
*/
labels?: {[key: string]: string} | null;
/**
* Output only. The resource name of the execution. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}/executions/{execution\}
*/
Expand Down Expand Up @@ -396,6 +400,7 @@ export namespace workflowexecutions_v1 {
* // "duration": "my_duration",
* // "endTime": "my_endTime",
* // "error": {},
* // "labels": {},
* // "name": "my_name",
* // "result": "my_result",
* // "startTime": "my_startTime",
Expand Down Expand Up @@ -566,6 +571,7 @@ export namespace workflowexecutions_v1 {
* // "duration": "my_duration",
* // "endTime": "my_endTime",
* // "error": {},
* // "labels": {},
* // "name": "my_name",
* // "result": "my_result",
* // "startTime": "my_startTime",
Expand Down Expand Up @@ -705,6 +711,7 @@ export namespace workflowexecutions_v1 {
* // "duration": "my_duration",
* // "endTime": "my_endTime",
* // "error": {},
* // "labels": {},
* // "name": "my_name",
* // "result": "my_result",
* // "startTime": "my_startTime",
Expand All @@ -723,6 +730,7 @@ export namespace workflowexecutions_v1 {
* // "duration": "my_duration",
* // "endTime": "my_endTime",
* // "error": {},
* // "labels": {},
* // "name": "my_name",
* // "result": "my_result",
* // "startTime": "my_startTime",
Expand Down Expand Up @@ -867,6 +875,7 @@ export namespace workflowexecutions_v1 {
* // "duration": "my_duration",
* // "endTime": "my_endTime",
* // "error": {},
* // "labels": {},
* // "name": "my_name",
* // "result": "my_result",
* // "startTime": "my_startTime",
Expand Down Expand Up @@ -994,6 +1003,10 @@ export namespace workflowexecutions_v1 {
* // Do the magic
* const res =
* await workflowexecutions.projects.locations.workflows.executions.list({
* // Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.
* filter: 'placeholder-value',
* // 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.
* orderBy: 'placeholder-value',
* // 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.
* pageSize: 'placeholder-value',
* // 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.
Expand Down Expand Up @@ -1148,6 +1161,14 @@ export namespace workflowexecutions_v1 {
}
export interface Params$Resource$Projects$Locations$Workflows$Executions$List
extends StandardParameters {
/**
* Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.
*/
filter?: 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.
*/
orderBy?: string;
/**
* 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.
*/
Expand Down

0 comments on commit 765ac58

Please sign in to comment.