Skip to content

Commit 7e5f42a

Browse files
yoshi-automationsofisl
authored andcommitted
feat(workflowexecutions): update the API
#### workflowexecutions:v1 The following keys were added: - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.description - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.flatPath - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.httpMethod - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.id - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.parameterOrder - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.parameters.name.description - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.parameters.name.location - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.parameters.name.pattern - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.parameters.name.required - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.parameters.name.type - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.path - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.request.$ref - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.response.$ref - resources.projects.resources.locations.resources.workflows.resources.executions.methods.deleteExecutionHistory.scopes - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.get.parameters.view.deprecated - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.get.parameters.view.description - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.get.parameters.view.enum - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.get.parameters.view.enumDescriptions - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.get.parameters.view.location - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.get.parameters.view.type - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.list.parameters.view.deprecated - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.list.parameters.view.description - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.list.parameters.view.enum - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.list.parameters.view.enumDescriptions - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.list.parameters.view.location - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.list.parameters.view.type - schemas.DeleteExecutionHistoryRequest.description - schemas.DeleteExecutionHistoryRequest.id - schemas.DeleteExecutionHistoryRequest.type - schemas.Empty.description - schemas.Empty.id - schemas.Empty.type - schemas.StepEntry.properties.variableData.$ref - schemas.StepEntry.properties.variableData.description - schemas.StepEntry.properties.variableData.readOnly - schemas.VariableData.description - schemas.VariableData.id - schemas.VariableData.properties.variables.additionalProperties.type - schemas.VariableData.properties.variables.description - schemas.VariableData.properties.variables.type - schemas.VariableData.type The following keys were changed: - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.workflows.resources.executions.resources.stepEntries.methods.list.parameters.parent.description
1 parent 614baa2 commit 7e5f42a

File tree

2 files changed

+227
-5
lines changed

2 files changed

+227
-5
lines changed

discovery/workflowexecutions-v1.json

Lines changed: 94 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,34 @@
199199
"https://www.googleapis.com/auth/cloud-platform"
200200
]
201201
},
202+
"deleteExecutionHistory": {
203+
"description": "Deletes all step entries for an execution.",
204+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}:deleteExecutionHistory",
205+
"httpMethod": "POST",
206+
"id": "workflowexecutions.projects.locations.workflows.executions.deleteExecutionHistory",
207+
"parameterOrder": [
208+
"name"
209+
],
210+
"parameters": {
211+
"name": {
212+
"description": "Required. Name of the execution for which step entries should be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}",
213+
"location": "path",
214+
"pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$",
215+
"required": true,
216+
"type": "string"
217+
}
218+
},
219+
"path": "v1/{+name}:deleteExecutionHistory",
220+
"request": {
221+
"$ref": "DeleteExecutionHistoryRequest"
222+
},
223+
"response": {
224+
"$ref": "Empty"
225+
},
226+
"scopes": [
227+
"https://www.googleapis.com/auth/cloud-platform"
228+
]
229+
},
202230
"exportData": {
203231
"description": "Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods.",
204232
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}:exportData",
@@ -384,6 +412,22 @@
384412
"pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+/stepEntries/[^/]+$",
385413
"required": true,
386414
"type": "string"
415+
},
416+
"view": {
417+
"deprecated": true,
418+
"description": "Deprecated field.",
419+
"enum": [
420+
"EXECUTION_ENTRY_VIEW_UNSPECIFIED",
421+
"EXECUTION_ENTRY_VIEW_BASIC",
422+
"EXECUTION_ENTRY_VIEW_DETAILED"
423+
],
424+
"enumDescriptions": [
425+
"The default/unset value.",
426+
"Include basic information in the step entries. All fields in StepEntry are returned except for variable_data.",
427+
"Include all data."
428+
],
429+
"location": "query",
430+
"type": "string"
387431
}
388432
},
389433
"path": "v1/{+name}",
@@ -404,7 +448,7 @@
404448
],
405449
"parameters": {
406450
"filter": {
407-
"description": "Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The following fields are supported for filtering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state=\"SUCCEEDED\"` or `createTime>\"2023-08-01\" AND state=\"FAILED\"`",
451+
"description": "Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The following fields are supported for filtering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `parent`, `state`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state=\"SUCCEEDED\"` or `createTime>\"2023-08-01\" AND state=\"FAILED\"`",
408452
"location": "query",
409453
"type": "string"
410454
},
@@ -425,7 +469,7 @@
425469
"type": "string"
426470
},
427471
"parent": {
428-
"description": "Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/",
472+
"description": "Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}",
429473
"location": "path",
430474
"pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$",
431475
"required": true,
@@ -436,6 +480,22 @@
436480
"format": "int32",
437481
"location": "query",
438482
"type": "integer"
483+
},
484+
"view": {
485+
"deprecated": true,
486+
"description": "Deprecated field.",
487+
"enum": [
488+
"EXECUTION_ENTRY_VIEW_UNSPECIFIED",
489+
"EXECUTION_ENTRY_VIEW_BASIC",
490+
"EXECUTION_ENTRY_VIEW_DETAILED"
491+
],
492+
"enumDescriptions": [
493+
"The default/unset value.",
494+
"Include basic information in the step entries. All fields in StepEntry are returned except for variable_data.",
495+
"Include all data."
496+
],
497+
"location": "query",
498+
"type": "string"
439499
}
440500
},
441501
"path": "v1/{+parent}/stepEntries",
@@ -457,7 +517,7 @@
457517
}
458518
}
459519
},
460-
"revision": "20240715",
520+
"revision": "20240813",
461521
"rootUrl": "https://workflowexecutions.googleapis.com/",
462522
"schemas": {
463523
"Callback": {
@@ -497,6 +557,18 @@
497557
"properties": {},
498558
"type": "object"
499559
},
560+
"DeleteExecutionHistoryRequest": {
561+
"description": "Request for the DeleteExecutionHistory method.",
562+
"id": "DeleteExecutionHistoryRequest",
563+
"properties": {},
564+
"type": "object"
565+
},
566+
"Empty": {
567+
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
568+
"id": "Empty",
569+
"properties": {},
570+
"type": "object"
571+
},
500572
"Error": {
501573
"description": "Error describes why the execution was abnormally terminated.",
502574
"id": "Error",
@@ -1012,6 +1084,11 @@
10121084
"format": "google-datetime",
10131085
"readOnly": true,
10141086
"type": "string"
1087+
},
1088+
"variableData": {
1089+
"$ref": "VariableData",
1090+
"description": "Output only. The VariableData associated to this step.",
1091+
"readOnly": true
10151092
}
10161093
},
10171094
"type": "object"
@@ -1080,6 +1157,20 @@
10801157
}
10811158
},
10821159
"type": "object"
1160+
},
1161+
"VariableData": {
1162+
"description": "VariableData contains the variable data for this step.",
1163+
"id": "VariableData",
1164+
"properties": {
1165+
"variables": {
1166+
"additionalProperties": {
1167+
"type": "any"
1168+
},
1169+
"description": "Variables that are associated with this step.",
1170+
"type": "object"
1171+
}
1172+
},
1173+
"type": "object"
10831174
}
10841175
},
10851176
"servicePath": "",

