step_entries

Creates, updates, deletes, gets or lists a step_entries resource.

Overview

Name	step_entries
Type	Resource
Id	google.workflowexecutions.step_entries

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
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}.
createTime	string (google-datetime)	Output only. The creation time of the step entry.
entryId	string (int64)	Output only. The numeric ID of this step entry, used for navigation.
exception	object	Output only. The exception thrown by the step entry. (id: Exception)
navigationInfo	object	Output only. The NavigationInfo associated with this step. (id: NavigationInfo)
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	string	Output only. The state of the step entry.
step	string	Output only. The name of the step this step entry belongs to.
stepEntryMetadata	object	Output only. The StepEntryMetadata associated with this step. (id: StepEntryMetadata)
stepType	string	Output only. The type of the step this step entry belongs to.
updateTime	string (google-datetime)	Output only. The most recently updated time of the step entry.
variableData	object	Output only. The VariableData associated with this step. (id: VariableData)

list

Successful response

Name	Datatype	Description
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}.
createTime	string (google-datetime)	Output only. The creation time of the step entry.
entryId	string (int64)	Output only. The numeric ID of this step entry, used for navigation.
exception	object	Output only. The exception thrown by the step entry. (id: Exception)
navigationInfo	object	Output only. The NavigationInfo associated with this step. (id: NavigationInfo)
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	string	Output only. The state of the step entry.
step	string	Output only. The name of the step this step entry belongs to.
stepEntryMetadata	object	Output only. The StepEntryMetadata associated with this step. (id: StepEntryMetadata)
stepType	string	Output only. The type of the step this step entry belongs to.
updateTime	string (google-datetime)	Output only. The most recently updated time of the step entry.
variableData	object	Output only. The VariableData associated with this step. (id: VariableData)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, workflowsId, executionsId, stepEntriesId	view	Gets a step entry.
list	select	projectsId, locationsId, workflowsId, executionsId	pageSize, pageToken, skip, filter, orderBy, view	Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
executionsId	string
locationsId	string
projectsId	string
stepEntriesId	string
workflowsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
skip	integer (int32)
view	string

SELECT examples

get

Gets a step entry.

SELECT
name,
createTime,
entryId,
exception,
navigationInfo,
routine,
state,
step,
stepEntryMetadata,
stepType,
updateTime,
variableData
FROM google.workflowexecutions.step_entries
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND workflowsId = '{{ workflowsId }}' -- required
AND executionsId = '{{ executionsId }}' -- required
AND stepEntriesId = '{{ stepEntriesId }}' -- required
AND view = '{{ view }}';

list

Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.

SELECT
name,
createTime,
entryId,
exception,
navigationInfo,
routine,
state,
step,
stepEntryMetadata,
stepType,
updateTime,
variableData
FROM google.workflowexecutions.step_entries
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND workflowsId = '{{ workflowsId }}' -- required
AND executionsId = '{{ executionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND skip = '{{ skip }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND view = '{{ view }}';