Types overview

Callback

An instance of a Callback created by an execution.
Fields
availablePayloads[]

string

Output only. The payloads received by the callback that have not been processed by a waiting execution step.
method

string

Output only. The method accepted by the callback. For example: GET, POST, PUT.
name

string

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

string (int64 format)

Output only. Number of execution steps waiting on this callback.

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.

Exception

Exception describes why the step entry failed.
Fields
payload

string

Error message represented as a JSON string.

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.
LOG_NONE Explicitly log nothing.
createTime

string (Timestamp format)

Output only. Marks the creation of the execution.
disableConcurrencyQuotaOverflowBuffering

boolean

Optional. If set to true, the execution will not be backlogged when the concurrency quota is exhausted. The backlog execution starts when the concurrency quota becomes available.
duration

string (Duration format)

Output only. Measures the duration of the execution.
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.
executionHistoryLevel

enum

Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution.
Enum type. Can be one of the following:
EXECUTION_HISTORY_LEVEL_UNSPECIFIED The default/unset value.
EXECUTION_HISTORY_BASIC Enable execution history basic feature for this execution.
EXECUTION_HISTORY_DETAILED Enable execution history detailed feature for this execution.
labels

map (key: string, value: string)

Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution.
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. Note that this will be the same as createTime for executions that start immediately.
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 Execution data is unavailable. See the state_error field.
QUEUED Request has been placed in the backlog for processing at a later time.
stateError

object (StateError)

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

ExportDataResponse

Response for the ExportData method.
Fields
data

string

The JSON string with customer data and metadata for an execution with the given name

ListCallbacksResponse

RPC response object for the ListCallbacks method.
Fields
callbacks[]

object (Callback)

The callbacks 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.

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.

ListStepEntriesResponse

Response message for ExecutionHistory.ListStepEntries.
Fields
nextPageToken

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.
stepEntries[]

object (StepEntry)

The list of entries.
totalSize

integer (int32 format)

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.

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.

PubsubMessage

A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation for more information. See quotas and limits for more information about message limits.
Fields
attributes

map (key: string, value: string)

Optional. Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.
data

string (bytes format)

Optional. The message data field. If this field is empty, the message must contain at least one attribute.
messageId

string

ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by the publisher in a Publish call.
orderingKey

string

Optional. If non-empty, identifies related messages for which publish order should be respected. If a Subscription has enable_message_ordering set to true, messages published with the same non-empty ordering_key value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All PubsubMessages published in a given PublishRequest must specify the same ordering_key value. For more information, see ordering messages.
publishTime

string (Timestamp format)

The time at which the message was published, populated by the server when it receives the Publish call. It must not be populated by the publisher in a Publish call.

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.

StateError

Describes an error related to the current state of the Execution resource.
Fields
details

string

Provides specifics about the error.
type

enum

The type of this state error.
Enum type. Can be one of the following:
TYPE_UNSPECIFIED No type specified.
KMS_ERROR Caused by an issue with KMS.

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.

StepEntry

An StepEntry contains debugging information for a step transition in a workflow execution.
Fields
createTime

string (Timestamp format)

Output only. The creation time of the step entry.
entryId

string (int64 format)

Output only. The numeric ID of this step entry, used for navigation.
exception

object (Exception)

Output only. The exception thrown by the step entry.
name

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}.
navigationInfo

object (NavigationInfo)

Output only. The NavigationInfo associated with this step.
routine

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.
state

enum

Output only. The state of the step entry.
Enum type. Can be one of the following:
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.
STATE_CANCELLED The step entry is cancelled.
step

string

Output only. The name of the step this step entry belongs to.
stepEntryMetadata

object (StepEntryMetadata)

Output only. The StepEntryMetadata associated with this step.
stepType

enum

Output only. The type of the step this step entry belongs to.
Enum type. Can be one of the following:
STEP_TYPE_UNSPECIFIED Invalid step type.
STEP_ASSIGN The step entry assigns new variable(s).
STEP_STD_LIB_CALL The step entry calls a standard library routine.
STEP_CONNECTOR_CALL The step entry calls a connector.
STEP_SUBWORKFLOW_CALL The step entry calls a subworklfow.
STEP_CALL The step entry calls a subworkflow/stdlib.
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 a 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 branch(es).
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.
updateTime

string (Timestamp format)

Output only. The most recently updated time of the step entry.
variableData

object (VariableData)

Output only. The VariableData associated with this step.

StepEntryMetadata

StepEntryMetadata contains metadata information about this step.
Fields
expectedIteration

string (int64 format)

Expected iteration represents the expected number of iterations in the step's progress.
progressNumber

string (int64 format)

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. Note: This field is only populated when an iteration exists and the starting value is 1.
progressType

enum

Progress type of this step entry.
Enum type. Can be one of the following:
PROGRESS_TYPE_UNSPECIFIED Current step entry does not have any progress data.
PROGRESS_TYPE_FOR Current step entry is in progress of a FOR step.
PROGRESS_TYPE_SWITCH Current step entry is in progress of a SWITCH step.
PROGRESS_TYPE_RETRY Current step entry is in progress of a RETRY step.
PROGRESS_TYPE_PARALLEL_FOR Current step entry is in progress of a PARALLEL FOR step.
PROGRESS_TYPE_PARALLEL_BRANCH Current step entry is in progress of a PARALLEL BRANCH step.
threadId

string

Child thread id that this step entry belongs to.

TriggerPubsubExecutionRequest

Request for the TriggerPubsubExecution method.
Fields
GCPCloudEventsMode

string

Required. LINT: LEGACY_NAMES The query parameter value for __GCP_CloudEventsMode, set by the Eventarc service when configuring triggers.
deliveryAttempt

integer (int32 format)

The number of attempts that have been made to deliver this message. This is set by Pub/Sub for subscriptions that have the "dead letter" feature enabled, and hence provided here for compatibility, but is ignored by Workflows.
message

object (PubsubMessage)

Required. The message of the Pub/Sub push notification.
subscription

string

Required. The subscription of the Pub/Sub push notification. Format: projects/{project}/subscriptions/{sub}

VariableData

VariableData contains the variable data for this step.
Fields
variables

map (key: string, value: any)

Variables that are associated with this step.