list method

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

Lists the indexes that match the specified filters.

Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results.

Request parameters:

projectId - Project ID against which to make the request.

filter - null

pageSize - The maximum number of items to return. If zero, then all results will be returned.

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

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

Completes with a GoogleDatastoreAdminV1ListIndexesResponse.

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<GoogleDatastoreAdminV1ListIndexesResponse> list(
  core.String projectId, {
  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/projects/' + commons.escapeVariable('$projectId') + '/indexes';

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