Skip to content

Commit 3e91e2f

Browse files
yoshi-automationsofisl
authored andcommitted
feat(workflowexecutions): update the API
#### workflowexecutions:v1beta The following keys were added: - schemas.Execution.properties.status.$ref - schemas.Execution.properties.status.description - schemas.Execution.properties.status.readOnly - schemas.Status.description - schemas.Status.id - schemas.Status.properties.currentSteps.description - schemas.Status.properties.currentSteps.items.$ref - schemas.Status.properties.currentSteps.type - schemas.Status.type - schemas.Step.description - schemas.Step.id - schemas.Step.properties.routine.description - schemas.Step.properties.routine.type - schemas.Step.properties.step.description - schemas.Step.properties.step.type - schemas.Step.type #### workflowexecutions:v1 The following keys were added: - schemas.Execution.properties.status.$ref - schemas.Execution.properties.status.description - schemas.Execution.properties.status.readOnly - schemas.Status.description - schemas.Status.id - schemas.Status.properties.currentSteps.description - schemas.Status.properties.currentSteps.items.$ref - schemas.Status.properties.currentSteps.type - schemas.Status.type - schemas.Step.description - schemas.Step.id - schemas.Step.properties.routine.description - schemas.Step.properties.routine.type - schemas.Step.properties.step.description - schemas.Step.properties.step.type - schemas.Step.type The following keys were changed: - resources.projects.resources.locations.resources.workflows.resources.executions.methods.list.parameters.pageSize.description
1 parent 463dc0c commit 3e91e2f

File tree

5 files changed

+135
-6
lines changed

5 files changed

+135
-6
lines changed

