list method

Future<GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse> list(String parent, { int? pageSize, String? pageToken, String? $fields, })

ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in an organization.

Each OrgPolicyViolationsPreview is available for at least 7 days.

Request parameters:

parent - Required. The parent the violations are scoped to. Format: organizations/{organization}/locations/{location} Example: organizations/my-example-org/locations/global Value must have pattern ^organizations/\[^/\]+/locations/\[^/\]+$.

pageSize - Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 5 items will be returned. The maximum value is 10; values above 10 will be coerced to 10.

pageToken - Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token.

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

Completes with a GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse.

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<
    GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse> list(
  core.String parent, {
  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_ =
      'v1/' + core.Uri.encodeFull('$parent') + '/orgPolicyViolationsPreviews';

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