list method

Future<ListStepEntriesResponse> list(String parent, { String? filter, String? orderBy, int? pageSize, String? pageToken, int? skip, String? $fields, })

Lists step entries for the corresponding workflow execution.

Returned entries are ordered by their create_time.

Request parameters:

parent - Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/ Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/workflows/\[^/\]+/executions/\[^/\]+$.

filter - Optional. Filters applied to the [StepEntries.ListStepEntries] results. The following fields are supported for filtering: entryId, createTime, updateTime, routine, step, stepType, 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 - 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 - Optional. Number of step entries to return per call. The default max is 1000.

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

$fields - Selector specifying which fields to include in a partial response.

Completes with a ListStepEntriesResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<ListStepEntriesResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.int? skip,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (orderBy != null) 'orderBy': [orderBy],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (skip != null) 'skip': ['${skip}'],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/stepEntries';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ListStepEntriesResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}