list method

Future<ListViolationsResponse> list(String parent, { String? filter, String? interval_endTime, String? interval_startTime, String? orderBy, int? pageSize, String? pageToken, String? $fields, })

Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}.

Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}

Request parameters:

parent - Required. Parent resource Format organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload} Value must have pattern ^organizations/\[^/\]+/locations/\[^/\]+/customers/\[^/\]+/workloads/\[^/\]+$.

filter - Optional. Filtering results

interval_endTime - Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

interval_startTime - Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

orderBy - Optional. Hint for how to order the results

pageSize - Optional. The maximum number of customers row to return. The service may return fewer than this value. If unspecified, at most 10 customers will be returned.

pageToken - Optional. A page token, received from a previous ListViolations call. Provide this to retrieve the subsequent page.

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

Completes with a ListViolationsResponse.

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

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

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