Workflow Executions v1 API - Class ListExecutionsRequest (2.5.0)

Reference documentation and code samples for the Workflow Executions v1 API class ListExecutionsRequest.

Request for the [ListExecutions][] method.

Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.

Optional. The ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.

Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 1000 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.

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.

Note that pagination is applied to dynamic data. The list of executions returned can change between page requests.

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

WorkflowName-typed view over the Parent resource name property.

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