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
Namespace
Google \ Cloud \ Bigtable \ V2Methods
__construct
Constructor.
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 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.
↳ partition
↳ 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
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 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.
↳ 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 Heartbeat
messages on the stream. Otherwise, defaults to 5 seconds.
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.
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.
var
string
$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.
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.
var
string
$this
getPartition
The partition to read changes from.
hasPartition
clearPartition
setPartition
The partition to read changes from.
$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.
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.
$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.
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.
$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.
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.
$this
getHeartbeatDuration
If specified, the duration between Heartbeat
messages on the stream.
Otherwise, defaults to 5 seconds.
hasHeartbeatDuration
clearHeartbeatDuration
setHeartbeatDuration
If specified, the duration between Heartbeat
messages on the stream.
Otherwise, defaults to 5 seconds.
$this
getStartFrom
string
static::build
tableName
string
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. Please see BigtableClient::tableName()
for help formatting this field.
static::buildFromTableNameAppProfileId
tableName
string
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. Please see 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.
