create method

Future<GoogleLongrunningOperation> create(
  1. GoogleFirestoreAdminV1Index request,
  2. String parent, {
  3. String? $fields,
})

Creates a composite index.

This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.

request - The metadata request object.

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/\[^/\]+$.

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

Completes with a GoogleLongrunningOperation.

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<GoogleLongrunningOperation> create(
  GoogleFirestoreAdminV1Index request,
  core.String parent, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/indexes';

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