Method: googleapis.workflowexecutions.v1.projects.locations.workflows.executions.stepEntries.list

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

Arguments

Parameters
parent

string

Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
filter

string

Optional. Filters applied to the [StepEntries.ListStepEntries] results. The following fields are supported for filtering: entryId, createTime, updateTime, routine, step, stepType, parent, state. For details, see AIP-160. For example, if you are using the Google APIs Explorer: state="SUCCEEDED" or createTime>"2023-08-01" AND state="FAILED"
orderBy

string

Optional. Comma-separated list of fields that specify the ordering applied to the [StepEntries.ListStepEntries] results. By default the ordering is based on ascending entryId. The following fields are supported for ordering: entryId, createTime, updateTime, routine, step, stepType, state. For details, see AIP-132.
pageSize

integer (int32 format)

Optional. Number of step entries to return per call. The default max is 1000.
pageToken

string

Optional. A page token, received from a previous ListStepEntries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListStepEntries must match the call that provided the page token.
skip

integer (int32 format)

Optional. The number of step entries to skip. It can be used with or without a pageToken. If used with a pageToken, then it indicates the number of step entries to skip starting from the requested page.
view

enum

Deprecated field.
Enum type. Can be one of the following:
EXECUTION_ENTRY_VIEW_UNSPECIFIED The default/unset value.
EXECUTION_ENTRY_VIEW_BASIC Include basic information in the step entries. All fields in StepEntry are returned except for variable_data.
EXECUTION_ENTRY_VIEW_DETAILED Include all data.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of ListStepEntriesResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.workflowexecutions.v1.projects.locations.workflows.executions.stepEntries.list
    args:
        parent: ...
        filter: ...
        orderBy: ...
        pageSize: ...
        pageToken: ...
        skip: ...
        view: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.workflowexecutions.v1.projects.locations.workflows.executions.stepEntries.list",
      "args": {
        "parent": "...",
        "filter": "...",
        "orderBy": "...",
        "pageSize": "...",
        "pageToken": "...",
        "skip": "...",
        "view": "..."
      },
      "result": "listResult"
    }
  }
]