listReferences method

Future<ListAddressGroupReferencesResponse> listReferences(
  1. String addressGroup, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Lists references of an address group.

Request parameters:

addressGroup - Required. A name of the AddressGroup to clone items to. Must be in the format projects|organization / * /locations/{location}/addressGroups / * . Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/addressGroups/\[^/\]+$.

pageSize - The maximum number of references to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more AddressGroupUsers left to be queried.

pageToken - The next_page_token value returned from a previous List request, if any.

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

Completes with a ListAddressGroupReferencesResponse.

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<ListAddressGroupReferencesResponse> listReferences(
  core.String addressGroup, {
  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('$addressGroup') + ':listReferences';

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