list method

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

Returns a list of SecurityActions.

This returns both enabled and disabled actions.

Request parameters:

parent - Required. The parent, which owns this collection of SecurityActions. Format: organizations/{org}/environments/{env} Value must have pattern ^organizations/\[^/\]+/environments/\[^/\]+$.

filter - The filter expression to filter List results. https://google.aip.dev/160. Allows for filtering over: state and api_proxies. E.g.: state = ACTIVE AND apiProxies:foo. Filtering by action is not supported https://github.com/aip-dev/google.aip.dev/issues/624

pageSize - The maximum number of SecurityActions to return. If unspecified, at most 50 SecurityActions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

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

Completes with a GoogleCloudApigeeV1ListSecurityActionsResponse.

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<GoogleCloudApigeeV1ListSecurityActionsResponse> 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') + '/securityActions';

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