- 6.96.1 (latest)
- 6.95.1
- 6.94.0
- 6.93.0
- 6.89.0
- 6.88.0
- 6.87.0
- 6.86.0
- 6.85.0
- 6.83.0
- 6.82.0
- 6.80.1
- 6.79.0
- 6.77.0
- 6.74.1
- 6.72.0
- 6.71.0
- 6.69.0
- 6.68.0
- 6.66.0
- 6.65.1
- 6.62.0
- 6.60.0
- 6.58.0
- 6.57.0
- 6.56.0
- 6.55.0
- 6.54.0
- 6.53.0
- 6.52.1
- 6.51.0
- 6.50.1
- 6.49.0
- 6.25.1
- 6.24.0
- 6.23.4
- 6.22.0
- 6.21.2
- 6.20.0
- 6.19.1
- 6.18.0
- 6.17.4
- 6.14.1
public static final class ChangeStreamRecord.DataChangeRecord.Builder extends GeneratedMessageV3.Builder<ChangeStreamRecord.DataChangeRecord.Builder> implements ChangeStreamRecord.DataChangeRecordOrBuilderA 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.
Protobuf type google.spanner.v1.ChangeStreamRecord.DataChangeRecord
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ChangeStreamRecord.DataChangeRecord.BuilderImplements
ChangeStreamRecord.DataChangeRecordOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllColumnMetadata(Iterable<? extends ChangeStreamRecord.DataChangeRecord.ColumnMetadata> values)
public ChangeStreamRecord.DataChangeRecord.Builder addAllColumnMetadata(Iterable<? extends ChangeStreamRecord.DataChangeRecord.ColumnMetadata> values)Provides metadata describing the columns associated with the mods listed below.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata> |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
addAllMods(Iterable<? extends ChangeStreamRecord.DataChangeRecord.Mod> values)
public ChangeStreamRecord.DataChangeRecord.Builder addAllMods(Iterable<? extends ChangeStreamRecord.DataChangeRecord.Mod> values)Describes the changes that were made.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod> |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
addColumnMetadata(ChangeStreamRecord.DataChangeRecord.ColumnMetadata value)
public ChangeStreamRecord.DataChangeRecord.Builder addColumnMetadata(ChangeStreamRecord.DataChangeRecord.ColumnMetadata value)Provides metadata describing the columns associated with the mods listed below.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
ChangeStreamRecord.DataChangeRecord.ColumnMetadata |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
addColumnMetadata(ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder builderForValue)
public ChangeStreamRecord.DataChangeRecord.Builder addColumnMetadata(ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder builderForValue)Provides metadata describing the columns associated with the mods listed below.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
addColumnMetadata(int index, ChangeStreamRecord.DataChangeRecord.ColumnMetadata value)
public ChangeStreamRecord.DataChangeRecord.Builder addColumnMetadata(int index, ChangeStreamRecord.DataChangeRecord.ColumnMetadata value)Provides metadata describing the columns associated with the mods listed below.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ChangeStreamRecord.DataChangeRecord.ColumnMetadata |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
addColumnMetadata(int index, ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder builderForValue)
public ChangeStreamRecord.DataChangeRecord.Builder addColumnMetadata(int index, ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder builderForValue)Provides metadata describing the columns associated with the mods listed below.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
addColumnMetadataBuilder()
public ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder addColumnMetadataBuilder()Provides metadata describing the columns associated with the mods listed below.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder |
|
addColumnMetadataBuilder(int index)
public ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder addColumnMetadataBuilder(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.Builder |
|
addMods(ChangeStreamRecord.DataChangeRecord.Mod value)
public ChangeStreamRecord.DataChangeRecord.Builder addMods(ChangeStreamRecord.DataChangeRecord.Mod value)Describes the changes that were made.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
ChangeStreamRecord.DataChangeRecord.Mod |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
addMods(ChangeStreamRecord.DataChangeRecord.Mod.Builder builderForValue)
public ChangeStreamRecord.DataChangeRecord.Builder addMods(ChangeStreamRecord.DataChangeRecord.Mod.Builder builderForValue)Describes the changes that were made.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ChangeStreamRecord.DataChangeRecord.Mod.Builder |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
addMods(int index, ChangeStreamRecord.DataChangeRecord.Mod value)
public ChangeStreamRecord.DataChangeRecord.Builder addMods(int index, ChangeStreamRecord.DataChangeRecord.Mod value)Describes the changes that were made.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ChangeStreamRecord.DataChangeRecord.Mod |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
addMods(int index, ChangeStreamRecord.DataChangeRecord.Mod.Builder builderForValue)
public ChangeStreamRecord.DataChangeRecord.Builder addMods(int index, ChangeStreamRecord.DataChangeRecord.Mod.Builder builderForValue)Describes the changes that were made.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ChangeStreamRecord.DataChangeRecord.Mod.Builder |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
addModsBuilder()
public ChangeStreamRecord.DataChangeRecord.Mod.Builder addModsBuilder()Describes the changes that were made.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Mod.Builder |
|
addModsBuilder(int index)
public ChangeStreamRecord.DataChangeRecord.Mod.Builder addModsBuilder(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.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ChangeStreamRecord.DataChangeRecord.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
build()
public ChangeStreamRecord.DataChangeRecord build()| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord |
|
buildPartial()
public ChangeStreamRecord.DataChangeRecord buildPartial()| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord |
|
clear()
public ChangeStreamRecord.DataChangeRecord.Builder clear()| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
clearColumnMetadata()
public ChangeStreamRecord.DataChangeRecord.Builder clearColumnMetadata()Provides metadata describing the columns associated with the mods listed below.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
clearCommitTimestamp()
public ChangeStreamRecord.DataChangeRecord.Builder clearCommitTimestamp()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 |
ChangeStreamRecord.DataChangeRecord.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ChangeStreamRecord.DataChangeRecord.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
clearIsLastRecordInTransactionInPartition()
public ChangeStreamRecord.DataChangeRecord.Builder clearIsLastRecordInTransactionInPartition()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 |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
clearIsSystemTransaction()
public ChangeStreamRecord.DataChangeRecord.Builder clearIsSystemTransaction()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 |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
clearModType()
public ChangeStreamRecord.DataChangeRecord.Builder clearModType()Describes the type of change.
.google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ModType mod_type = 8;
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
clearMods()
public ChangeStreamRecord.DataChangeRecord.Builder clearMods()Describes the changes that were made.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
clearNumberOfPartitionsInTransaction()
public ChangeStreamRecord.DataChangeRecord.Builder clearNumberOfPartitionsInTransaction()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 |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
clearNumberOfRecordsInTransaction()
public ChangeStreamRecord.DataChangeRecord.Builder clearNumberOfRecordsInTransaction()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 |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ChangeStreamRecord.DataChangeRecord.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
clearRecordSequence()
public ChangeStreamRecord.DataChangeRecord.Builder clearRecordSequence()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 |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
clearServerTransactionId()
public ChangeStreamRecord.DataChangeRecord.Builder clearServerTransactionId()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 |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
clearTable()
public ChangeStreamRecord.DataChangeRecord.Builder clearTable()Name of the table affected by the change.
string table = 5;
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
clearTransactionTag()
public ChangeStreamRecord.DataChangeRecord.Builder clearTransactionTag()Indicates the transaction tag associated with this transaction.
string transaction_tag = 12;
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
clearValueCaptureType()
public ChangeStreamRecord.DataChangeRecord.Builder clearValueCaptureType()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.Builder |
This builder for chaining. |
clone()
public ChangeStreamRecord.DataChangeRecord.Builder clone()| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
getColumnMetadata(int index)
public 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 |
|
getColumnMetadataBuilder(int index)
public ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder getColumnMetadataBuilder(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.Builder |
|
getColumnMetadataBuilderList()
public List<ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder> getColumnMetadataBuilderList()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<Builder> |
|
getColumnMetadataCount()
public 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 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 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 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 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. |
getCommitTimestampBuilder()
public Timestamp.Builder getCommitTimestampBuilder()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 |
Builder |
|
getCommitTimestampOrBuilder()
public 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 |
|
getDefaultInstanceForType()
public ChangeStreamRecord.DataChangeRecord getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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.
bool is_last_record_in_transaction_in_partition = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
The isLastRecordInTransactionInPartition. |
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.
bool is_system_transaction = 13;
| Returns | |
|---|---|
| Type | Description |
boolean |
The isSystemTransaction. |
getModType()
public 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 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 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 |
|
getModsBuilder(int index)
public ChangeStreamRecord.DataChangeRecord.Mod.Builder getModsBuilder(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.Builder |
|
getModsBuilderList()
public List<ChangeStreamRecord.DataChangeRecord.Mod.Builder> getModsBuilderList()Describes the changes that were made.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getModsCount()
public int getModsCount()Describes the changes that were made.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;
| Returns | |
|---|---|
| Type | Description |
int |
|
getModsList()
public 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 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 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 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 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 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 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 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 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 String getTable()Name of the table affected by the change.
string table = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The table. |
getTableBytes()
public ByteString getTableBytes()Name of the table affected by the change.
string table = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for table. |
getTransactionTag()
public String getTransactionTag()Indicates the transaction tag associated with this transaction.
string transaction_tag = 12;
| Returns | |
|---|---|
| Type | Description |
String |
The transactionTag. |
getTransactionTagBytes()
public ByteString getTransactionTagBytes()Indicates the transaction tag associated with this transaction.
string transaction_tag = 12;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for transactionTag. |
getValueCaptureType()
public 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCommitTimestamp(Timestamp value)
public ChangeStreamRecord.DataChangeRecord.Builder mergeCommitTimestamp(Timestamp value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ChangeStreamRecord.DataChangeRecord.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ChangeStreamRecord.DataChangeRecord.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
mergeFrom(ChangeStreamRecord.DataChangeRecord other)
public ChangeStreamRecord.DataChangeRecord.Builder mergeFrom(ChangeStreamRecord.DataChangeRecord other)| Parameter | |
|---|---|
| Name | Description |
other |
ChangeStreamRecord.DataChangeRecord |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ChangeStreamRecord.DataChangeRecord.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
removeColumnMetadata(int index)
public ChangeStreamRecord.DataChangeRecord.Builder removeColumnMetadata(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.Builder |
|
removeMods(int index)
public ChangeStreamRecord.DataChangeRecord.Builder removeMods(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.Builder |
|
setColumnMetadata(int index, ChangeStreamRecord.DataChangeRecord.ColumnMetadata value)
public ChangeStreamRecord.DataChangeRecord.Builder setColumnMetadata(int index, ChangeStreamRecord.DataChangeRecord.ColumnMetadata value)Provides metadata describing the columns associated with the mods listed below.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ChangeStreamRecord.DataChangeRecord.ColumnMetadata |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
setColumnMetadata(int index, ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder builderForValue)
public ChangeStreamRecord.DataChangeRecord.Builder setColumnMetadata(int index, ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder builderForValue)Provides metadata describing the columns associated with the mods listed below.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ColumnMetadata column_metadata = 6;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ChangeStreamRecord.DataChangeRecord.ColumnMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
setCommitTimestamp(Timestamp value)
public ChangeStreamRecord.DataChangeRecord.Builder setCommitTimestamp(Timestamp value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
setCommitTimestamp(Timestamp.Builder builderForValue)
public ChangeStreamRecord.DataChangeRecord.Builder setCommitTimestamp(Timestamp.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ChangeStreamRecord.DataChangeRecord.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
setIsLastRecordInTransactionInPartition(boolean value)
public ChangeStreamRecord.DataChangeRecord.Builder setIsLastRecordInTransactionInPartition(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe isLastRecordInTransactionInPartition to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setIsSystemTransaction(boolean value)
public ChangeStreamRecord.DataChangeRecord.Builder setIsSystemTransaction(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe isSystemTransaction to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setModType(ChangeStreamRecord.DataChangeRecord.ModType value)
public ChangeStreamRecord.DataChangeRecord.Builder setModType(ChangeStreamRecord.DataChangeRecord.ModType value)Describes the type of change.
.google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ModType mod_type = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
ChangeStreamRecord.DataChangeRecord.ModTypeThe modType to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setModTypeValue(int value)
public ChangeStreamRecord.DataChangeRecord.Builder setModTypeValue(int value)Describes the type of change.
.google.spanner.v1.ChangeStreamRecord.DataChangeRecord.ModType mod_type = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for modType to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setMods(int index, ChangeStreamRecord.DataChangeRecord.Mod value)
public ChangeStreamRecord.DataChangeRecord.Builder setMods(int index, ChangeStreamRecord.DataChangeRecord.Mod value)Describes the changes that were made.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ChangeStreamRecord.DataChangeRecord.Mod |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
setMods(int index, ChangeStreamRecord.DataChangeRecord.Mod.Builder builderForValue)
public ChangeStreamRecord.DataChangeRecord.Builder setMods(int index, ChangeStreamRecord.DataChangeRecord.Mod.Builder builderForValue)Describes the changes that were made.
repeated .google.spanner.v1.ChangeStreamRecord.DataChangeRecord.Mod mods = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ChangeStreamRecord.DataChangeRecord.Mod.Builder |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
setNumberOfPartitionsInTransaction(int value)
public ChangeStreamRecord.DataChangeRecord.Builder setNumberOfPartitionsInTransaction(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe numberOfPartitionsInTransaction to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setNumberOfRecordsInTransaction(int value)
public ChangeStreamRecord.DataChangeRecord.Builder setNumberOfRecordsInTransaction(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe numberOfRecordsInTransaction to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setRecordSequence(String value)
public ChangeStreamRecord.DataChangeRecord.Builder setRecordSequence(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe recordSequence to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setRecordSequenceBytes(ByteString value)
public ChangeStreamRecord.DataChangeRecord.Builder setRecordSequenceBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for recordSequence to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ChangeStreamRecord.DataChangeRecord.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
setServerTransactionId(String value)
public ChangeStreamRecord.DataChangeRecord.Builder setServerTransactionId(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe serverTransactionId to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setServerTransactionIdBytes(ByteString value)
public ChangeStreamRecord.DataChangeRecord.Builder setServerTransactionIdBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for serverTransactionId to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setTable(String value)
public ChangeStreamRecord.DataChangeRecord.Builder setTable(String value)Name of the table affected by the change.
string table = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe table to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setTableBytes(ByteString value)
public ChangeStreamRecord.DataChangeRecord.Builder setTableBytes(ByteString value)Name of the table affected by the change.
string table = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for table to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setTransactionTag(String value)
public ChangeStreamRecord.DataChangeRecord.Builder setTransactionTag(String value)Indicates the transaction tag associated with this transaction.
string transaction_tag = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe transactionTag to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setTransactionTagBytes(ByteString value)
public ChangeStreamRecord.DataChangeRecord.Builder setTransactionTagBytes(ByteString value)Indicates the transaction tag associated with this transaction.
string transaction_tag = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for transactionTag to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ChangeStreamRecord.DataChangeRecord.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
|
setValueCaptureType(ChangeStreamRecord.DataChangeRecord.ValueCaptureType value)
public ChangeStreamRecord.DataChangeRecord.Builder setValueCaptureType(ChangeStreamRecord.DataChangeRecord.ValueCaptureType value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ChangeStreamRecord.DataChangeRecord.ValueCaptureTypeThe valueCaptureType to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |
setValueCaptureTypeValue(int value)
public ChangeStreamRecord.DataChangeRecord.Builder setValueCaptureTypeValue(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for valueCaptureType to set. |
| Returns | |
|---|---|
| Type | Description |
ChangeStreamRecord.DataChangeRecord.Builder |
This builder for chaining. |