list method

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

Lists composite indexes.

Request parameters:

parent - 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.

pageSize - The number of results to return.

pageToken - A page token, returned from a previous call to FirestoreAdmin.ListIndexes, 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 GoogleFirestoreAdminV1beta2ListIndexesResponse.

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<GoogleFirestoreAdminV1beta2ListIndexesResponse> 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_ = 'v1beta2/' + core.Uri.encodeFull('$parent') + '/indexes';

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