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 message google.bigtable.v2.ReadChangeStreamRequest
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 form |
↳ 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. |
↳ partition |
Google\Cloud\Bigtable\V2\StreamPartition
The partition to read changes from. |
↳ start_time |
Google\Protobuf\Timestamp
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. |
↳ continuation_tokens |
Google\Cloud\Bigtable\V2\StreamContinuationTokens
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 of |
↳ end_time |
Google\Protobuf\Timestamp
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. |
↳ heartbeat_duration |
Google\Protobuf\Duration
If specified, the duration between |
getTableName
Required. The unique name of the table from which to read a change stream.
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 read a change stream.
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 |
getPartition
The partition to read changes from.
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\V2\StreamPartition|null |
hasPartition
clearPartition
setPartition
The partition to read changes from.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Bigtable\V2\StreamPartition
|
Returns | |
---|---|
Type | Description |
$this |
getStartTime
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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasStartTime
setStartTime
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getContinuationTokens
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 of Heartbeat
and CloseStream
messages.
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.
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\V2\StreamContinuationTokens|null |
hasContinuationTokens
setContinuationTokens
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 of Heartbeat
and CloseStream
messages.
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Bigtable\V2\StreamContinuationTokens
|
Returns | |
---|---|
Type | Description |
$this |
getEndTime
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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasEndTime
clearEndTime
setEndTime
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getHeartbeatDuration
If specified, the duration between Heartbeat
messages on the stream.
Otherwise, defaults to 5 seconds.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Duration|null |
hasHeartbeatDuration
clearHeartbeatDuration
setHeartbeatDuration
If specified, the duration between Heartbeat
messages on the stream.
Otherwise, defaults to 5 seconds.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Duration
|
Returns | |
---|---|
Type | Description |
$this |
getStartFrom
Returns | |
---|---|
Type | Description |
string |