listIpOverrides method

Future<GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse> listIpOverrides(
  1. String parent, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Lists all IP overrides for a key.

Request parameters:

parent - Required. The parent key for which the IP overrides are listed, in the format projects/{project}/keys/{key}. Value must have pattern ^projects/\[^/\]+/keys/\[^/\]+$.

pageSize - Optional. The maximum number of overrides to return. Default is 10. Max limit is 100. If the number of overrides is less than the page_size, all overrides are returned. If the page size is more than 100, it is coerced to 100.

pageToken - Optional. The next_page_token value returned from a previous ListIpOverridesRequest, if any.

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

Completes with a GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse.

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<GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse>
    listIpOverrides(
  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') + ':listIpOverrides';

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