Class ChangeStreamRecord.Builder (6.95.1)

public static final class ChangeStreamRecord.Builder extends GeneratedMessageV3.Builder<ChangeStreamRecord.Builder> implements ChangeStreamRecordOrBuilder

Spanner Change Streams enable customers to capture and stream out changes to their Spanner databases in real-time. A change stream can be created with option partition_mode='IMMUTABLE_KEY_RANGE' or partition_mode='MUTABLE_KEY_RANGE'.

This message is only used in Change Streams created with the option partition_mode='MUTABLE_KEY_RANGE'. Spanner automatically creates a special Table-Valued Function (TVF) along with each Change Streams. The function provides access to the change stream's records. The function is named READ_<change_stream_name> (where <change_stream_name> is the name of the change stream), and it returns a table with only one column called ChangeRecord.

Protobuf type google.spanner.v1.ChangeStreamRecord

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ChangeStreamRecord.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ChangeStreamRecord.Builder
Overrides

build()

public ChangeStreamRecord build()
Returns
Type Description
ChangeStreamRecord

buildPartial()

public ChangeStreamRecord buildPartial()
Returns
Type Description
ChangeStreamRecord

clear()

public ChangeStreamRecord.Builder clear()
Returns
Type Description
ChangeStreamRecord.Builder
Overrides

clearDataChangeRecord()

public ChangeStreamRecord.Builder clearDataChangeRecord()

Data change record describing a data change for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.DataChangeRecord data_change_record = 1;

Returns
Type Description
ChangeStreamRecord.Builder

clearField(Descriptors.FieldDescriptor field)

public ChangeStreamRecord.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ChangeStreamRecord.Builder
Overrides

clearHeartbeatRecord()

public ChangeStreamRecord.Builder clearHeartbeatRecord()

Heartbeat record describing a heartbeat for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;

Returns
Type Description
ChangeStreamRecord.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ChangeStreamRecord.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ChangeStreamRecord.Builder
Overrides

clearPartitionEndRecord()

public ChangeStreamRecord.Builder clearPartitionEndRecord()

Partition end record describing a terminated change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;

Returns
Type Description
ChangeStreamRecord.Builder

clearPartitionEventRecord()

public ChangeStreamRecord.Builder clearPartitionEventRecord()

Partition event record describing key range changes for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEventRecord partition_event_record = 5;

Returns
Type Description
ChangeStreamRecord.Builder

clearPartitionStartRecord()

public ChangeStreamRecord.Builder clearPartitionStartRecord()

Partition start record describing a new change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;

Returns
Type Description
ChangeStreamRecord.Builder

clearRecord()

public ChangeStreamRecord.Builder clearRecord()
Returns
Type Description
ChangeStreamRecord.Builder

clone()

public ChangeStreamRecord.Builder clone()
Returns
Type Description
ChangeStreamRecord.Builder
Overrides

getDataChangeRecord()

public ChangeStreamRecord.DataChangeRecord getDataChangeRecord()

Data change record describing a data change for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.DataChangeRecord data_change_record = 1;

Returns
Type Description
ChangeStreamRecord.DataChangeRecord

The dataChangeRecord.

getDataChangeRecordBuilder()

public ChangeStreamRecord.DataChangeRecord.Builder getDataChangeRecordBuilder()

Data change record describing a data change for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.DataChangeRecord data_change_record = 1;

Returns
Type Description
ChangeStreamRecord.DataChangeRecord.Builder

getDataChangeRecordOrBuilder()

public ChangeStreamRecord.DataChangeRecordOrBuilder getDataChangeRecordOrBuilder()

Data change record describing a data change for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.DataChangeRecord data_change_record = 1;

Returns
Type Description
ChangeStreamRecord.DataChangeRecordOrBuilder

getDefaultInstanceForType()

public ChangeStreamRecord getDefaultInstanceForType()
Returns
Type Description
ChangeStreamRecord

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHeartbeatRecord()

public ChangeStreamRecord.HeartbeatRecord getHeartbeatRecord()

Heartbeat record describing a heartbeat for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;

Returns
Type Description
ChangeStreamRecord.HeartbeatRecord

The heartbeatRecord.

getHeartbeatRecordBuilder()

public ChangeStreamRecord.HeartbeatRecord.Builder getHeartbeatRecordBuilder()

Heartbeat record describing a heartbeat for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;

Returns
Type Description
ChangeStreamRecord.HeartbeatRecord.Builder

getHeartbeatRecordOrBuilder()

public ChangeStreamRecord.HeartbeatRecordOrBuilder getHeartbeatRecordOrBuilder()

Heartbeat record describing a heartbeat for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;

Returns
Type Description
ChangeStreamRecord.HeartbeatRecordOrBuilder

getPartitionEndRecord()

public ChangeStreamRecord.PartitionEndRecord getPartitionEndRecord()

Partition end record describing a terminated change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;

Returns
Type Description
ChangeStreamRecord.PartitionEndRecord

The partitionEndRecord.

getPartitionEndRecordBuilder()

public ChangeStreamRecord.PartitionEndRecord.Builder getPartitionEndRecordBuilder()

