Cloud Bigtable V2 Client - Class CheckConsistencyRequest (2.3.0)

Reference documentation and code samples for the Cloud Bigtable V2 Client class CheckConsistencyRequest.

Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency

Generated from protobuf message google.bigtable.admin.v2.CheckConsistencyRequest

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The unique name of the Table for which to check replication consistency. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.
`↳ consistency_token`	`string` Required. The token created using GenerateConsistencyToken for the Table.
`↳ standard_read_remote_writes`	`Google\Cloud\Bigtable\Admin\V2\StandardReadRemoteWrites` Checks that reads using an app profile with `StandardIsolation` can see all writes committed before the token was created, even if the read and write target different clusters.
`↳ data_boost_read_local_writes`	`Google\Cloud\Bigtable\Admin\V2\DataBoostReadLocalWrites` Checks that reads using an app profile with `DataBoostIsolationReadOnly` can see all writes committed before the token was created, but only if the read and write target the same cluster.

getName

Required. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Returns
Type	Description
`string`

setName

Required. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getConsistencyToken

Required. The token created using GenerateConsistencyToken for the Table.

Returns
Type	Description
`string`

setConsistencyToken

Required. The token created using GenerateConsistencyToken for the Table.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStandardReadRemoteWrites

Checks that reads using an app profile with StandardIsolation can see all writes committed before the token was created, even if the read and write target different clusters.

Returns
Type	Description
`Google\Cloud\Bigtable\Admin\V2\StandardReadRemoteWrites\|null`

hasStandardReadRemoteWrites

setStandardReadRemoteWrites

Checks that reads using an app profile with StandardIsolation can see all writes committed before the token was created, even if the read and write target different clusters.

Parameter
Name	Description
`var`	`Google\Cloud\Bigtable\Admin\V2\StandardReadRemoteWrites`

Returns
Type	Description
`$this`

getDataBoostReadLocalWrites

Checks that reads using an app profile with DataBoostIsolationReadOnly can see all writes committed before the token was created, but only if the read and write target the same cluster.

Returns
Type	Description
`Google\Cloud\Bigtable\Admin\V2\DataBoostReadLocalWrites\|null`

hasDataBoostReadLocalWrites

setDataBoostReadLocalWrites

Checks that reads using an app profile with DataBoostIsolationReadOnly can see all writes committed before the token was created, but only if the read and write target the same cluster.

Parameter
Name	Description
`var`	`Google\Cloud\Bigtable\Admin\V2\DataBoostReadLocalWrites`

Returns
Type	Description
`$this`

getMode

Returns
Type	Description
`string`

static::build

Parameters
Name	Description
`name`	`string` Required. The unique name of the Table for which to check replication consistency. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`. Please see Google\Cloud\Bigtable\Admin\V2\BigtableTableAdminClient::tableName() for help formatting this field.
`consistencyToken`	`string` Required. The token created using GenerateConsistencyToken for the Table.

Returns
Type	Description
`Google\Cloud\Bigtable\Admin\V2\CheckConsistencyRequest`