list method

Future<ListFindingsResponse> list(
  1. String parent, {
  2. String? filter,
  3. int? pageSize,
  4. String? pageToken,
  5. String? $fields,
})

List Findings under a given ScanRun.

Request parameters:

parent - Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. Value must have pattern ^projects/\[^/\]+/scanConfigs/\[^/\]+/scanRuns/\[^/\]+$.

filter - The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.

pageSize - The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.

pageToken - A token identifying a page of results to be returned. This should be a next_page_token value returned from a previous List request. If unspecified, the first page of results is returned.

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

Completes with a ListFindingsResponse.

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

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

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