list method

Future<GoogleFirestoreAdminV1ListIndexesResponse> list (String parent, { String pageToken, int pageSize, String filter, 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/^/+$".

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

pageSize - The number of results to return.

filter - The filter to apply to list results.

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

Completes with a GoogleFirestoreAdminV1ListIndexesResponse.

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<GoogleFirestoreAdminV1ListIndexesResponse> list(
    core.String parent,
    {core.String pageToken,
    core.int pageSize,
    core.String filter,
    core.String $fields}) {
  var _url;
  var _queryParams = new core.Map<core.String, core.List<core.String>>();
  var _uploadMedia;
  var _uploadOptions;
  var _downloadOptions = commons.DownloadOptions.Metadata;
  var _body;

  if (parent == null) {
    throw new core.ArgumentError("Parameter parent is required.");
  }
  if (pageToken != null) {
    _queryParams["pageToken"] = [pageToken];
  }
  if (pageSize != null) {
    _queryParams["pageSize"] = ["${pageSize}"];
  }
  if (filter != null) {
    _queryParams["filter"] = [filter];
  }
  if ($fields != null) {
    _queryParams["fields"] = [$fields];
  }

  _url =
      'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/indexes';

  var _response = _requester.request(_url, "GET",
      body: _body,
      queryParams: _queryParams,
      uploadOptions: _uploadOptions,
      uploadMedia: _uploadMedia,
      downloadOptions: _downloadOptions);
  return _response.then(
      (data) => new GoogleFirestoreAdminV1ListIndexesResponse.fromJson(data));
}