list method

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

Lists the framework compliance summary for a given scope.

Request parameters:

parent - Required. The parent scope for the framework compliance summary. Format: organizations/{organization}/locations/{location} folders/{folder}/locations/{location} projects/{project}/locations/{location} Value must have pattern ^organizations/\[^/\]+/locations/\[^/\]+$.

filter - Optional. The filtering results.

pageSize - Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.

pageToken - Optional. A token that identifies the page of results that the server should return. Pass the next_page_token value from a previous result.

view - Optional. Specifies the level of detail to return in the response. Possible string values are:

  • "FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED" : The default / unset value. The API will default to the BASIC view.
  • "FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC" : Includes basic compliance metadata, but omits trend data.
  • "FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" : Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days.

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

Completes with a GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse.

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

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

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