list method

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

Lists address groups in a given project and location.

Request parameters:

parent - Required. The project and location from which the AddressGroups should be listed, specified in the format projects / * /locations/{location}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

pageSize - Maximum number of AddressGroups to return per call.

pageToken - The value returned by the last ListAddressGroupsResponse Indicates that this is a continuation of a prior ListAddressGroups call, and that the system should return the next page of data.

returnPartialSuccess - Optional. If true, allow partial responses for multi-regional Aggregated List requests.

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

Completes with a ListAddressGroupsResponse.

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<ListAddressGroupsResponse> list(
  core.String parent, {
  core.int? pageSize,
  core.String? pageToken,
  core.bool? returnPartialSuccess,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (returnPartialSuccess != null)
      'returnPartialSuccess': ['${returnPartialSuccess}'],
    if ($fields != null) 'fields': [$fields],
  };

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

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