generateConsistencyToken method

Future<GenerateConsistencyTokenResponse> generateConsistencyToken(GenerateConsistencyTokenRequest request, String name, { String? $fields, })

Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated.

The tokens will be available for 90 days.

request - The metadata request object.

Request parameters:

name - Required. The unique name of the Table for which to create a consistency token. Values are of the form projects/{project}/instances/{instance}/tables/{table}. Value must have pattern ^projects/\[^/\]+/instances/\[^/\]+/tables/\[^/\]+$.

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

Completes with a GenerateConsistencyTokenResponse.

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<GenerateConsistencyTokenResponse> generateConsistencyToken(
  GenerateConsistencyTokenRequest request,
  core.String name, {
  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_ =
      'v2/' + core.Uri.encodeFull('$name') + ':generateConsistencyToken';

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