Reference documentation and code samples for the Cloud Bigtable V2 Client class ReadChangeStreamRequest.
NOTE: This API is intended to be used by Apache Beam BigtableIO.
Request message for Bigtable.ReadChangeStream.
Generated from protobuf messagegoogle.bigtable.v2.ReadChangeStreamRequest
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 read a change stream. Values are of the formprojects/<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.
Start reading the stream at the specified timestamp. This timestamp must be within the change stream retention period, less than or equal to the current time, and after change stream creation, whichever is greater. This value is inclusive and will be truncated to microsecond granularity.
Tokens that describe how to resume reading a stream where reading previously left off. If specified, changes will be read starting at the the position. Tokens are delivered on the stream as part ofHeartbeatandCloseStreammessages. If a single token is provided, the token's partition must exactly match the request's partition. If multiple tokens are provided, as in the case of a partition merge, the union of the token partitions must exactly cover the request's partition. Otherwise, INVALID_ARGUMENT will be returned.
If specified, OK will be returned when the stream advances beyond this time. Otherwise, changes will be continuously delivered on the stream. This value is inclusive and will be truncated to microsecond granularity.
Start reading the stream at the specified timestamp. This timestamp must
be within the change stream retention period, less than or equal to the
current time, and after change stream creation, whichever is greater.
This value is inclusive and will be truncated to microsecond granularity.
Start reading the stream at the specified timestamp. This timestamp must
be within the change stream retention period, less than or equal to the
current time, and after change stream creation, whichever is greater.
This value is inclusive and will be truncated to microsecond granularity.
Tokens that describe how to resume reading a stream where reading
previously left off. If specified, changes will be read starting at the
the position. Tokens are delivered on the stream as part ofHeartbeatandCloseStreammessages.
If a single token is provided, the token's partition must exactly match
the request's partition. If multiple tokens are provided, as in the case
of a partition merge, the union of the token partitions must exactly
cover the request's partition. Otherwise, INVALID_ARGUMENT will be
returned.
Tokens that describe how to resume reading a stream where reading
previously left off. If specified, changes will be read starting at the
the position. Tokens are delivered on the stream as part ofHeartbeatandCloseStreammessages.
If a single token is provided, the token's partition must exactly match
the request's partition. If multiple tokens are provided, as in the case
of a partition merge, the union of the token partitions must exactly
cover the request's partition. Otherwise, INVALID_ARGUMENT will be
returned.
Required. The unique name of the table from which to read a change stream.
Values are of the formprojects/<project>/instances/<instance>/tables/<table>.
Change streaming must be enabled on the table. Please seeBigtableClient::tableName()for help formatting this field.
Required. The unique name of the table from which to read a change stream.
Values are of the formprojects/<project>/instances/<instance>/tables/<table>.
Change streaming must be enabled on the table. Please seeBigtableClient::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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class ReadChangeStreamRequest (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/V2.ReadChangeStreamRequest)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/V2.ReadChangeStreamRequest)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/V2.ReadChangeStreamRequest)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/V2.ReadChangeStreamRequest)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/V2.ReadChangeStreamRequest)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/V2.ReadChangeStreamRequest)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/V2.ReadChangeStreamRequest)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/V2.ReadChangeStreamRequest)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/V2.ReadChangeStreamRequest)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/V2.ReadChangeStreamRequest)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/V2.ReadChangeStreamRequest)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/V2.ReadChangeStreamRequest)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/V2.ReadChangeStreamRequest)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/V2.ReadChangeStreamRequest)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/V2.ReadChangeStreamRequest)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/V2.ReadChangeStreamRequest)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/V2.ReadChangeStreamRequest)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/V2.ReadChangeStreamRequest)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/V2.ReadChangeStreamRequest)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/V2.ReadChangeStreamRequest)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/V2.ReadChangeStreamRequest)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/V2.ReadChangeStreamRequest)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/V2.ReadChangeStreamRequest)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/V2.ReadChangeStreamRequest)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/V2.ReadChangeStreamRequest)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/V2.ReadChangeStreamRequest)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/V2.ReadChangeStreamRequest)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/V2.ReadChangeStreamRequest)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/V2.ReadChangeStreamRequest)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/V2.ReadChangeStreamRequest)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/V2.ReadChangeStreamRequest) \nReference documentation and code samples for the Cloud Bigtable V2 Client class ReadChangeStreamRequest.\n\nNOTE: This API is intended to be used by Apache Beam BigtableIO.\n\nRequest message for Bigtable.ReadChangeStream.\n\nGenerated from protobuf message `google.bigtable.v2.ReadChangeStreamRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getTableName\n\nRequired. The unique name of the table from which to read a change stream.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e`.\nChange streaming must be enabled on the table.\n\n### setTableName\n\nRequired. The unique name of the table from which to read a change stream.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e`.\nChange streaming must be enabled on the table.\n\n### getAppProfileId\n\nThis value specifies routing for replication. If not specified, the\n\"default\" application profile will be used.\n\nSingle cluster routing must be configured on the profile.\n\n### setAppProfileId\n\nThis value specifies routing for replication. If not specified, the\n\"default\" application profile will be used.\n\nSingle cluster routing must be configured on the profile.\n\n### getPartition\n\nThe partition to read changes from.\n\n### hasPartition\n\n### clearPartition\n\n### setPartition\n\nThe partition to read changes from.\n\n### getStartTime\n\nStart reading the stream at the specified timestamp. This timestamp must\nbe within the change stream retention period, less than or equal to the\ncurrent time, and after change stream creation, whichever is greater.\n\nThis value is inclusive and will be truncated to microsecond granularity.\n\n### hasStartTime\n\n### setStartTime\n\nStart reading the stream at the specified timestamp. This timestamp must\nbe within the change stream retention period, less than or equal to the\ncurrent time, and after change stream creation, whichever is greater.\n\nThis value is inclusive and will be truncated to microsecond granularity.\n\n### getContinuationTokens\n\nTokens that describe how to resume reading a stream where reading\npreviously left off. If specified, changes will be read starting at the\nthe position. Tokens are delivered on the stream as part of `Heartbeat`\nand `CloseStream` messages.\n\nIf a single token is provided, the token's partition must exactly match\nthe request's partition. If multiple tokens are provided, as in the case\nof a partition merge, the union of the token partitions must exactly\ncover the request's partition. Otherwise, INVALID_ARGUMENT will be\nreturned.\n\n### hasContinuationTokens\n\n### setContinuationTokens\n\nTokens that describe how to resume reading a stream where reading\npreviously left off. If specified, changes will be read starting at the\nthe position. Tokens are delivered on the stream as part of `Heartbeat`\nand `CloseStream` messages.\n\nIf a single token is provided, the token's partition must exactly match\nthe request's partition. If multiple tokens are provided, as in the case\nof a partition merge, the union of the token partitions must exactly\ncover the request's partition. Otherwise, INVALID_ARGUMENT will be\nreturned.\n\n### getEndTime\n\nIf specified, OK will be returned when the stream advances beyond\nthis time. Otherwise, changes will be continuously delivered on the stream.\n\nThis value is inclusive and will be truncated to microsecond granularity.\n\n### hasEndTime\n\n### clearEndTime\n\n### setEndTime\n\nIf specified, OK will be returned when the stream advances beyond\nthis time. Otherwise, changes will be continuously delivered on the stream.\n\nThis value is inclusive and will be truncated to microsecond granularity.\n\n### getHeartbeatDuration\n\nIf specified, the duration between `Heartbeat` messages on the stream.\n\nOtherwise, defaults to 5 seconds.\n\n### hasHeartbeatDuration\n\n### clearHeartbeatDuration\n\n### setHeartbeatDuration\n\nIf specified, the duration between `Heartbeat` messages on the stream.\n\nOtherwise, defaults to 5 seconds.\n\n### getStartFrom\n\n### static::build\n\n### static::buildFromTableNameAppProfileId"]]
