Cloud Spanner V1 Client - Class PartitionEndRecord (1.104.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class PartitionEndRecord.

A partition end record serves as a notification that the client should stop reading the partition. No further records are expected to be retrieved on it.

Generated from protobuf message google.spanner.v1.ChangeStreamRecord.PartitionEndRecord

Namespace

Google \ Cloud \ Spanner \ V1 \ ChangeStreamRecord

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ end_timestamp Google\Protobuf\Timestamp

End timestamp at which the change stream partition is terminated. All changes generated by this partition will have timestamps <= end_timestamp. DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition. PartitionEndRecord is the last record returned for a partition.
↳ record_sequence string

Record sequence numbers are unique and monotonically increasing (but not necessarily contiguous) for a specific timestamp across record types in the same partition. To guarantee ordered processing, the reader should process records (of potentially different types) in record_sequence order for a specific timestamp in the same partition.
↳ partition_token string

Unique partition identifier describing the terminated change stream partition. partition_token is equal to the partition token of the change stream partition currently queried to return this PartitionEndRecord.

getEndTimestamp

End timestamp at which the change stream partition is terminated. All changes generated by this partition will have timestamps <= end_timestamp. DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition. PartitionEndRecord is the last record returned for a partition.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTimestamp

clearEndTimestamp

setEndTimestamp

End timestamp at which the change stream partition is terminated. All changes generated by this partition will have timestamps <= end_timestamp. DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition. PartitionEndRecord is the last record returned for a partition.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRecordSequence

Record sequence numbers are unique and monotonically increasing (but not necessarily contiguous) for a specific timestamp across record types in the same partition. To guarantee ordered processing, the reader should process records (of potentially different types) in record_sequence order for a specific timestamp in the same partition.

Returns
Type Description
string

setRecordSequence

Record sequence numbers are unique and monotonically increasing (but not necessarily contiguous) for a specific timestamp across record types in the same partition. To guarantee ordered processing, the reader should process records (of potentially different types) in record_sequence order for a specific timestamp in the same partition.

Parameter
Name Description
var string
Returns
Type Description
$this

getPartitionToken

Unique partition identifier describing the terminated change stream partition.

partition_token is equal to the partition token of the change stream partition currently queried to return this PartitionEndRecord.

Returns
Type Description
string

setPartitionToken

Unique partition identifier describing the terminated change stream partition.

partition_token is equal to the partition token of the change stream partition currently queried to return this PartitionEndRecord.

Parameter
Name Description
var string
Returns
Type Description
$this