Partition end record describing a terminated change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;

Returns
Type Description
ChangeStreamRecord.PartitionEndRecord.Builder

getPartitionEndRecordOrBuilder()

public ChangeStreamRecord.PartitionEndRecordOrBuilder getPartitionEndRecordOrBuilder()

Partition end record describing a terminated change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;

Returns
Type Description
ChangeStreamRecord.PartitionEndRecordOrBuilder

getPartitionEventRecord()

public ChangeStreamRecord.PartitionEventRecord getPartitionEventRecord()

Partition event record describing key range changes for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEventRecord partition_event_record = 5;

Returns
Type Description
ChangeStreamRecord.PartitionEventRecord

The partitionEventRecord.

getPartitionEventRecordBuilder()

public ChangeStreamRecord.PartitionEventRecord.Builder getPartitionEventRecordBuilder()

Partition event record describing key range changes for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEventRecord partition_event_record = 5;

Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

getPartitionEventRecordOrBuilder()

public ChangeStreamRecord.PartitionEventRecordOrBuilder getPartitionEventRecordOrBuilder()

Partition event record describing key range changes for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEventRecord partition_event_record = 5;

Returns
Type Description
ChangeStreamRecord.PartitionEventRecordOrBuilder

getPartitionStartRecord()

public ChangeStreamRecord.PartitionStartRecord getPartitionStartRecord()

Partition start record describing a new change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;

Returns
Type Description
ChangeStreamRecord.PartitionStartRecord

The partitionStartRecord.

getPartitionStartRecordBuilder()

public ChangeStreamRecord.PartitionStartRecord.Builder getPartitionStartRecordBuilder()

Partition start record describing a new change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;

Returns
Type Description
ChangeStreamRecord.PartitionStartRecord.Builder

getPartitionStartRecordOrBuilder()

public ChangeStreamRecord.PartitionStartRecordOrBuilder getPartitionStartRecordOrBuilder()

Partition start record describing a new change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;

Returns
Type Description
ChangeStreamRecord.PartitionStartRecordOrBuilder

getRecordCase()

public ChangeStreamRecord.RecordCase getRecordCase()
Returns
Type Description
ChangeStreamRecord.RecordCase

hasDataChangeRecord()

public boolean hasDataChangeRecord()

Data change record describing a data change for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.DataChangeRecord data_change_record = 1;

Returns
Type Description
boolean

Whether the dataChangeRecord field is set.

hasHeartbeatRecord()

public boolean hasHeartbeatRecord()

Heartbeat record describing a heartbeat for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;

Returns
Type Description
boolean

Whether the heartbeatRecord field is set.

hasPartitionEndRecord()

public boolean hasPartitionEndRecord()

Partition end record describing a terminated change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;

Returns
Type Description
boolean

Whether the partitionEndRecord field is set.

hasPartitionEventRecord()

public boolean hasPartitionEventRecord()

Partition event record describing key range changes for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEventRecord partition_event_record = 5;

Returns
Type Description
boolean

Whether the partitionEventRecord field is set.

hasPartitionStartRecord()

public boolean hasPartitionStartRecord()

Partition start record describing a new change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;

Returns
Type Description
boolean

Whether the partitionStartRecord field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDataChangeRecord(ChangeStreamRecord.DataChangeRecord value)

public ChangeStreamRecord.Builder mergeDataChangeRecord(ChangeStreamRecord.DataChangeRecord value)

Data change record describing a data change for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.DataChangeRecord data_change_record = 1;

Parameter
Name Description
value ChangeStreamRecord.DataChangeRecord
Returns
Type Description
ChangeStreamRecord.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ChangeStreamRecord.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChangeStreamRecord.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ChangeStreamRecord.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ChangeStreamRecord.Builder
Overrides

mergeFrom(ChangeStreamRecord other)

public ChangeStreamRecord.Builder mergeFrom(ChangeStreamRecord other)
Parameter
Name Description
other ChangeStreamRecord
Returns
Type Description
ChangeStreamRecord.Builder

mergeHeartbeatRecord(ChangeStreamRecord.HeartbeatRecord value)

public ChangeStreamRecord.Builder mergeHeartbeatRecord(ChangeStreamRecord.HeartbeatRecord value)

Heartbeat record describing a heartbeat for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;

Parameter
Name Description
value ChangeStreamRecord.HeartbeatRecord
Returns
Type Description
ChangeStreamRecord.Builder

mergePartitionEndRecord(ChangeStreamRecord.PartitionEndRecord value)

public ChangeStreamRecord.Builder mergePartitionEndRecord(ChangeStreamRecord.PartitionEndRecord value)

Partition end record describing a terminated change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;

Parameter
Name Description
value ChangeStreamRecord.PartitionEndRecord
Returns
Type Description
ChangeStreamRecord.Builder

mergePartitionEventRecord(ChangeStreamRecord.PartitionEventRecord value)

public ChangeStreamRecord.Builder mergePartitionEventRecord(ChangeStreamRecord.PartitionEventRecord value)

Partition event record describing key range changes for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEventRecord partition_event_record = 5;