discovery/workflowexecutions-v1.json

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@
249249
],
250250
"parameters": {
251251
"pageSize": {
252-
"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.",
252+
"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.",
253253
"format": "int32",
254254
"location": "query",
255255
"type": "integer"
@@ -299,7 +299,7 @@
299299
}
300300
}
301301
},
302-
"revision": "20220426",
302+
"revision": "20220908",
303303
"rootUrl": "https://workflowexecutions.googleapis.com/",
304304
"schemas": {
305305
"CancelExecutionRequest": {
@@ -395,6 +395,11 @@
395395
"readOnly": true,
396396
"type": "string"
397397
},
398+
"status": {
399+
"$ref": "Status",
400+
"description": "Output only. Status tracks the current steps and progress data of this execution. > **Preview:** This field is covered by the > [Pre-GA Offerings Terms](https://cloud.google.com/terms/service-terms) of > the Google Cloud Terms of Service. Pre-GA features might have limited > support, and changes to pre-GA features might not be compatible with > other pre-GA versions. For more information, see the > [launch stage descriptions](https://cloud.google.com/products#product-launch-stages). > This field is usable only if your project has access. See the > [access request page](https://docs.google.com/forms/d/e/1FAIpQLSdgwrSV8Y4xZv_tvI6X2JEGX1-ty9yizv3_EAOVHWVKXvDLEA/viewform).",
401+
"readOnly": true
402+
},
398403
"workflowRevisionId": {
399404
"description": "Output only. Revision of the workflow this execution is using.",
400405
"readOnly": true,
@@ -508,6 +513,35 @@
508513
},
509514
"type": "object"
510515
},
516+
"Status": {
517+
"description": "> **Preview:** This field is covered by the > [Pre-GA Offerings Terms](https://cloud.google.com/terms/service-terms) of > the Google Cloud Terms of Service. Pre-GA features might have limited > support, and changes to pre-GA features might not be compatible with > other pre-GA versions. For more information, see the > [launch stage descriptions](https://cloud.google.com/products#product-launch-stages). > This field is usable only if your project has access. See the > [access request page](https://docs.google.com/forms/d/e/1FAIpQLSdgwrSV8Y4xZv_tvI6X2JEGX1-ty9yizv3_EAOVHWVKXvDLEA/viewform). Represents the current status of this execution.",
518+
"id": "Status",
519+
"properties": {
520+
"currentSteps": {
521+
"description": "A list of currently executing or last executed step names for the workflow execution currently running. If the workflow has succeeded or failed, this is the last attempted or executed step. Presently, if the current step is inside a subworkflow, the list only includes that step. In the future, the list will contain items for each step in the call stack, starting with the outermost step in the `main` subworkflow, and ending with the most deeply nested step.",
522+
"items": {
523+
"$ref": "Step"
524+
},
525+
"type": "array"
526+
}
527+
},
528+
"type": "object"
529+
},
530+
"Step": {
531+
"description": "Represents a step of the workflow this execution is running.",
532+
"id": "Step",
533+
"properties": {
534+
"routine": {
535+
"description": "Name of a routine within the workflow.",
536+
"type": "string"
537+
},
538+
"step": {
539+
"description": "Name of a step within the routine.",
540+
"type": "string"
541+
}
542+
},
543+
"type": "object"
544+
},
511545
"TriggerPubsubExecutionRequest": {
512546
"description": "Request for the TriggerPubsubExecution method.",
513547
"id": "TriggerPubsubExecutionRequest",

discovery/workflowexecutions-v1beta.json

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@
269269
}
270270
}
271271
},
272-
"revision": "20211019",
272+
"revision": "20220908",
273273
"rootUrl": "https://workflowexecutions.googleapis.com/",
274274
"schemas": {
275275
"CancelExecutionRequest": {
@@ -365,6 +365,11 @@
365365
"readOnly": true,
366366
"type": "string"
367367
},
368+
"status": {
369+
"$ref": "Status",
370+
"description": "Output only. Status tracks the current steps and progress data of this execution. > **Preview:** This field is covered by the > [Pre-GA Offerings Terms](https://cloud.google.com/terms/service-terms) of > the Google Cloud Terms of Service. Pre-GA features might have limited > support, and changes to pre-GA features might not be compatible with > other pre-GA versions. For more information, see the > [launch stage descriptions](https://cloud.google.com/products#product-launch-stages). > This field is usable only if your project has access. See the > [access request page](https://docs.google.com/forms/d/e/1FAIpQLSdgwrSV8Y4xZv_tvI6X2JEGX1-ty9yizv3_EAOVHWVKXvDLEA/viewform).",
371+
"readOnly": true
372+
},
368373
"workflowRevisionId": {
369374
"description": "Output only. Revision of the workflow this execution is using.",
370375
"readOnly": true,
@@ -445,6 +450,35 @@
445450
}
446451
},
447452
"type": "object"
453+
},
454+
"Status": {
455+
"description": "> **Preview:** This field is covered by the > [Pre-GA Offerings Terms](https://cloud.google.com/terms/service-terms) of > the Google Cloud Terms of Service. Pre-GA features might have limited > support, and changes to pre-GA features might not be compatible with > other pre-GA versions. For more information, see the > [launch stage descriptions](https://cloud.google.com/products#product-launch-stages). > This field is usable only if your project has access. See the > [access request page](https://docs.google.com/forms/d/e/1FAIpQLSdgwrSV8Y4xZv_tvI6X2JEGX1-ty9yizv3_EAOVHWVKXvDLEA/viewform). Represents the current status of this execution.",
456+
"id": "Status",
457+
"properties": {
458+
"currentSteps": {
459+
"description": "A list of currently executing or last executed step names for the workflow execution currently running. If the workflow has succeeded or failed, this is the last attempted or executed step. Presently, if the current step is inside a subworkflow, the list only includes that step. In the future, the list will contain items for each step in the call stack, starting with the outermost step in the `main` subworkflow, and ending with the most deeply nested step.",
460+
"items": {
461+
"$ref": "Step"
462+
},
463+
"type": "array"
464+
}
465+
},
466+
"type": "object"
467+
},
468+
"Step": {
469+
"description": "Represents a step of the workflow this execution is running.",
470+
"id": "Step",
471+
"properties": {
472+
"routine": {
473+
"description": "Name of a routine within the workflow.",
474+
"type": "string"
475+
},
476+
"step": {
477+
"description": "Name of a step within the routine.",
478+
"type": "string"
479+
}
480+
},
481+
"type": "object"
448482
}
449483
},
450484
"servicePath": "",

