Method: projects.instances.tables.generateConsistencyToken

Generates a consistency token for a Table, which can be used in tables.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.

HTTP request

POST https://bigtableadmin.googleapis.com/v2/{name=projects/*/instances/*/tables/*}:generateConsistencyToken

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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}.

Authorization requires the following IAM permission on the specified resource name:

  • bigtable.tables.generateConsistencyToken

Request body

The request body must be empty.

Response body

Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken

If successful, the response body contains data with the following structure:

JSON representation 
{
  "consistencyToken": string
}
Fields
consistencyToken

string

The generated consistency token.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.admin
  • https://www.googleapis.com/auth/bigtable.admin.table
  • https://www.googleapis.com/auth/cloud-bigtable.admin
  • https://www.googleapis.com/auth/cloud-bigtable.admin.table
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.