list method
Lists Steps for a given Execution.
The steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same creation_time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist
Request parameters:
projectId
- A Project id. Required.
historyId
- A History id. Required.
executionId
- A Execution id. Required.
pageSize
- The maximum number of Steps to fetch. Default value: 25. The
server will use this default if the field is not set or has a value of 0.
Optional.
pageToken
- A continuation token to resume the query at the next item.
Optional.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListStepsResponse.
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<ListStepsResponse> list(
core.String projectId,
core.String historyId,
core.String executionId, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'toolresults/v1beta3/projects/' +
commons.escapeVariable('$projectId') +
'/histories/' +
commons.escapeVariable('$historyId') +
'/executions/' +
commons.escapeVariable('$executionId') +
'/steps';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListStepsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}