Method: googleapis.workflowexecutions.v1beta.projects.locations.workflows.executions.list

Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).

Arguments

Parameters
parent

string

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

pageSize

integer (int32 format)

Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 10000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.

pageToken

string

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

view

enum

Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

Enum type. Can be one of the following:
EXECUTION_VIEW_UNSPECIFIED The default / unset value.
BASIC Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id.
FULL Includes 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 ListExecutionsResponse.

Subworkflow snippet

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

YAML

- list:
    call: googleapis.workflowexecutions.v1beta.projects.locations.workflows.executions.list
    args:
        parent: ...
        pageSize: ...
        pageToken: ...
        view: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.workflowexecutions.v1beta.projects.locations.workflows.executions.list",
      "args": {
        "parent": "...",
        "pageSize": "...",
        "pageToken": "...",
        "view": "..."
      },
      "result": "listResult"
    }
  }
]