Parameter
Name Description
value ChangeStreamRecord.PartitionEventRecord
Returns
Type Description
ChangeStreamRecord.Builder

mergePartitionStartRecord(ChangeStreamRecord.PartitionStartRecord value)

public ChangeStreamRecord.Builder mergePartitionStartRecord(ChangeStreamRecord.PartitionStartRecord value)

Partition start record describing a new change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;

Parameter
Name Description
value ChangeStreamRecord.PartitionStartRecord
Returns
Type Description
ChangeStreamRecord.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ChangeStreamRecord.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ChangeStreamRecord.Builder
Overrides

setDataChangeRecord(ChangeStreamRecord.DataChangeRecord value)

public ChangeStreamRecord.Builder setDataChangeRecord(ChangeStreamRecord.DataChangeRecord value)

Data change record describing a data change for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.DataChangeRecord data_change_record = 1;

Parameter
Name Description
value ChangeStreamRecord.DataChangeRecord
Returns
Type Description
ChangeStreamRecord.Builder

setDataChangeRecord(ChangeStreamRecord.DataChangeRecord.Builder builderForValue)

public ChangeStreamRecord.Builder setDataChangeRecord(ChangeStreamRecord.DataChangeRecord.Builder builderForValue)

Data change record describing a data change for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.DataChangeRecord data_change_record = 1;

Parameter
Name Description
builderForValue ChangeStreamRecord.DataChangeRecord.Builder
Returns
Type Description
ChangeStreamRecord.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ChangeStreamRecord.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ChangeStreamRecord.Builder
Overrides

setHeartbeatRecord(ChangeStreamRecord.HeartbeatRecord value)

public ChangeStreamRecord.Builder setHeartbeatRecord(ChangeStreamRecord.HeartbeatRecord value)

Heartbeat record describing a heartbeat for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;

Parameter
Name Description
value ChangeStreamRecord.HeartbeatRecord
Returns
Type Description
ChangeStreamRecord.Builder

setHeartbeatRecord(ChangeStreamRecord.HeartbeatRecord.Builder builderForValue)

public ChangeStreamRecord.Builder setHeartbeatRecord(ChangeStreamRecord.HeartbeatRecord.Builder builderForValue)

Heartbeat record describing a heartbeat for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;

Parameter
Name Description
builderForValue ChangeStreamRecord.HeartbeatRecord.Builder
Returns
Type Description
ChangeStreamRecord.Builder

setPartitionEndRecord(ChangeStreamRecord.PartitionEndRecord value)

public ChangeStreamRecord.Builder setPartitionEndRecord(ChangeStreamRecord.PartitionEndRecord value)

Partition end record describing a terminated change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;

Parameter
Name Description
value ChangeStreamRecord.PartitionEndRecord
Returns
Type Description
ChangeStreamRecord.Builder

setPartitionEndRecord(ChangeStreamRecord.PartitionEndRecord.Builder builderForValue)

public ChangeStreamRecord.Builder setPartitionEndRecord(ChangeStreamRecord.PartitionEndRecord.Builder builderForValue)

Partition end record describing a terminated change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;

Parameter
Name Description
builderForValue ChangeStreamRecord.PartitionEndRecord.Builder
Returns
Type Description
ChangeStreamRecord.Builder

setPartitionEventRecord(ChangeStreamRecord.PartitionEventRecord value)

public ChangeStreamRecord.Builder setPartitionEventRecord(ChangeStreamRecord.PartitionEventRecord value)

Partition event record describing key range changes for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEventRecord partition_event_record = 5;

Parameter
Name Description
value ChangeStreamRecord.PartitionEventRecord
Returns
Type Description
ChangeStreamRecord.Builder

setPartitionEventRecord(ChangeStreamRecord.PartitionEventRecord.Builder builderForValue)

public ChangeStreamRecord.Builder setPartitionEventRecord(ChangeStreamRecord.PartitionEventRecord.Builder builderForValue)

Partition event record describing key range changes for a change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionEventRecord partition_event_record = 5;

Parameter
Name Description
builderForValue ChangeStreamRecord.PartitionEventRecord.Builder
Returns
Type Description
ChangeStreamRecord.Builder

setPartitionStartRecord(ChangeStreamRecord.PartitionStartRecord value)

public ChangeStreamRecord.Builder setPartitionStartRecord(ChangeStreamRecord.PartitionStartRecord value)

Partition start record describing a new change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;

Parameter
Name Description
value ChangeStreamRecord.PartitionStartRecord
Returns
Type Description
ChangeStreamRecord.Builder

setPartitionStartRecord(ChangeStreamRecord.PartitionStartRecord.Builder builderForValue)

public ChangeStreamRecord.Builder setPartitionStartRecord(ChangeStreamRecord.PartitionStartRecord.Builder builderForValue)

Partition start record describing a new change stream partition.

.google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;

Parameter
Name Description
builderForValue ChangeStreamRecord.PartitionStartRecord.Builder
Returns
Type Description
ChangeStreamRecord.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ChangeStreamRecord.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ChangeStreamRecord.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ChangeStreamRecord.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ChangeStreamRecord.Builder
Overrides