group method

Future<GroupFindingsResponse> group(
  1. GroupFindingsRequest request,
  2. String parent, {
  3. String? $fields,
})

Filters an organization or source's findings and groups them by their specified properties.

To group across all sources provide a - as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings

request - The metadata request object.

Request parameters:

parent - Required. Name of the source to groupBy. Its format is organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of -. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/- Value must have pattern ^folders/\[^/\]+/sources/\[^/\]+$.

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

Completes with a GroupFindingsResponse.

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<GroupFindingsResponse> group(
  GroupFindingsRequest request,
  core.String parent, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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