Cloud Bigtable V2 Client - Class Heartbeat (1.25.0)

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

A periodic message with information that can be used to checkpoint the state of a stream.

Generated from protobuf message google.bigtable.v2.ReadChangeStreamResponse.Heartbeat

Namespace

Google \ Cloud \ Bigtable \ V2 \ ReadChangeStreamResponse

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ continuation_token Google\Cloud\Bigtable\V2\StreamContinuationToken

A token that can be provided to a subsequent ReadChangeStream call to pick up reading at the current stream position.

↳ estimated_low_watermark Google\Protobuf\Timestamp

An estimate of the commit timestamp that is usually lower than or equal to any timestamp for a record that will be delivered in the future on the stream. It is possible that, under particular circumstances that a future record has a timestamp is is lower than a previously seen timestamp. For an example usage see https://beam.apache.org/documentation/basics/#watermarks

getContinuationToken

A token that can be provided to a subsequent ReadChangeStream call to pick up reading at the current stream position.

Returns
TypeDescription
Google\Cloud\Bigtable\V2\StreamContinuationToken|null

hasContinuationToken

clearContinuationToken

setContinuationToken

A token that can be provided to a subsequent ReadChangeStream call to pick up reading at the current stream position.

Parameter
NameDescription
var Google\Cloud\Bigtable\V2\StreamContinuationToken
Returns
TypeDescription
$this

getEstimatedLowWatermark

An estimate of the commit timestamp that is usually lower than or equal to any timestamp for a record that will be delivered in the future on the stream. It is possible that, under particular circumstances that a future record has a timestamp is is lower than a previously seen timestamp. For an example usage see https://beam.apache.org/documentation/basics/#watermarks

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEstimatedLowWatermark

clearEstimatedLowWatermark

setEstimatedLowWatermark

An estimate of the commit timestamp that is usually lower than or equal to any timestamp for a record that will be delivered in the future on the stream. It is possible that, under particular circumstances that a future record has a timestamp is is lower than a previously seen timestamp. For an example usage see https://beam.apache.org/documentation/basics/#watermarks

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this