list method

Future<ListRegistrationsResponse> list(String parent, { String? filter, int? pageSize, String? pageToken, String? $fields, })

Lists the Registration resources in a project.

Request parameters:

parent - Required. The project and location from which to list Registrations, specified in the format projects / * /locations / * . Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Filter expression to restrict the Registrations returned. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, a boolean, or an enum value. The comparison operator should be one of =, !=, >, <, >=, <=, or : for prefix or wildcard matches. For example, to filter to a specific domain name, use an expression like domainName="example.com". You can also check for the existence of a field; for example, to find domains using custom DNS settings, use an expression like dnsSettings.customDns:*. You can also create compound filters by combining expressions with the AND and OR operators. For example, to find domains that are suspended or have specific issues flagged, use an expression like (state=SUSPENDED) OR (issue:*).

pageSize - Maximum number of results to return.

pageToken - When set to the next_page_token from a prior response, provides the next page of results.

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

Completes with a ListRegistrationsResponse.

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<ListRegistrationsResponse> 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') + '/registrations';

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