Package com.google.spanner.v1

Interface ChangeStreamRecord.DataChangeRecordOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ChangeStreamRecord.DataChangeRecord, ChangeStreamRecord.DataChangeRecord.Builder
Enclosing class:
ChangeStreamRecord
public static interface ChangeStreamRecord.DataChangeRecordOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasCommitTimestamp

      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:
      Whether the commitTimestamp field is set.

    • getCommitTimestamp

      com.google.protobuf.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:
      The commitTimestamp.

    • getCommitTimestampOrBuilder

      com.google.protobuf.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;

    • getRecordSequence

      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][google.spanner.v1.ChangeStreamRecord.DataChangeRecord.server_transaction_id]
 by
 [record_sequence][google.spanner.v1.ChangeStreamRecord.DataChangeRecord.record_sequence]
 to reconstruct the ordering of the changes within the transaction.
      string record_sequence = 2;
      Returns:
      The recordSequence.

    • getRecordSequenceBytes

      com.google.protobuf.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][google.spanner.v1.ChangeStreamRecord.DataChangeRecord.server_transaction_id]
 by
 [record_sequence][google.spanner.v1.ChangeStreamRecord.DataChangeRecord.record_sequence]
 to reconstruct the ordering of the changes within the transaction.
      string record_sequence = 2;
      Returns:
      The bytes for recordSequence.

    • getServerTransactionId

      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:
      The serverTransactionId.

    • getServerTransactionIdBytes

      com.google.protobuf.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:
      The bytes for serverTransactionId.

    • getIsLastRecordInTransactionInPartition

      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:
      The isLastRecordInTransactionInPartition.

    • getTable

      String getTable()
       Name of the table affected by the change.
      string table = 5;
      Returns:
      The table.

    • getTableBytes

      com.google.protobuf.ByteString getTableBytes()
       Name of the table affected by the change.
      string table = 5;
      Returns:
      The bytes for table.

    • getColumnMetadataList

      List<ChangeStreamRecord.DataChangeRecord.ColumnMetadata> getColumnMetadataList()
       Provides metadata describing the columns associated with the
 [mods][google.spanner.v1.ChangeStreamRecord.DataChangeRecord.mods] listed
 below.
      repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;

    • getColumnMetadata

      ChangeStreamRecord.DataChangeRecord.ColumnMetadata getColumnMetadata(int index)
       Provides metadata describing the columns associated with the
 [mods][google.spanner.v1.ChangeStreamRecord.DataChangeRecord.mods] listed
 below.
      repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;

    • getColumnMetadataCount

      int getColumnMetadataCount()
       Provides metadata describing the columns associated with the
 [mods][google.spanner.v1.ChangeStreamRecord.DataChangeRecord.mods] listed
 below.
      repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;

    • getColumnMetadataOrBuilderList

      List<? extends ChangeStreamRecord.DataChangeRecord.ColumnMetadataOrBuilder> getColumnMetadataOrBuilderList()
       Provides metadata describing the columns associated with the
 [mods][google.spanner.v1.ChangeStreamRecord.DataChangeRecord.mods] listed
 below.
      repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;

    • getColumnMetadataOrBuilder

      ChangeStreamRecord.DataChangeRecord.ColumnMetadataOrBuilder getColumnMetadataOrBuilder(int index)
       Provides metadata describing the columns associated with the
 [mods][google.spanner.v1.ChangeStreamRecord.DataChangeRecord.mods] listed
 below.
      repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;

    • getModsList

      List<ChangeStreamRecord.DataChangeRecord.Mod> getModsList()
       Describes the changes that were made.
      repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;

    • getMods

      ChangeStreamRecord.DataChangeRecord.Mod getMods(int index)
       Describes the changes that were made.
      repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;

    • getModsCount

      int getModsCount()
       Describes the changes that were made.
      repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;

    • getModsOrBuilderList

      List<? extends ChangeStreamRecord.DataChangeRecord.ModOrBuilder> getModsOrBuilderList()
       Describes the changes that were made.
      repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;

    • getModsOrBuilder

      ChangeStreamRecord.DataChangeRecord.ModOrBuilder getModsOrBuilder(int index)
       Describes the changes that were made.
      repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;

    • getModTypeValue

      int getModTypeValue()
       Describes the type of change.
      .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ModType mod_type = 8;
      Returns:
      The enum numeric value on the wire for modType.

    • getModType

      ChangeStreamRecord.DataChangeRecord.ModType getModType()
       Describes the type of change.
      .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ModType mod_type = 8;
      Returns:
      The modType.

    • getValueCaptureTypeValue

      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:
      The enum numeric value on the wire for valueCaptureType.

    • getValueCaptureType

      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:
      The valueCaptureType.

    • getNumberOfRecordsInTransaction

      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:
      The numberOfRecordsInTransaction.

    • getNumberOfPartitionsInTransaction

      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:
      The numberOfPartitionsInTransaction.

    • getTransactionTag

      String getTransactionTag()
       Indicates the transaction tag associated with this transaction.
      string transaction_tag = 12;
      Returns:
      The transactionTag.

    • getTransactionTagBytes

      com.google.protobuf.ByteString getTransactionTagBytes()
       Indicates the transaction tag associated with this transaction.
      string transaction_tag = 12;
      Returns:
      The bytes for transactionTag.

    • getIsSystemTransaction

      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:
      The isSystemTransaction.