list method

Future<ListHistoriesResponse> list(
  1. String projectId, {
  2. String? filterByName,
  3. int? pageSize,
  4. String? pageToken,
  5. String? $fields,
})

Lists Histories for a given Project.

The histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification 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 - NOT_FOUND - if the History does not exist

Request parameters:

projectId - A Project id. Required.

filterByName - If set, only return histories with the given name. Optional.

pageSize - The maximum number of Histories to fetch. Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100. 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 ListHistoriesResponse.

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<ListHistoriesResponse> list(
  core.String projectId, {
  core.String? filterByName,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final _queryParams = <core.String, core.List<core.String>>{
    if (filterByName != null) 'filterByName': [filterByName],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final _url = 'toolresults/v1beta3/projects/' +
      commons.escapeVariable('$projectId') +
      '/histories';

  final _response = await _requester.request(
    _url,
    'GET',
    queryParams: _queryParams,
  );
  return ListHistoriesResponse.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}