src/apis/workflowexecutions/v1.ts

Lines changed: 133 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,14 @@ export namespace workflowexecutions_v1 {
149149
* Request for the CancelExecution method.
150150
*/
151151
export interface Schema$CancelExecutionRequest {}
152+
/**
153+
* Request for the DeleteExecutionHistory method.
154+
*/
155+
export interface Schema$DeleteExecutionHistoryRequest {}
156+
/**
157+
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
158+
*/
159+
export interface Schema$Empty {}
152160
/**
153161
* Error describes why the execution was abnormally terminated.
154162
*/
@@ -468,6 +476,10 @@ export namespace workflowexecutions_v1 {
468476
* Output only. The most recently updated time of the step entry.
469477
*/
470478
updateTime?: string | null;
479+
/**
480+
* Output only. The VariableData associated to this step.
481+
*/
482+
variableData?: Schema$VariableData;
471483
}
472484
/**
473485
* StepEntryMetadata contains metadata information about this step.
@@ -511,6 +523,15 @@ export namespace workflowexecutions_v1 {
511523
*/
512524
subscription?: string | null;
513525
}
526+
/**
527+
* VariableData contains the variable data for this step.
528+
*/
529+
export interface Schema$VariableData {
530+
/**
531+
* Variables that are associated with this step.
532+
*/
533+
variables?: {[key: string]: any} | null;
534+
}
514535

515536
export class Resource$Projects {
516537
context: APIRequestContext;
@@ -839,6 +860,96 @@ export namespace workflowexecutions_v1 {
839860
}
840861
}
841862

