com.google.api.services.spanner.v1.model

Class DataChangeRecord

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.DataChangeRecord

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DataChangeRecord
extends com.google.api.client.json.GenericJson

A data change record contains a set of changes to a table with the same modification type (insert, update, or delete) committed at the same commit timestamp in one change stream partition for the same transaction. Multiple data change records can be returned for the same transaction across multiple change stream partitions.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
DataChangeRecord()

Method Summary

Modifier and Type	Method and Description
DataChangeRecord	clone()
List<ColumnMetadata>	getColumnMetadata() Provides metadata describing the columns associated with the mods listed below.
String	getCommitTimestamp() Indicates the timestamp in which the change was committed.
Boolean	getIsLastRecordInTransactionInPartition() Indicates whether this is the last record for a transaction in the current partition.
Boolean	getIsSystemTransaction() Indicates whether the transaction is a system transaction.
List<Mod>	getMods() Describes the changes that were made.
String	getModType() Describes the type of change.
Integer	getNumberOfPartitionsInTransaction() Indicates the number of partitions that return data change records for this transaction.
Integer	getNumberOfRecordsInTransaction() Indicates the number of data change records that are part of this transaction across all change stream partitions.
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.
String	getServerTransactionId() Provides a globally unique string that represents the transaction in which the change was committed.
String	getTable() Name of the table affected by the change.
String	getTransactionTag() Indicates the transaction tag associated with this transaction.
String	getValueCaptureType() Describes the value capture type that was specified in the change stream configuration when this change was captured.
DataChangeRecord	set(String fieldName, Object value)
DataChangeRecord	setColumnMetadata(List<ColumnMetadata> columnMetadata) Provides metadata describing the columns associated with the mods listed below.
DataChangeRecord	setCommitTimestamp(String commitTimestamp) Indicates the timestamp in which the change was committed.
DataChangeRecord	setIsLastRecordInTransactionInPartition(Boolean isLastRecordInTransactionInPartition) Indicates whether this is the last record for a transaction in the current partition.
DataChangeRecord	setIsSystemTransaction(Boolean isSystemTransaction) Indicates whether the transaction is a system transaction.
DataChangeRecord	setMods(List<Mod> mods) Describes the changes that were made.
DataChangeRecord	setModType(String modType) Describes the type of change.
DataChangeRecord	setNumberOfPartitionsInTransaction(Integer numberOfPartitionsInTransaction) Indicates the number of partitions that return data change records for this transaction.
DataChangeRecord	setNumberOfRecordsInTransaction(Integer numberOfRecordsInTransaction) Indicates the number of data change records that are part of this transaction across all change stream partitions.
DataChangeRecord	setRecordSequence(String recordSequence) Record sequence numbers are unique and monotonically increasing (but not necessarily contiguous) for a specific timestamp across record types in the same partition.
DataChangeRecord	setServerTransactionId(String serverTransactionId) Provides a globally unique string that represents the transaction in which the change was committed.
DataChangeRecord	setTable(String table) Name of the table affected by the change.
DataChangeRecord	setTransactionTag(String transactionTag) Indicates the transaction tag associated with this transaction.
DataChangeRecord	setValueCaptureType(String valueCaptureType) Describes the value capture type that was specified in the change stream configuration when this change was captured.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

DataChangeRecord

public DataChangeRecord()

Method Detail

getColumnMetadata

public List<ColumnMetadata> getColumnMetadata()

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

Returns:

value or null for none

setColumnMetadata

public DataChangeRecord setColumnMetadata(List<ColumnMetadata> columnMetadata)

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

Parameters:

columnMetadata - columnMetadata or null for none

getCommitTimestamp

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

Returns:

value or null for none

setCommitTimestamp

public DataChangeRecord setCommitTimestamp(String commitTimestamp)

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.

Parameters:

commitTimestamp - commitTimestamp or null for none

getIsLastRecordInTransactionInPartition

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

Returns:

value or null for none

setIsLastRecordInTransactionInPartition

public DataChangeRecord setIsLastRecordInTransactionInPartition(Boolean isLastRecordInTransactionInPartition)

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.

Parameters:

isLastRecordInTransactionInPartition - isLastRecordInTransactionInPartition or null for none

getIsSystemTransaction

public Boolean getIsSystemTransaction()

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

Returns:

value or null for none

setIsSystemTransaction

public DataChangeRecord setIsSystemTransaction(Boolean isSystemTransaction)

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

Parameters:

isSystemTransaction - isSystemTransaction or null for none

getModType

public String getModType()

Describes the type of change.

Returns:

value or null for none

setModType

public DataChangeRecord setModType(String modType)

Describes the type of change.

Parameters:

modType - modType or null for none

getMods

public List<Mod> getMods()

Describes the changes that were made.

Returns:

value or null for none

setMods

public DataChangeRecord setMods(List<Mod> mods)

Describes the changes that were made.

Parameters:

mods - mods or null for none

getNumberOfPartitionsInTransaction

public Integer 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.

Returns:

value or null for none

setNumberOfPartitionsInTransaction

public DataChangeRecord setNumberOfPartitionsInTransaction(Integer numberOfPartitionsInTransaction)

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.

Parameters:

numberOfPartitionsInTransaction - numberOfPartitionsInTransaction or null for none

getNumberOfRecordsInTransaction

public Integer 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.

Returns:

value or null for none

setNumberOfRecordsInTransaction

public DataChangeRecord setNumberOfRecordsInTransaction(Integer numberOfRecordsInTransaction)

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.

Parameters:

numberOfRecordsInTransaction - numberOfRecordsInTransaction or null for none

getRecordSequence

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

Returns:

value or null for none

setRecordSequence

public DataChangeRecord setRecordSequence(String recordSequence)

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.

Parameters:

recordSequence - recordSequence or null for none

getServerTransactionId

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

Returns:

value or null for none

setServerTransactionId

public DataChangeRecord setServerTransactionId(String serverTransactionId)

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.

Parameters:

serverTransactionId - serverTransactionId or null for none

getTable

public String getTable()

Name of the table affected by the change.

Returns:

value or null for none

setTable

public DataChangeRecord setTable(String table)

Name of the table affected by the change.

Parameters:

table - table or null for none

getTransactionTag

public String getTransactionTag()

Indicates the transaction tag associated with this transaction.

Returns:

value or null for none

setTransactionTag

public DataChangeRecord setTransactionTag(String transactionTag)

Indicates the transaction tag associated with this transaction.

Parameters:

transactionTag - transactionTag or null for none

getValueCaptureType

public String getValueCaptureType()

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

Returns:

value or null for none

setValueCaptureType

public DataChangeRecord setValueCaptureType(String valueCaptureType)

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

Parameters:

valueCaptureType - valueCaptureType or null for none

set

public DataChangeRecord set(String fieldName,
                            Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public DataChangeRecord clone()

Overrides:

clone in class com.google.api.client.json.GenericJson