You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
name: string, Required. The name of the step entry to retrieve. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry} (required)
101
+
x__xgafv: string, V1 error format.
102
+
Allowed values
103
+
1 - v1 error format
104
+
2 - v2 error format
105
+
106
+
Returns:
107
+
An object of the form:
108
+
109
+
{ # An StepEntry contains debugging information for a step transition in a workflow execution.
110
+
"createTime": "A String", # Output only. The creation time of the step entry.
111
+
"entryId": "A String", # Output only. The numeric ID of this step entry, used for navigation.
112
+
"exception": { # Exception describes why the step entry failed. # Output only. The exception thrown by the step entry.
113
+
"payload": "A String", # Error message represented as a JSON string.
114
+
},
115
+
"name": "A String", # Output only. The full resource name of the step entry. Each step entry has a unique entry ID, which is a monotonically increasing counter. Step entry names have the format: `projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry}`.
116
+
"navigationInfo": { # NavigationInfo describes what steps if any come before or after this step, or what steps are parents or children of this step. # Output only. The NavigationInfo associated to this step.
117
+
"children": [ # Step entries that can be reached by "stepping into" e.g. a subworkflow call.
118
+
"A String",
119
+
],
120
+
"next": "A String", # The index of the next step in the current workflow, if any.
121
+
"parent": "A String", # The step entry, if any, that can be reached by "stepping out" of the current workflow being executed.
122
+
"previous": "A String", # The index of the previous step in the current workflow, if any.
123
+
},
124
+
"routine": "A String", # Output only. The name of the routine this step entry belongs to. A routine name is the subworkflow name defined in the YAML source code. The top level routine name is `main`.
125
+
"state": "A String", # Output only. The state of the step entry.
126
+
"step": "A String", # Output only. The name of the step this step entry belongs to.
127
+
"stepEntryMetadata": { # StepEntryMetadata contains metadata information about this step. # Output only. The StepEntryMetadata associated to this step.
128
+
"progressNumber": "A String", # Progress number represents the current state of the current progress. eg: A step entry represents the 4th iteration in a progress of PROGRESS_TYPE_FOR.
129
+
"progressType": "A String", # Progress type of this step entry.
130
+
"threadId": "A String", # Child thread id that this step entry belongs to.
131
+
},
132
+
"stepType": "A String", # Output only. The type of the step this step entry belongs to.
133
+
"updateTime": "A String", # Output only. The most recently updated time of the step entry.
<pre>Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.
140
+
141
+
Args:
142
+
parent: string, Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/ (required)
143
+
filter: string, 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"`
144
+
orderBy: string, Optional. Comma-separated list of fields that specify the ordering applied to the `[StepEntries.ListStepEntries]` results. By default the ordering is based on ascending `entryId`. The following fields are supported for ordering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-132.
145
+
pageSize: integer, Optional. Number of step entries to return per call. The default max is 1000.
146
+
pageToken: string, Optional. A page token, received from a previous `ListStepEntries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStepEntries` must match the call that provided the page token.
147
+
skip: integer, 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.
148
+
x__xgafv: string, V1 error format.
149
+
Allowed values
150
+
1 - v1 error format
151
+
2 - v2 error format
152
+
153
+
Returns:
154
+
An object of the form:
155
+
156
+
{ # Response message for ExecutionHistory.ListStepEntries.
157
+
"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the ListStepEntriesRequest.page_token field in the subsequent call to `ListStepEntries` method to retrieve the next page of results.
158
+
"stepEntries": [ # The list of entries.
159
+
{ # An StepEntry contains debugging information for a step transition in a workflow execution.
160
+
"createTime": "A String", # Output only. The creation time of the step entry.
161
+
"entryId": "A String", # Output only. The numeric ID of this step entry, used for navigation.
162
+
"exception": { # Exception describes why the step entry failed. # Output only. The exception thrown by the step entry.
163
+
"payload": "A String", # Error message represented as a JSON string.
164
+
},
165
+
"name": "A String", # Output only. The full resource name of the step entry. Each step entry has a unique entry ID, which is a monotonically increasing counter. Step entry names have the format: `projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry}`.
166
+
"navigationInfo": { # NavigationInfo describes what steps if any come before or after this step, or what steps are parents or children of this step. # Output only. The NavigationInfo associated to this step.
167
+
"children": [ # Step entries that can be reached by "stepping into" e.g. a subworkflow call.
168
+
"A String",
169
+
],
170
+
"next": "A String", # The index of the next step in the current workflow, if any.
171
+
"parent": "A String", # The step entry, if any, that can be reached by "stepping out" of the current workflow being executed.
172
+
"previous": "A String", # The index of the previous step in the current workflow, if any.
173
+
},
174
+
"routine": "A String", # Output only. The name of the routine this step entry belongs to. A routine name is the subworkflow name defined in the YAML source code. The top level routine name is `main`.
175
+
"state": "A String", # Output only. The state of the step entry.
176
+
"step": "A String", # Output only. The name of the step this step entry belongs to.
177
+
"stepEntryMetadata": { # StepEntryMetadata contains metadata information about this step. # Output only. The StepEntryMetadata associated to this step.
178
+
"progressNumber": "A String", # Progress number represents the current state of the current progress. eg: A step entry represents the 4th iteration in a progress of PROGRESS_TYPE_FOR.
179
+
"progressType": "A String", # Progress type of this step entry.
180
+
"threadId": "A String", # Child thread id that this step entry belongs to.
181
+
},
182
+
"stepType": "A String", # Output only. The type of the step this step entry belongs to.
183
+
"updateTime": "A String", # Output only. The most recently updated time of the step entry.
184
+
},
185
+
],
186
+
"totalSize": 42, # Indicates the total number of StepEntries that matched the request filter. For running executions, this number shows the number of StepEntries that are executed thus far.
0 commit comments