- Resource: Execution
- State
- Error
- StackTrace
- StackTraceElement
- Position
- CallLogLevel
- Status
- Step
- Methods
Resource: Execution
A running instance of a Workflow.
JSON representation |
---|
{ "name": string, "startTime": string, "endTime": string, "state": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} |
startTime |
Output only. Marks the beginning of execution. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
Output only. Marks the end of execution, successful or not. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
state |
Output only. Current state of the execution. |
argument |
Input parameters of the execution represented as a JSON string. The size limit is 32KB. Note: If you are using the REST API directly to run your workflow, you must escape any JSON string value of |
result |
Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is |
error |
Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is |
workflowRevisionId |
Output only. Revision of the workflow this execution is using. |
callLogLevel |
The call logging level associated to this execution. |
status |
Output only. Status tracks the current steps and progress data of this execution. |
State
Describes the current state of the execution. More states might be added in the future.
Enums | |
---|---|
STATE_UNSPECIFIED |
Invalid state. |
ACTIVE |
The execution is in progress. |
SUCCEEDED |
The execution finished successfully. |
FAILED |
The execution failed with an error. |
CANCELLED |
The execution was stopped intentionally. |
Error
Error describes why the execution was abnormally terminated.
JSON representation |
---|
{
"payload": string,
"context": string,
"stackTrace": {
object ( |
Fields | |
---|---|
payload |
Error message and data returned represented as a JSON string. |
context |
Human-readable stack trace string. |
stackTrace |
Stack trace with detailed information of where error was generated. |
StackTrace
A collection of stack elements (frames) where an error occurred.
JSON representation |
---|
{
"elements": [
{
object ( |
Fields | |
---|---|
elements[] |
An array of stack elements. |
StackTraceElement
A single stack element (frame) where an error occurred.
JSON representation |
---|
{
"step": string,
"routine": string,
"position": {
object ( |
Fields | |
---|---|
step |
The step the error occurred at. |
routine |
The routine where the error occurred. |
position |
The source position information of the stack trace element. |
Position
Position contains source position information about the stack trace element such as line number, column number and length of the code block in bytes.
JSON representation |
---|
{ "line": string, "column": string, "length": string } |
Fields | |
---|---|
line |
The source code line number the current instruction was generated from. |
column |
The source code column position (of the line) the current instruction was generated from. |
length |
The number of bytes of source code making up this stack trace element. |
CallLogLevel
Describes the level of platform logging to apply to calls and call responses during workflow executions.
Enums | |
---|---|
CALL_LOG_LEVEL_UNSPECIFIED |
No call logging level specified. |
LOG_ALL_CALLS |
Log all call steps within workflows, all call returns, and all exceptions raised. |
LOG_ERRORS_ONLY |
Log only exceptions that are raised from call steps within workflows. |
Status
Represents the current status of this execution.
JSON representation |
---|
{
"currentSteps": [
{
object ( |
Fields | |
---|---|
currentSteps[] |
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 |
Step
Represents a step of the workflow this execution is running.
JSON representation |
---|
{ "routine": string, "step": string } |
Fields | |
---|---|
routine |
Name of a routine within the workflow. |
step |
Name of a step within the routine. |
Methods |
|
---|---|
|
Cancels an execution of the given name. |
|
Creates a new execution using the latest revision of the given workflow. |
|
Returns an execution of the given name. |
|
Returns a list of executions which belong to the workflow with the given name. |