Reference documentation and code samples for the Cloud Spanner V1 Client class HeartbeatRecord.
A heartbeat record is returned as a progress indicator, when there are no data changes or any other partition record types in the change stream partition.
Generated from protobuf message google.spanner.v1.ChangeStreamRecord.HeartbeatRecord
Namespace
Google \ Cloud \ Spanner \ V1 \ ChangeStreamRecordMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ timestamp |
Google\Protobuf\Timestamp
Indicates the timestamp at which the query has returned all the records in the change stream partition with timestamp <= heartbeat timestamp. The heartbeat timestamp will not be the same as the timestamps of other record types in the same partition. |
getTimestamp
Indicates the timestamp at which the query has returned all the records in the change stream partition with timestamp <= heartbeat timestamp.
The heartbeat timestamp will not be the same as the timestamps of other record types in the same partition.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasTimestamp
clearTimestamp
setTimestamp
Indicates the timestamp at which the query has returned all the records in the change stream partition with timestamp <= heartbeat timestamp.
The heartbeat timestamp will not be the same as the timestamps of other record types in the same partition.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |