Types overview

Error

Error describes why the execution was abnormally terminated.
Fields
context

string

Human-readable stack trace string.
payload

string

Error message and data returned represented as a JSON string.
stackTrace

object (StackTrace)

Stack trace with detailed information of where error was generated.

Execution

A running instance of a Workflow.
Fields
argument

string

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 argument. Example: '{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'
callLogLevel

enum

The call logging level associated to this execution.
Enum type. Can be one of the following:
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.
endTime

string (Timestamp format)

Output only. Marks the end of execution, successful or not.
error

object (Error)

Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is FAILED or CANCELLED.
name

string

Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
result

string

Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is SUCCEEDED.
startTime

string (Timestamp format)

Output only. Marks the beginning of execution.
state

enum

Output only. Current state of the execution.
Enum type. Can be one of the following:
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.
UNAVAILABLE Reserved for future use.
QUEUED Request has been placed in the backlog for processing at a later time.
status

object (Status)

Output only. Status tracks the current steps and progress data of this execution.
workflowRevisionId

string

Output only. Revision of the workflow this execution is using.

ListExecutionsResponse

Response for the ListExecutions method.
Fields
executions[]

object (Execution)

The executions which match the request.
nextPageToken

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

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.
Fields
column

string (int64 format)

The source code column position (of the line) the current instruction was generated from.
length

string (int64 format)

The number of bytes of source code making up this stack trace element.
line

string (int64 format)

The source code line number the current instruction was generated from.

StackTrace

A collection of stack elements (frames) where an error occurred.
Fields
elements[]

object (StackTraceElement)

An array of stack elements.

StackTraceElement

A single stack element (frame) where an error occurred.
Fields
position

object (Position)

The source position information of the stack trace element.
routine

string

The routine where the error occurred.
step

string

The step the error occurred at.

Status

Represents the current status of this execution.
Fields
currentSteps[]

object (Step)

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.

Step

Represents a step of the workflow this execution is running.
Fields
routine

string

Name of a routine within the workflow.
step

string

Name of a step within the routine.