Resource: StepEntry
An information entry that can assist in debugging a step in a workflow execution.
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "routine": string, "step": string, "stepType": enum ( |
Fields | |
---|---|
name |
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: |
createTime |
Output only. The creation time of the step entry. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution, and up to nine fractional digits. Examples: |
updateTime |
Output only. The most recently updated time of the step entry. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution, and up to nine fractional digits. Examples: |
routine |
Output only. The name of the routine this step entry belongs to. A routine name is the subworkflow name defined in the YAML or JSON source code. The top level routine name is |
step |
Output only. The name of the step this step entry belongs to. |
stepType |
Output only. The type of the step this step entry belongs to. |
state |
Output only. The state of the step entry. |
exception |
Output only. The exception thrown by the step entry. |
entryId |
Output only. The numeric ID of this step entry, used for navigation. |
navigationInfo |
Output only. The |
stepEntryMetadata |
Output only. The |
StepType
Describes the type of step this step entry belongs to.
Enums | |
---|---|
STEP_TYPE_UNSPECIFIED |
Invalid step type. |
STEP_ASSIGN |
The step entry assigns a variable. |
STEP_CALL |
The step entry calls a subworkflow or standard library routine. |
STEP_SWITCH |
The step entry executes a switch-case block. |
STEP_CONDITION |
The step entry executes a condition inside a switch. |
STEP_FOR |
The step entry executes a for loop. |
STEP_FOR_ITERATION |
The step entry executes an iteration of a for loop. |
STEP_PARALLEL_FOR |
The step entry executes a parallel for loop. |
STEP_PARALLEL_BRANCH |
The step entry executes a series of parallel branches. |
STEP_PARALLEL_BRANCH_ENTRY |
The step entry executes a branch of a parallel branch. |
STEP_TRY_RETRY_EXCEPT |
The step entry executes a try/retry/except block. |
STEP_TRY |
The step entry executes the try part of a try/retry/except block. |
STEP_RETRY |
The step entry executes the retry part of a try/retry/except block. |
STEP_EXCEPT |
The step entry executes the except part of a try/retry/except block. |
STEP_RETURN |
The step entry returns. |
STEP_RAISE |
The step entry raises an error. |
STEP_GOTO |
The step entry jumps to another step. |
State
Describes the current state of the step entry.
Enums | |
---|---|
STATE_UNSPECIFIED |
Invalid state. |
STATE_IN_PROGRESS |
The step entry is in progress. |
STATE_SUCCEEDED |
The step entry finished successfully. |
STATE_FAILED |
The step entry failed with an error. |
Exception
Describes why the step entry failed.
JSON representation |
---|
{ "payload": string } |
Fields | |
---|---|
payload |
Error message represented as a JSON string. |
StepEntryMetadata
Contains metadata information about this step.
JSON representation |
---|
{
"threadId": string,
"progressType": enum ( |
Fields | |
---|---|
threadId |
Child thread ID that this step entry belongs to. |
progressType |
Progress type of this step entry. |
progressNumber |
Indicates the current state of the step entry progress. For example, the fourth iteration of a |
ProgressType
Describes the progress type of this step entry.
Enums | |
---|---|
PROGRESS_TYPE_UNSPECIFIED |
Current step entry does not have any progress data. |
PROGRESS_TYPE_FOR |
A for step is in progress for the current step entry. |
PROGRESS_TYPE_SWITCH |
A switch step is in progress for the current step entry. |
PROGRESS_TYPE_RETRY |
A retry step is in progress for the current step entry. |
PROGRESS_TYPE_PARALLEL_FOR |
A parallel for step is in progress for the current step entry. |
PROGRESS_TYPE_PARALLEL_BRANCH |
A parallel branch step is in progress for the current step entry. |
Methods |
|
---|---|
|
Returns a step entry for a workflow execution. |
|
Returns a list of step entries for a workflow execution. |