src/apis/workflowexecutions/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"webpack": "webpack"
2929
},
3030
"dependencies": {
31-
"googleapis-common": "^5.0.1"
31+
"googleapis-common": "^6.0.3"
3232
},
3333
"devDependencies": {
3434
"@microsoft/api-documenter": "^7.8.10",

src/apis/workflowexecutions/v1.ts

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,10 @@ export namespace workflowexecutions_v1 {
181181
* Output only. Current state of the execution.
182182
*/
183183
state?: string | null;
184+
/**
185+
* Output only. Status tracks the current steps and progress data of this execution. \> **Preview:** This field is covered by the \> [Pre-GA Offerings Terms](https://cloud.google.com/terms/service-terms) of \> the Google Cloud Terms of Service. Pre-GA features might have limited \> support, and changes to pre-GA features might not be compatible with \> other pre-GA versions. For more information, see the \> [launch stage descriptions](https://cloud.google.com/products#product-launch-stages). \> This field is usable only if your project has access. See the \> [access request page](https://docs.google.com/forms/d/e/1FAIpQLSdgwrSV8Y4xZv_tvI6X2JEGX1-ty9yizv3_EAOVHWVKXvDLEA/viewform).
186+
*/
187+
status?: Schema$Status;
184188
/**
185189
* Output only. Revision of the workflow this execution is using.
186190
*/
@@ -267,6 +271,28 @@ export namespace workflowexecutions_v1 {
267271
*/
268272
step?: string | null;
269273
}
274+
/**
275+
* \> **Preview:** This field is covered by the \> [Pre-GA Offerings Terms](https://cloud.google.com/terms/service-terms) of \> the Google Cloud Terms of Service. Pre-GA features might have limited \> support, and changes to pre-GA features might not be compatible with \> other pre-GA versions. For more information, see the \> [launch stage descriptions](https://cloud.google.com/products#product-launch-stages). \> This field is usable only if your project has access. See the \> [access request page](https://docs.google.com/forms/d/e/1FAIpQLSdgwrSV8Y4xZv_tvI6X2JEGX1-ty9yizv3_EAOVHWVKXvDLEA/viewform). Represents the current status of this execution.
276+
*/
277+
export interface Schema$Status {
278+
/**
279+
* A list of currently executing or last executed step names for the workflow execution currently running. If the workflow has succeeded or failed, this is the last attempted or executed step. Presently, if the current step is inside a subworkflow, the list only includes that step. In the future, the list will contain items for each step in the call stack, starting with the outermost step in the `main` subworkflow, and ending with the most deeply nested step.
280+
*/
281+
currentSteps?: Schema$Step[];
282+
}
283+
/**
284+
* Represents a step of the workflow this execution is running.
285+
*/
286+
export interface Schema$Step {
287+
/**
288+
* Name of a routine within the workflow.
289+
*/
290+
routine?: string | null;
291+
/**
292+
* Name of a step within the routine.
293+
*/
294+
step?: string | null;
295+
}
270296
/**
271297
* Request for the TriggerPubsubExecution method.
272298
*/
@@ -369,6 +395,7 @@ export namespace workflowexecutions_v1 {
369395
* // "result": "my_result",
370396
* // "startTime": "my_startTime",
371397
* // "state": "my_state",
398+
* // "status": {},
372399
* // "workflowRevisionId": "my_workflowRevisionId"
373400
* // }
374401
* }
@@ -537,6 +564,7 @@ export namespace workflowexecutions_v1 {
537564
* // "result": "my_result",
538565
* // "startTime": "my_startTime",
539566
* // "state": "my_state",
567+
* // "status": {},
540568
* // "workflowRevisionId": "my_workflowRevisionId"
541569
* // }
542570
* }
@@ -674,6 +702,7 @@ export namespace workflowexecutions_v1 {
674702
* // "result": "my_result",
675703
* // "startTime": "my_startTime",
676704
* // "state": "my_state",
705+
* // "status": {},
677706
* // "workflowRevisionId": "my_workflowRevisionId"
678707
* // }
679708
* },
@@ -690,6 +719,7 @@ export namespace workflowexecutions_v1 {
690719
* // "result": "my_result",
691720
* // "startTime": "my_startTime",
692721
* // "state": "my_state",
722+
* // "status": {},
693723
* // "workflowRevisionId": "my_workflowRevisionId"
694724
* // }
695725
* }
@@ -832,6 +862,7 @@ export namespace workflowexecutions_v1 {
832862
* // "result": "my_result",
833863
* // "startTime": "my_startTime",
834864
* // "state": "my_state",
865+
* // "status": {},
835866
* // "workflowRevisionId": "my_workflowRevisionId"
836867
* // }
837868
* }
@@ -954,7 +985,7 @@ export namespace workflowexecutions_v1 {
954985
* // Do the magic
955986
* const res =
956987
* await workflowexecutions.projects.locations.workflows.executions.list({
957-
* // 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.
988+
* // 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.
958989
* pageSize: 'placeholder-value',
959990
* // 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.
960991
* pageToken: 'placeholder-value',
@@ -1109,7 +1140,7 @@ export namespace workflowexecutions_v1 {
11091140
export interface Params$Resource$Projects$Locations$Workflows$Executions$List
11101141
extends StandardParameters {
11111142
/**
1112-
* 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.
1143+
* 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.
11131144
*/
11141145
pageSize?: number;
11151146
/**

src/apis/workflowexecutions/v1beta.ts

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,10 @@ export namespace workflowexecutions_v1beta {
181181
* Output only. Current state of the execution.
182182
*/
183183
state?: string | null;
184+
/**
185+
* Output only. Status tracks the current steps and progress data of this execution. \> **Preview:** This field is covered by the \> [Pre-GA Offerings Terms](https://cloud.google.com/terms/service-terms) of \> the Google Cloud Terms of Service. Pre-GA features might have limited \> support, and changes to pre-GA features might not be compatible with \> other pre-GA versions. For more information, see the \> [launch stage descriptions](https://cloud.google.com/products#product-launch-stages). \> This field is usable only if your project has access. See the \> [access request page](https://docs.google.com/forms/d/e/1FAIpQLSdgwrSV8Y4xZv_tvI6X2JEGX1-ty9yizv3_EAOVHWVKXvDLEA/viewform).
186+
*/
187+
status?: Schema$Status;
184188
/**
185189
* Output only. Revision of the workflow this execution is using.
186190
*/
@@ -242,6 +246,28 @@ export namespace workflowexecutions_v1beta {
242246
*/
243247
step?: string | null;
244248
}
249+
/**
250+
* \> **Preview:** This field is covered by the \> [Pre-GA Offerings Terms](https://cloud.google.com/terms/service-terms) of \> the Google Cloud Terms of Service. Pre-GA features might have limited \> support, and changes to pre-GA features might not be compatible with \> other pre-GA versions. For more information, see the \> [launch stage descriptions](https://cloud.google.com/products#product-launch-stages). \> This field is usable only if your project has access. See the \> [access request page](https://docs.google.com/forms/d/e/1FAIpQLSdgwrSV8Y4xZv_tvI6X2JEGX1-ty9yizv3_EAOVHWVKXvDLEA/viewform). Represents the current status of this execution.
251+
*/
252+
export interface Schema$Status {
253+
/**
254+
* A list of currently executing or last executed step names for the workflow execution currently running. If the workflow has succeeded or failed, this is the last attempted or executed step. Presently, if the current step is inside a subworkflow, the list only includes that step. In the future, the list will contain items for each step in the call stack, starting with the outermost step in the `main` subworkflow, and ending with the most deeply nested step.
255+
*/
256+
currentSteps?: Schema$Step[];
257+
}
258+
/**
259+
* Represents a step of the workflow this execution is running.
260+
*/
261+
export interface Schema$Step {
262+
/**
263+
* Name of a routine within the workflow.
264+
*/
265+
routine?: string | null;
266+
/**
267+
* Name of a step within the routine.
268+
*/
269+
step?: string | null;
270+
}
245271

246272
export class Resource$Projects {
247273
context: APIRequestContext;
@@ -327,6 +353,7 @@ export namespace workflowexecutions_v1beta {
327353
* // "result": "my_result",
328354
* // "startTime": "my_startTime",
329355
* // "state": "my_state",
356+
* // "status": {},
330357
* // "workflowRevisionId": "my_workflowRevisionId"
331358
* // }
332359
* }
@@ -467,6 +494,7 @@ export namespace workflowexecutions_v1beta {
467494
* // "result": "my_result",
468495
* // "startTime": "my_startTime",
469496
* // "state": "my_state",
497+
* // "status": {},
470498
* // "workflowRevisionId": "my_workflowRevisionId"
471499
* // }
472500
* },
@@ -483,6 +511,7 @@ export namespace workflowexecutions_v1beta {
483511
* // "result": "my_result",
484512
* // "startTime": "my_startTime",
485513
* // "state": "my_state",
514+
* // "status": {},
486515
* // "workflowRevisionId": "my_workflowRevisionId"
487516
* // }
488517
* }
@@ -625,6 +654,7 @@ export namespace workflowexecutions_v1beta {
625654
* // "result": "my_result",
626655
* // "startTime": "my_startTime",
627656
* // "state": "my_state",
657+
* // "status": {},
628658
* // "workflowRevisionId": "my_workflowRevisionId"
629659
* // }
630660
* }

0 commit comments

Comments
 (0)