Interface ChangeStreamRecord.DataChangeRecordOrBuilder (6.96.1)

public static interface ChangeStreamRecord.DataChangeRecordOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getColumnMetadata(int index)

public abstract ChangeStreamRecord.DataChangeRecord.ColumnMetadata getColumnMetadata(int index)

Provides metadata describing the columns associated with the mods listed below.

repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.DataChangeRecord.ColumnMetadata

getColumnMetadataCount()

public abstract int getColumnMetadataCount()

Provides metadata describing the columns associated with the mods listed below.

repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;

Returns
Type Description
int

getColumnMetadataList()

public abstract List<ChangeStreamRecord.DataChangeRecord.ColumnMetadata> getColumnMetadataList()

Provides metadata describing the columns associated with the mods listed below.

repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;

Returns
Type Description
List<ColumnMetadata>

getColumnMetadataOrBuilder(int index)

public abstract ChangeStreamRecord.DataChangeRecord.ColumnMetadataOrBuilder getColumnMetadataOrBuilder(int index)

Provides metadata describing the columns associated with the mods listed below.

repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.DataChangeRecord.ColumnMetadataOrBuilder

getColumnMetadataOrBuilderList()

public abstract List<? extends ChangeStreamRecord.DataChangeRecord.ColumnMetadataOrBuilder> getColumnMetadataOrBuilderList()

Provides metadata describing the columns associated with the mods listed below.

repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;

Returns
Type Description
List<? extends com.google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadataOrBuilder>

getCommitTimestamp()

public abstract Timestamp getCommitTimestamp()

Indicates the timestamp in which the change was committed. DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition.

.google.protobuf.Timestamp commit_timestamp = 1;

Returns
Type Description
Timestamp

The commitTimestamp.

getCommitTimestampOrBuilder()

public abstract TimestampOrBuilder getCommitTimestampOrBuilder()

Indicates the timestamp in which the change was committed. DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition.

.google.protobuf.Timestamp commit_timestamp = 1;

Returns
Type Description
TimestampOrBuilder

getIsLastRecordInTransactionInPartition()

public abstract boolean getIsLastRecordInTransactionInPartition()

Indicates whether this is the last record for a transaction in the current partition. Clients can use this field to determine when all records for a transaction in the current partition have been received.

bool is_last_record_in_transaction_in_partition = 4;

Returns
Type Description
boolean

The isLastRecordInTransactionInPartition.

getIsSystemTransaction()

public abstract boolean getIsSystemTransaction()

Indicates whether the transaction is a system transaction. System transactions include those issued by time-to-live (TTL), column backfill, etc.

bool is_system_transaction = 13;

Returns
Type Description
boolean

The isSystemTransaction.

getModType()

public abstract ChangeStreamRecord.DataChangeRecord.ModType getModType()

Describes the type of change.

.google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ModType mod_type = 8;

Returns
Type Description
ChangeStreamRecord.DataChangeRecord.ModType

The modType.

getModTypeValue()

public abstract int getModTypeValue()

Describes the type of change.

.google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ModType mod_type = 8;

Returns
Type Description
int

The enum numeric value on the wire for modType.

getMods(int index)

public abstract ChangeStreamRecord.DataChangeRecord.Mod getMods(int index)

Describes the changes that were made.

repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.DataChangeRecord.Mod

getModsCount()

public abstract int getModsCount()

Describes the changes that were made.

repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;

Returns
Type Description
int

getModsList()

public abstract List<ChangeStreamRecord.DataChangeRecord.Mod> getModsList()

Describes the changes that were made.

repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;

Returns
Type Description
List<Mod>

getModsOrBuilder(int index)

public abstract ChangeStreamRecord.DataChangeRecord.ModOrBuilder getModsOrBuilder(int index)

Describes the changes that were made.

repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.DataChangeRecord.ModOrBuilder

getModsOrBuilderList()

