list method

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

Lists domains in a project.

Request parameters:

parent - Required. The resource name of the domain location using the form: projects/{project_id}/locations/global Value must have pattern ^projects/\[^/\]+/locations/global$.

filter - Optional. A filter specifying constraints of a list operation. For example, Domain.fqdn="mydomain.myorginization".

orderBy - Optional. Specifies the ordering of results. See Sorting order for more information.

pageSize - Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used. Regardless of the page_size value, the response may include a partial list. Callers should rely on a response's next_page_token to determine if there are additional results to list.

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

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

Completes with a ListDomainsResponse.

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<ListDomainsResponse> list(
  core.String parent, {
  core.String? filter,
  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 (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') + '/domains';

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