list method

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

Lists the field configuration and metadata for this database.

Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to indexConfig.usesAncestorConfig:false .

Request parameters:

parent - Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} Value must have pattern ^projects/\[^/\]+/databases/\[^/\]+/collectionGroups/\[^/\]+$.

filter - The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes indexConfig.usesAncestorConfig:false .

pageSize - The number of results to return.

pageToken - A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.

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

Completes with a GoogleFirestoreAdminV1ListFieldsResponse.

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<GoogleFirestoreAdminV1ListFieldsResponse> 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') + '/fields';

  final _response = await _requester.request(
    _url,
    'GET',
    queryParams: _queryParams,
  );
  return GoogleFirestoreAdminV1ListFieldsResponse.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}