public abstract List<? extends ChangeStreamRecord.DataChangeRecord.ModOrBuilder> getModsOrBuilderList()

Describes the changes that were made.

repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;

Returns
Type Description
List<? extends com.google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ModOrBuilder>

getNumberOfPartitionsInTransaction()

public abstract int getNumberOfPartitionsInTransaction()

Indicates the number of partitions that return data change records for this transaction. This value can be helpful in assembling all records associated with a particular transaction.

int32 number_of_partitions_in_transaction = 11;

Returns
Type Description
int

The numberOfPartitionsInTransaction.

getNumberOfRecordsInTransaction()

public abstract int getNumberOfRecordsInTransaction()

Indicates the number of data change records that are part of this transaction across all change stream partitions. This value can be used to assemble all the records associated with a particular transaction.

int32 number_of_records_in_transaction = 10;

Returns
Type Description
int

The numberOfRecordsInTransaction.

getRecordSequence()

public abstract String 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.

The record sequence number ordering across partitions is only meaningful in the context of a specific transaction. Record sequence numbers are unique across partitions for a specific transaction. Sort the DataChangeRecords for the same server_transaction_id by record_sequence to reconstruct the ordering of the changes within the transaction.

string record_sequence = 2;

Returns
Type Description
String

The recordSequence.

getRecordSequenceBytes()

public abstract ByteString getRecordSequenceBytes()

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.

The record sequence number ordering across partitions is only meaningful in the context of a specific transaction. Record sequence numbers are unique across partitions for a specific transaction. Sort the DataChangeRecords for the same server_transaction_id by record_sequence to reconstruct the ordering of the changes within the transaction.

string record_sequence = 2;

Returns
Type Description
ByteString

The bytes for recordSequence.

getServerTransactionId()

public abstract String getServerTransactionId()

Provides a globally unique string that represents the transaction in which the change was committed. Multiple transactions can have the same commit timestamp, but each transaction has a unique server_transaction_id.

string server_transaction_id = 3;

Returns
Type Description
String

The serverTransactionId.

getServerTransactionIdBytes()

public abstract ByteString getServerTransactionIdBytes()

Provides a globally unique string that represents the transaction in which the change was committed. Multiple transactions can have the same commit timestamp, but each transaction has a unique server_transaction_id.

string server_transaction_id = 3;

Returns
Type Description
ByteString

The bytes for serverTransactionId.

getTable()

public abstract String getTable()

Name of the table affected by the change.

string table = 5;

Returns
Type Description
String

The table.

getTableBytes()

public abstract ByteString getTableBytes()

Name of the table affected by the change.

string table = 5;

Returns
Type Description
ByteString

The bytes for table.

getTransactionTag()

public abstract String getTransactionTag()

Indicates the transaction tag associated with this transaction.

string transaction_tag = 12;

Returns
Type Description
String

The transactionTag.

getTransactionTagBytes()

public abstract ByteString getTransactionTagBytes()

Indicates the transaction tag associated with this transaction.

string transaction_tag = 12;

Returns
Type Description
ByteString

The bytes for transactionTag.

getValueCaptureType()

public abstract ChangeStreamRecord.DataChangeRecord.ValueCaptureType getValueCaptureType()

Describes the value capture type that was specified in the change stream configuration when this change was captured.

.google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ValueCaptureType value_capture_type = 9;

Returns
Type Description
ChangeStreamRecord.DataChangeRecord.ValueCaptureType

The valueCaptureType.

getValueCaptureTypeValue()

public abstract int getValueCaptureTypeValue()

Describes the value capture type that was specified in the change stream configuration when this change was captured.

.google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ValueCaptureType value_capture_type = 9;

Returns
Type Description
int

The enum numeric value on the wire for valueCaptureType.

hasCommitTimestamp()

public abstract boolean hasCommitTimestamp()

Indicates the timestamp in which the change was committed. DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition.

.google.protobuf.Timestamp commit_timestamp = 1;

Returns
Type Description
boolean

Whether the commitTimestamp field is set.