Package com.google.spanner.v1

Class ChangeStreamRecord

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.v1.ChangeStreamRecord
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ChangeStreamRecordOrBuilder, Serializable
public final class ChangeStreamRecord extends com.google.protobuf.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
See Also:

  • Field Details

    • DATA_CHANGE_RECORD_FIELD_NUMBER

      public static final int DATA_CHANGE_RECORD_FIELD_NUMBER
      See Also:

    • HEARTBEAT_RECORD_FIELD_NUMBER

      public static final int HEARTBEAT_RECORD_FIELD_NUMBER
      See Also:

    • PARTITION_START_RECORD_FIELD_NUMBER

      public static final int PARTITION_START_RECORD_FIELD_NUMBER
      See Also:

    • PARTITION_END_RECORD_FIELD_NUMBER

      public static final int PARTITION_END_RECORD_FIELD_NUMBER
      See Also:

    • PARTITION_EVENT_RECORD_FIELD_NUMBER

      public static final int PARTITION_EVENT_RECORD_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getRecordCase

      public ChangeStreamRecord.RecordCase getRecordCase()
      Specified by:
      getRecordCase in interface ChangeStreamRecordOrBuilder

    • 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;
      Specified by:
      hasDataChangeRecord in interface ChangeStreamRecordOrBuilder
      Returns:
      Whether the dataChangeRecord field is set.

    • 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;
      Specified by:
      getDataChangeRecord in interface ChangeStreamRecordOrBuilder
      Returns:
      The dataChangeRecord.

    • 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;
      Specified by:
      getDataChangeRecordOrBuilder in interface ChangeStreamRecordOrBuilder

    • hasHeartbeatRecord

      public boolean hasHeartbeatRecord()
       Heartbeat record describing a heartbeat for a change stream partition.
      .google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;
      Specified by:
      hasHeartbeatRecord in interface ChangeStreamRecordOrBuilder
      Returns:
      Whether the heartbeatRecord field is set.

    • getHeartbeatRecord

      public ChangeStreamRecord.HeartbeatRecord getHeartbeatRecord()
       Heartbeat record describing a heartbeat for a change stream partition.
      .google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;
      Specified by:
      getHeartbeatRecord in interface ChangeStreamRecordOrBuilder
      Returns:
      The heartbeatRecord.

    • getHeartbeatRecordOrBuilder

      public ChangeStreamRecord.HeartbeatRecordOrBuilder getHeartbeatRecordOrBuilder()
       Heartbeat record describing a heartbeat for a change stream partition.
      .google.spanner.v1.ChangeStreamRecord.HeartbeatRecord heartbeat_record = 2;
      Specified by:
      getHeartbeatRecordOrBuilder in interface ChangeStreamRecordOrBuilder

    • hasPartitionStartRecord

      public boolean hasPartitionStartRecord()
       Partition start record describing a new change stream partition.
      .google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;
      Specified by:
      hasPartitionStartRecord in interface ChangeStreamRecordOrBuilder
      Returns:
      Whether the partitionStartRecord field is set.

    • getPartitionStartRecord

      public ChangeStreamRecord.PartitionStartRecord getPartitionStartRecord()
       Partition start record describing a new change stream partition.
      .google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;
      Specified by:
      getPartitionStartRecord in interface ChangeStreamRecordOrBuilder
      Returns:
      The partitionStartRecord.

    • getPartitionStartRecordOrBuilder

      public ChangeStreamRecord.PartitionStartRecordOrBuilder getPartitionStartRecordOrBuilder()
       Partition start record describing a new change stream partition.
      .google.spanner.v1.ChangeStreamRecord.PartitionStartRecord partition_start_record = 3;
      Specified by:
      getPartitionStartRecordOrBuilder in interface ChangeStreamRecordOrBuilder

    • hasPartitionEndRecord

      public boolean hasPartitionEndRecord()
       Partition end record describing a terminated change stream partition.
      .google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;
      Specified by:
      hasPartitionEndRecord in interface ChangeStreamRecordOrBuilder
      Returns:
      Whether the partitionEndRecord field is set.

    • getPartitionEndRecord

      public ChangeStreamRecord.PartitionEndRecord getPartitionEndRecord()
       Partition end record describing a terminated change stream partition.
      .google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;
      Specified by:
      getPartitionEndRecord in interface ChangeStreamRecordOrBuilder
      Returns:
      The partitionEndRecord.

    • getPartitionEndRecordOrBuilder

      public ChangeStreamRecord.PartitionEndRecordOrBuilder getPartitionEndRecordOrBuilder()
       Partition end record describing a terminated change stream partition.
      .google.spanner.v1.ChangeStreamRecord.PartitionEndRecord partition_end_record = 4;
      Specified by:
      getPartitionEndRecordOrBuilder in interface ChangeStreamRecordOrBuilder

    • 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;
      Specified by:
      hasPartitionEventRecord in interface ChangeStreamRecordOrBuilder
      Returns:
      Whether the partitionEventRecord field is set.

    • 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;
      Specified by:
      getPartitionEventRecord in interface ChangeStreamRecordOrBuilder
      Returns:
      The partitionEventRecord.

    • 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;
      Specified by:
      getPartitionEventRecordOrBuilder in interface ChangeStreamRecordOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ChangeStreamRecord parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ChangeStreamRecord parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ChangeStreamRecord parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ChangeStreamRecord parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ChangeStreamRecord parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ChangeStreamRecord parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ChangeStreamRecord parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ChangeStreamRecord parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ChangeStreamRecord parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ChangeStreamRecord parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ChangeStreamRecord parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ChangeStreamRecord parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ChangeStreamRecord.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ChangeStreamRecord.Builder newBuilder()

    • newBuilder

      public static ChangeStreamRecord.Builder newBuilder(ChangeStreamRecord prototype)

    • toBuilder

      public ChangeStreamRecord.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ChangeStreamRecord.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ChangeStreamRecord getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ChangeStreamRecord> parser()

    • getParserForType

      public com.google.protobuf.Parser<ChangeStreamRecord> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ChangeStreamRecord getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder