Send feedback
Class ChangeStreamRecord (6.97.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class ChangeStreamRecord extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DATA_CHANGE_RECORD_FIELD_NUMBER
public static final int DATA_CHANGE_RECORD_FIELD_NUMBER
Field Value
Type Description
int
HEARTBEAT_RECORD_FIELD_NUMBER
public static final int HEARTBEAT_RECORD_FIELD_NUMBER
Field Value
Type Description
int
PARTITION_END_RECORD_FIELD_NUMBER
public static final int PARTITION_END_RECORD_FIELD_NUMBER
Field Value
Type Description
int
PARTITION_EVENT_RECORD_FIELD_NUMBER
public static final int PARTITION_EVENT_RECORD_FIELD_NUMBER
Field Value
Type Description
int
PARTITION_START_RECORD_FIELD_NUMBER
public static final int PARTITION_START_RECORD_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static ChangeStreamRecord getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ChangeStreamRecord . Builder newBuilder ()
newBuilder(ChangeStreamRecord prototype)
public static ChangeStreamRecord . Builder newBuilder ( ChangeStreamRecord prototype )
public static ChangeStreamRecord parseDelimitedFrom ( InputStream input )
public static ChangeStreamRecord parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ChangeStreamRecord parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ChangeStreamRecord parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ChangeStreamRecord parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ChangeStreamRecord parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ChangeStreamRecord parseFrom ( CodedInputStream input )
public static ChangeStreamRecord parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ChangeStreamRecord parseFrom ( InputStream input )
public static ChangeStreamRecord parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ChangeStreamRecord parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ChangeStreamRecord parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ChangeStreamRecord> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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;
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;
getDefaultInstanceForType()
public ChangeStreamRecord getDefaultInstanceForType ()
getHeartbeatRecord()
public ChangeStreamRecord . HeartbeatRecord getHeartbeatRecord ()
Heartbeat record describing a heartbeat for a change stream partition.
.google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;
getHeartbeatRecordOrBuilder()
public ChangeStreamRecord . HeartbeatRecordOrBuilder getHeartbeatRecordOrBuilder ()
Heartbeat record describing a heartbeat for a change stream partition.
.google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;
getParserForType()
public Parser<ChangeStreamRecord> getParserForType ()
Overrides
getPartitionEndRecord()
public ChangeStreamRecord . PartitionEndRecord getPartitionEndRecord ()
Partition end record describing a terminated change stream partition.
.google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;
getPartitionEndRecordOrBuilder()
public ChangeStreamRecord . PartitionEndRecordOrBuilder getPartitionEndRecordOrBuilder ()
Partition end record describing a terminated change stream partition.
.google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;
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;
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;
getPartitionStartRecord()
public ChangeStreamRecord . PartitionStartRecord getPartitionStartRecord ()
Partition start record describing a new change stream partition.
.google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;
getPartitionStartRecordOrBuilder()
public ChangeStreamRecord . PartitionStartRecordOrBuilder getPartitionStartRecordOrBuilder ()
Partition start record describing a new change stream partition.
.google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;
getRecordCase()
public ChangeStreamRecord . RecordCase getRecordCase ()
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ChangeStreamRecord . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ChangeStreamRecord . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public ChangeStreamRecord . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-26 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-26 UTC."],[],[]]
