Skip to content

Commit 843c8ce

Browse files
feat(workflowexecutions): update the api
#### workflowexecutions:v1 The following keys were added: - schemas.Execution.properties.stateError (Total Keys: 2) - schemas.StateError (Total Keys: 4)
1 parent 4b98f4f commit 843c8ce

File tree

4 files changed

+58
-4
lines changed

4 files changed

+58
-4
lines changed

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,10 @@ <h3>Method Details</h3>
142142
&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`.
143143
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
144144
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the execution.
145+
&quot;stateError&quot;: { # Describes an error related to the current state of the Execution resource. # Output only. Error regarding the state of the Execution resource. For example, this field will have error details if the Execution data is unavailable due to revoked KMS key permissions.
146+
&quot;details&quot;: &quot;A String&quot;, # Provides specifics about the error.
147+
&quot;type&quot;: &quot;A String&quot;, # The type of this state error.
148+
},
145149
&quot;status&quot;: { # Represents the current status of this execution. # Output only. Status tracks the current steps and progress data of this execution.
146150
&quot;currentSteps&quot;: [ # 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.
147151
{ # Represents a step of the workflow this execution is running.
@@ -197,6 +201,10 @@ <h3>Method Details</h3>
197201
&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`.
198202
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
199203
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the execution.
204+
&quot;stateError&quot;: { # Describes an error related to the current state of the Execution resource. # Output only. Error regarding the state of the Execution resource. For example, this field will have error details if the Execution data is unavailable due to revoked KMS key permissions.
205+
&quot;details&quot;: &quot;A String&quot;, # Provides specifics about the error.
206+
&quot;type&quot;: &quot;A String&quot;, # The type of this state error.
207+
},
200208
&quot;status&quot;: { # Represents the current status of this execution. # Output only. Status tracks the current steps and progress data of this execution.
201209
&quot;currentSteps&quot;: [ # 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.
202210
{ # Represents a step of the workflow this execution is running.
@@ -245,6 +253,10 @@ <h3>Method Details</h3>
245253
&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`.
246254
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
247255
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the execution.
256+
&quot;stateError&quot;: { # Describes an error related to the current state of the Execution resource. # Output only. Error regarding the state of the Execution resource. For example, this field will have error details if the Execution data is unavailable due to revoked KMS key permissions.
257+
&quot;details&quot;: &quot;A String&quot;, # Provides specifics about the error.
258+
&quot;type&quot;: &quot;A String&quot;, # The type of this state error.
259+
},
248260
&quot;status&quot;: { # Represents the current status of this execution. # Output only. Status tracks the current steps and progress data of this execution.
249261
&quot;currentSteps&quot;: [ # 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.
250262
{ # Represents a step of the workflow this execution is running.
@@ -305,6 +317,10 @@ <h3>Method Details</h3>
305317
&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`.
306318
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
307319
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the execution.
320+
&quot;stateError&quot;: { # Describes an error related to the current state of the Execution resource. # Output only. Error regarding the state of the Execution resource. For example, this field will have error details if the Execution data is unavailable due to revoked KMS key permissions.
321+
&quot;details&quot;: &quot;A String&quot;, # Provides specifics about the error.
322+
&quot;type&quot;: &quot;A String&quot;, # The type of this state error.
323+
},
308324
&quot;status&quot;: { # Represents the current status of this execution. # Output only. Status tracks the current steps and progress data of this execution.
309325
&quot;currentSteps&quot;: [ # 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.
310326
{ # Represents a step of the workflow this execution is running.
@@ -371,6 +387,10 @@ <h3>Method Details</h3>
371387
&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`.
372388
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
373389
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the execution.
390+
&quot;stateError&quot;: { # Describes an error related to the current state of the Execution resource. # Output only. Error regarding the state of the Execution resource. For example, this field will have error details if the Execution data is unavailable due to revoked KMS key permissions.
391+
&quot;details&quot;: &quot;A String&quot;, # Provides specifics about the error.
392+
&quot;type&quot;: &quot;A String&quot;, # The type of this state error.
393+
},
374394
&quot;status&quot;: { # Represents the current status of this execution. # Output only. Status tracks the current steps and progress data of this execution.
375395
&quot;currentSteps&quot;: [ # 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.
376396
{ # Represents a step of the workflow this execution is running.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,10 @@ <h3>Method Details</h3>
151151
&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`.
152152
&quot;startTime&quot;: &quot;A String&quot;, # Output only. Marks the beginning of execution.
153153
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the execution.
154+
&quot;stateError&quot;: { # Describes an error related to the current state of the Execution resource. # Output only. Error regarding the state of the Execution resource. For example, this field will have error details if the Execution data is unavailable due to revoked KMS key permissions.
155+
&quot;details&quot;: &quot;A String&quot;, # Provides specifics about the error.
156+
&quot;type&quot;: &quot;A String&quot;, # The type of this state error.
157+
},
154158
&quot;status&quot;: { # Represents the current status of this execution. # Output only. Status tracks the current steps and progress data of this execution.
155159
&quot;currentSteps&quot;: [ # 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.
156160
{ # Represents a step of the workflow this execution is running.

googleapiclient/discovery_cache/documents/workflowexecutions.v1.json

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@
309309
}
310310
}
311311
},
312-
"revision": "20230323",
312+
"revision": "20230328",
313313
"rootUrl": "https://workflowexecutions.googleapis.com/",
314314
"schemas": {
315315
"CancelExecutionRequest": {
@@ -408,18 +408,25 @@
408408
"ACTIVE",
409409
"SUCCEEDED",
410410
"FAILED",
411-
"CANCELLED"
411+
"CANCELLED",
412+
"UNAVAILABLE"
412413
],
413414
"enumDescriptions": [
414415
"Invalid state.",
415416
"The execution is in progress.",
416417
"The execution finished successfully.",
417418
"The execution failed with an error.",
418-
"The execution was stopped intentionally."
419+
"The execution was stopped intentionally.",
420+
"Execution data is unavailable. See the `state_error` field."
419421
],
420422
"readOnly": true,
421423
"type": "string"
422424
},
425+
"stateError": {
426+
"$ref": "StateError",
427+
"description": "Output only. Error regarding the state of the Execution resource. For example, this field will have error details if the Execution data is unavailable due to revoked KMS key permissions.",
428+
"readOnly": true
429+
},
423430
"status": {
424431
"$ref": "Status",
425432
"description": "Output only. Status tracks the current steps and progress data of this execution.",
@@ -538,6 +545,29 @@
538545
},
539546
"type": "object"
540547
},
548+
"StateError": {
549+
"description": "Describes an error related to the current state of the Execution resource.",
550+
"id": "StateError",
551+
"properties": {
552+
"details": {
553+
"description": "Provides specifics about the error.",
554+
"type": "string"
555+
},
556+
"type": {
557+
"description": "The type of this state error.",
558+
"enum": [
559+
"TYPE_UNSPECIFIED",
560+
"KMS_ERROR"
561+
],
562+
"enumDescriptions": [
563+
"No type specified.",
564+
"Caused by an issue with KMS."
565+
],
566+
"type": "string"
567+
}
568+
},
569+
"type": "object"
570+
},
541571
"Status": {
542572
"description": "Represents the current status of this execution.",
543573
"id": "Status",

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": "20230323",
272+
"revision": "20230328",
273273
"rootUrl": "https://workflowexecutions.googleapis.com/",
274274
"schemas": {
275275
"CancelExecutionRequest": {

0 commit comments

Comments
 (0)