Cloud Bigtable V2 Client - Class GenerateInitialChangeStreamPartitionsRequest (1.27.0)

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

NOTE: This API is intended to be used by Apache Beam BigtableIO.

Request message for Bigtable.GenerateInitialChangeStreamPartitions.

Generated from protobuf message google.bigtable.v2.GenerateInitialChangeStreamPartitionsRequest

Namespace

Google \ Cloud \ Bigtable \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ table_name`	`string` Required. The unique name of the table from which to get change stream partitions. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`. Change streaming must be enabled on the table.
`↳ app_profile_id`	`string` This value specifies routing for replication. If not specified, the "default" application profile will be used. Single cluster routing must be configured on the profile.

getTableName

Required. The unique name of the table from which to get change stream partitions. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

Change streaming must be enabled on the table.

Returns
Type	Description
`string`

setTableName

Required. The unique name of the table from which to get change stream partitions. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

Change streaming must be enabled on the table.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAppProfileId

This value specifies routing for replication. If not specified, the "default" application profile will be used.

Single cluster routing must be configured on the profile.

Returns
Type	Description
`string`

setAppProfileId

This value specifies routing for replication. If not specified, the "default" application profile will be used.

Single cluster routing must be configured on the profile.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`tableName`	`string` Required. The unique name of the table from which to get change stream partitions. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`. Change streaming must be enabled on the table. Please see Google\Cloud\Bigtable\V2\BigtableClient::tableName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Bigtable\V2\GenerateInitialChangeStreamPartitionsRequest`

static::buildFromTableNameAppProfileId

Parameters
Name	Description
`tableName`	`string` Required. The unique name of the table from which to get change stream partitions. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`. Change streaming must be enabled on the table. Please see Google\Cloud\Bigtable\V2\BigtableClient::tableName() for help formatting this field.
`appProfileId`	`string` This value specifies routing for replication. If not specified, the "default" application profile will be used. Single cluster routing must be configured on the profile.

Returns
Type	Description
`Google\Cloud\Bigtable\V2\GenerateInitialChangeStreamPartitionsRequest`