863+
/**
864+
* Deletes all step entries for an execution.
865+
*
866+
* @param params - Parameters for request
867+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
868+
* @param callback - Optional callback that handles the response.
869+
* @returns A promise if used with async/await, or void if used with a callback.
870+
*/
871+
deleteExecutionHistory(
872+
params: Params$Resource$Projects$Locations$Workflows$Executions$Deleteexecutionhistory,
873+
options: StreamMethodOptions
874+
): GaxiosPromise<Readable>;
875+
deleteExecutionHistory(
876+
params?: Params$Resource$Projects$Locations$Workflows$Executions$Deleteexecutionhistory,
877+
options?: MethodOptions
878+
): GaxiosPromise<Schema$Empty>;
879+
deleteExecutionHistory(
880+
params: Params$Resource$Projects$Locations$Workflows$Executions$Deleteexecutionhistory,
881+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
882+
callback: BodyResponseCallback<Readable>
883+
): void;
884+
deleteExecutionHistory(
885+
params: Params$Resource$Projects$Locations$Workflows$Executions$Deleteexecutionhistory,
886+
options: MethodOptions | BodyResponseCallback<Schema$Empty>,
887+
callback: BodyResponseCallback<Schema$Empty>
888+
): void;
889+
deleteExecutionHistory(
890+
params: Params$Resource$Projects$Locations$Workflows$Executions$Deleteexecutionhistory,
891+
callback: BodyResponseCallback<Schema$Empty>
892+
): void;
893+
deleteExecutionHistory(callback: BodyResponseCallback<Schema$Empty>): void;
894+
deleteExecutionHistory(
895+
paramsOrCallback?:
896+
| Params$Resource$Projects$Locations$Workflows$Executions$Deleteexecutionhistory
897+
| BodyResponseCallback<Schema$Empty>
898+
| BodyResponseCallback<Readable>,
899+
optionsOrCallback?:
900+
| MethodOptions
901+
| StreamMethodOptions
902+
| BodyResponseCallback<Schema$Empty>
903+
| BodyResponseCallback<Readable>,
904+
callback?:
905+
| BodyResponseCallback<Schema$Empty>
906+
| BodyResponseCallback<Readable>
907+
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
908+
let params = (paramsOrCallback ||
909+
{}) as Params$Resource$Projects$Locations$Workflows$Executions$Deleteexecutionhistory;
910+
let options = (optionsOrCallback || {}) as MethodOptions;
911+
912+
if (typeof paramsOrCallback === 'function') {
913+
callback = paramsOrCallback;
914+
params =
915+
{} as Params$Resource$Projects$Locations$Workflows$Executions$Deleteexecutionhistory;
916+
options = {};
917+
}
918+
919+
if (typeof optionsOrCallback === 'function') {
920+
callback = optionsOrCallback;
921+
options = {};
922+
}
923+
924+
const rootUrl =
925+
options.rootUrl || 'https://workflowexecutions.googleapis.com/';
926+
const parameters = {
927+
options: Object.assign(
928+
{
929+
url: (rootUrl + '/v1/{+name}:deleteExecutionHistory').replace(
930+
/([^:]\/)\/+/g,
931+
'$1'
932+
),
933+
method: 'POST',
934+
apiVersion: '',
935+
},
936+
options
937+
),
938+
params,
939+
requiredParams: ['name'],
940+
pathParams: ['name'],
941+
context: this.context,
942+
};
943+
if (callback) {
944+
createAPIRequest<Schema$Empty>(
945+
parameters,
946+
callback as BodyResponseCallback<unknown>
947+
);
948+
} else {
949+
return createAPIRequest<Schema$Empty>(parameters);
950+
}
951+
}
952+
842953
/**
843954
* Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods.
844955
*
@@ -1139,6 +1250,18 @@ export namespace workflowexecutions_v1 {
11391250
*/
11401251
requestBody?: Schema$Execution;
11411252
}
1253+
export interface Params$Resource$Projects$Locations$Workflows$Executions$Deleteexecutionhistory
1254+
extends StandardParameters {
1255+
/**
1256+
* Required. Name of the execution for which step entries should be deleted. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}/executions/{execution\}
1257+
*/
1258+
name?: string;
1259+
1260+
/**
1261+
* Request body metadata
1262+
*/
1263+
requestBody?: Schema$DeleteExecutionHistoryRequest;
1264+
}
11421265
export interface Params$Resource$Projects$Locations$Workflows$Executions$Exportdata
11431266
extends StandardParameters {
11441267
/**
@@ -1498,11 +1621,15 @@ export namespace workflowexecutions_v1 {
14981621
* Required. The name of the step entry to retrieve. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}/executions/{execution\}/stepEntries/{step_entry\}
14991622
*/
15001623
name?: string;
1624+
/**
1625+
* Deprecated field.
1626+
*/
1627+
view?: string;
15011628
}
15021629
export interface Params$Resource$Projects$Locations$Workflows$Executions$Stepentries$List
15031630
extends StandardParameters {
15041631
/**
1505-
* Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The following fields are supported for filtering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `createTime\>"2023-08-01" AND state="FAILED"`
1632+
* Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The following fields are supported for filtering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `parent`, `state`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `createTime\>"2023-08-01" AND state="FAILED"`
15061633
*/
15071634
filter?: string;
15081635
/**
@@ -1518,12 +1645,16 @@ export namespace workflowexecutions_v1 {
15181645
*/
15191646
pageToken?: string;
15201647
/**
1521-
* Required. Name of the workflow execution to list entries for. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}/executions/{execution\}/stepEntries/
1648+
* Required. Name of the workflow execution to list entries for. Format: projects/{project\}/locations/{location\}/workflows/{workflow\}/executions/{execution\}
15221649
*/
15231650
parent?: string;
15241651
/**
15251652
* Optional. The number of step entries to skip. It can be used with or without a pageToken. If used with a pageToken, then it indicates the number of step entries to skip starting from the requested page.
15261653
*/
15271654
skip?: number;
1655+
/**
1656+
* Deprecated field.
1657+
*/
1658+
view?: string;
15281659
}
15291660
}

0 commit comments

Comments
 (0)