Package org.apache.beam.sdk.io.gcp.spanner.changestreams.model

Class PartitionEndRecord

java.lang.Object

org.apache.beam.sdk.io.gcp.spanner.changestreams.model.PartitionEndRecord

All Implemented Interfaces:

Serializable, ChangeStreamRecord

@DefaultCoder(AvroCoder.class)
public class PartitionEndRecord
extends Object
implements ChangeStreamRecord

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.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PartitionEndRecord(com.google.cloud.Timestamp endTimestamp, String recordSequence, ChangeStreamRecordMetadata metadata)	Constructs the partition end record with the given timestamp, record sequence and metadata.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
com.google.cloud.Timestamp	getEndTimestamp()	The end timestamp at which the change stream partition is terminated.
String	getRecordSequence()	Indicates the order in which a record was put to the stream.
com.google.cloud.Timestamp	getRecordTimestamp()	Indicates the timestamp for which the change stream partition is terminated.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PartitionEndRecord

public PartitionEndRecord(com.google.cloud.Timestamp endTimestamp,
 String recordSequence,
 ChangeStreamRecordMetadata metadata)

Constructs the partition end record with the given timestamp, record sequence and metadata.

Parameters:

endTimestamp - end timestamp at which the change stream partition is terminated

recordSequence - the order within a partition and a transaction in which the record was put to the stream

metadata - connector execution metadata for the given record

Method Details

getRecordTimestamp

public com.google.cloud.Timestamp getRecordTimestamp()

Indicates the timestamp for which the change stream partition is terminated.

Specified by:

getRecordTimestamp in interface ChangeStreamRecord

Returns:

the timestamp for which the change stream partition is terminated

getEndTimestamp

public com.google.cloud.Timestamp getEndTimestamp()

The end timestamp at which the change stream partition is terminated.

Returns:

the timestamp for which the change stream partition is terminated

getRecordSequence

public String getRecordSequence()

Indicates the order in which a record was put to the stream. Is unique and increasing within a partition. It is relative to the scope of partition, commit timestamp, and server_transaction_id. It is useful for readers downstream to dedup any duplicate records that were read/recorded.

Returns:

record sequence of the record

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object