beginTransaction method

Future<BeginTransactionResponse> beginTransaction(BeginTransactionRequest request, String database, { String? $fields, })

Starts a new transaction.

request - The metadata request object.

Request parameters:

database - Required. The database name. In the format: projects/{project_id}/databases/{database_id}. Value must have pattern ^projects/\[^/\]+/databases/\[^/\]+$.

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

Completes with a BeginTransactionResponse.

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<BeginTransactionResponse> beginTransaction(
  BeginTransactionRequest request,
  core.String database, {
  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 = 'v1beta1/' +
      core.Uri.encodeFull('$database') +
      '/documents:beginTransaction';

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