Class ChangeStreamRecord.PartitionEventRecord.Builder (6.96.1)

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

A partition event record describes key range changes for a change stream partition. The changes to a row defined by its primary key can be captured in one change stream partition for a specific time range, and then be captured in a different change stream partition for a different time range. This movement of key ranges across change stream partitions is a reflection of activities, such as Spanner's dynamic splitting and load balancing, etc. Processing this event is needed if users want to guarantee processing of the changes for any key in timestamp order. If time ordered processing of changes for a primary key is not needed, this event can be ignored. To guarantee time ordered processing for each primary key, if the event describes move-ins, the reader of this partition needs to wait until the readers of the source partitions have processed all records with timestamps <= this PartitionEventRecord.commit_timestamp, before advancing beyond this PartitionEventRecord. If the event describes move-outs, the reader can notify the readers of the destination partitions that they can continue processing.

Protobuf type google.spanner.v1.ChangeStreamRecord.PartitionEventRecord

Static Methods

getDescriptor()

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

Methods

addAllMoveInEvents(Iterable<? extends ChangeStreamRecord.PartitionEventRecord.MoveInEvent> values)

public ChangeStreamRecord.PartitionEventRecord.Builder addAllMoveInEvents(Iterable<? extends ChangeStreamRecord.PartitionEventRecord.MoveInEvent> values)

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Parameter
Name Description
values Iterable<? extends com.google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent>
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

addAllMoveOutEvents(Iterable<? extends ChangeStreamRecord.PartitionEventRecord.MoveOutEvent> values)

public ChangeStreamRecord.PartitionEventRecord.Builder addAllMoveOutEvents(Iterable<? extends ChangeStreamRecord.PartitionEventRecord.MoveOutEvent> values)

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Parameter
Name Description
values Iterable<? extends com.google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent>
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

addMoveInEvents(ChangeStreamRecord.PartitionEventRecord.MoveInEvent value)

public ChangeStreamRecord.PartitionEventRecord.Builder addMoveInEvents(ChangeStreamRecord.PartitionEventRecord.MoveInEvent value)

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

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

addMoveInEvents(ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder builderForValue)

public ChangeStreamRecord.PartitionEventRecord.Builder addMoveInEvents(ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder builderForValue)

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

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

addMoveInEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveInEvent value)

public ChangeStreamRecord.PartitionEventRecord.Builder addMoveInEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveInEvent value)

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Parameters
Name Description
index int
value ChangeStreamRecord.PartitionEventRecord.MoveInEvent
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

addMoveInEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder builderForValue)

public ChangeStreamRecord.PartitionEventRecord.Builder addMoveInEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder builderForValue)

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Parameters
Name Description
index int
builderForValue ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

addMoveInEventsBuilder()

public ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder addMoveInEventsBuilder()

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder

addMoveInEventsBuilder(int index)

public ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder addMoveInEventsBuilder(int index)

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder

addMoveOutEvents(ChangeStreamRecord.PartitionEventRecord.MoveOutEvent value)

public ChangeStreamRecord.PartitionEventRecord.Builder addMoveOutEvents(ChangeStreamRecord.PartitionEventRecord.MoveOutEvent value)

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

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

addMoveOutEvents(ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder builderForValue)

public ChangeStreamRecord.PartitionEventRecord.Builder addMoveOutEvents(ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder builderForValue)

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

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

addMoveOutEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveOutEvent value)

public ChangeStreamRecord.PartitionEventRecord.Builder addMoveOutEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveOutEvent value)

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Parameters
Name Description
index int
value ChangeStreamRecord.PartitionEventRecord.MoveOutEvent
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

addMoveOutEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder builderForValue)

public ChangeStreamRecord.PartitionEventRecord.Builder addMoveOutEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder builderForValue)

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Parameters
Name Description
index int
builderForValue ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

addMoveOutEventsBuilder()

public ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder addMoveOutEventsBuilder()

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder

addMoveOutEventsBuilder(int index)

public ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder addMoveOutEventsBuilder(int index)

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ChangeStreamRecord.PartitionEventRecord build()
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord

buildPartial()

public ChangeStreamRecord.PartitionEventRecord buildPartial()
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord

clear()

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

clearCommitTimestamp()

public ChangeStreamRecord.PartitionEventRecord.Builder clearCommitTimestamp()

Indicates the commit timestamp at which the key range change occurred. 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.PartitionEventRecord.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearMoveInEvents()

public ChangeStreamRecord.PartitionEventRecord.Builder clearMoveInEvents()

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

clearMoveOutEvents()

public ChangeStreamRecord.PartitionEventRecord.Builder clearMoveOutEvents()

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPartitionToken()

public ChangeStreamRecord.PartitionEventRecord.Builder clearPartitionToken()

Unique partition identifier describing the partition this event occurred on. partition_token is equal to the partition token of the change stream partition currently queried to return this PartitionEventRecord.

string partition_token = 3;

Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

This builder for chaining.

clearRecordSequence()

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

string record_sequence = 2;

Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

This builder for chaining.

clone()

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

getCommitTimestamp()

public Timestamp getCommitTimestamp()

Indicates the commit timestamp at which the key range change occurred. 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 commit timestamp at which the key range change occurred. 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 commit timestamp at which the key range change occurred. 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.PartitionEventRecord getDefaultInstanceForType()
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord

getDescriptorForType()

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

getMoveInEvents(int index)

public ChangeStreamRecord.PartitionEventRecord.MoveInEvent getMoveInEvents(int index)

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.MoveInEvent

getMoveInEventsBuilder(int index)

public ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder getMoveInEventsBuilder(int index)

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder

getMoveInEventsBuilderList()

public List<ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder> getMoveInEventsBuilderList()

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Returns
Type Description
List<Builder>

getMoveInEventsCount()

public int getMoveInEventsCount()

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Returns
Type Description
int

getMoveInEventsList()

public List<ChangeStreamRecord.PartitionEventRecord.MoveInEvent> getMoveInEventsList()

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Returns
Type Description
List<MoveInEvent>

getMoveInEventsOrBuilder(int index)

public ChangeStreamRecord.PartitionEventRecord.MoveInEventOrBuilder getMoveInEventsOrBuilder(int index)

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.MoveInEventOrBuilder

getMoveInEventsOrBuilderList()

public List<? extends ChangeStreamRecord.PartitionEventRecord.MoveInEventOrBuilder> getMoveInEventsOrBuilderList()

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Returns
Type Description
List<? extends com.google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEventOrBuilder>

getMoveOutEvents(int index)

public ChangeStreamRecord.PartitionEventRecord.MoveOutEvent getMoveOutEvents(int index)

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.MoveOutEvent

getMoveOutEventsBuilder(int index)

public ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder getMoveOutEventsBuilder(int index)

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder

getMoveOutEventsBuilderList()

public List<ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder> getMoveOutEventsBuilderList()

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Returns
Type Description
List<Builder>

getMoveOutEventsCount()

public int getMoveOutEventsCount()

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Returns
Type Description
int

getMoveOutEventsList()

public List<ChangeStreamRecord.PartitionEventRecord.MoveOutEvent> getMoveOutEventsList()

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Returns
Type Description
List<MoveOutEvent>

getMoveOutEventsOrBuilder(int index)

public ChangeStreamRecord.PartitionEventRecord.MoveOutEventOrBuilder getMoveOutEventsOrBuilder(int index)

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.MoveOutEventOrBuilder

getMoveOutEventsOrBuilderList()

public List<? extends ChangeStreamRecord.PartitionEventRecord.MoveOutEventOrBuilder> getMoveOutEventsOrBuilderList()

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Returns
Type Description
List<? extends com.google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEventOrBuilder>

getPartitionToken()

public String getPartitionToken()

Unique partition identifier describing the partition this event occurred on. partition_token is equal to the partition token of the change stream partition currently queried to return this PartitionEventRecord.

string partition_token = 3;

Returns
Type Description
String

The partitionToken.

getPartitionTokenBytes()

public ByteString getPartitionTokenBytes()

Unique partition identifier describing the partition this event occurred on. partition_token is equal to the partition token of the change stream partition currently queried to return this PartitionEventRecord.

string partition_token = 3;

Returns
Type Description
ByteString

The bytes for partitionToken.

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.

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.

string record_sequence = 2;

Returns
Type Description
ByteString

The bytes for recordSequence.

hasCommitTimestamp()

public boolean hasCommitTimestamp()

Indicates the commit timestamp at which the key range change occurred. 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
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCommitTimestamp(Timestamp value)

public ChangeStreamRecord.PartitionEventRecord.Builder mergeCommitTimestamp(Timestamp value)

Indicates the commit timestamp at which the key range change occurred. 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.PartitionEventRecord.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(ChangeStreamRecord.PartitionEventRecord other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeMoveInEvents(int index)

public ChangeStreamRecord.PartitionEventRecord.Builder removeMoveInEvents(int index)

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

removeMoveOutEvents(int index)

public ChangeStreamRecord.PartitionEventRecord.Builder removeMoveOutEvents(int index)

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

setCommitTimestamp(Timestamp value)

public ChangeStreamRecord.PartitionEventRecord.Builder setCommitTimestamp(Timestamp value)

Indicates the commit timestamp at which the key range change occurred. 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.PartitionEventRecord.Builder

setCommitTimestamp(Timestamp.Builder builderForValue)

public ChangeStreamRecord.PartitionEventRecord.Builder setCommitTimestamp(Timestamp.Builder builderForValue)

Indicates the commit timestamp at which the key range change occurred. 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.PartitionEventRecord.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setMoveInEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveInEvent value)

public ChangeStreamRecord.PartitionEventRecord.Builder setMoveInEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveInEvent value)

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Parameters
Name Description
index int
value ChangeStreamRecord.PartitionEventRecord.MoveInEvent
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

setMoveInEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder builderForValue)

public ChangeStreamRecord.PartitionEventRecord.Builder setMoveInEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder builderForValue)

Set when one or more key ranges are moved into the change stream partition identified by partition_token.

Example: Two key ranges are moved into partition (P1) from partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_in_events { source_partition_token: "P2" } move_in_events { source_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_out_events { destination_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_out_events { destination_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveInEvent move_in_events = 4;

Parameters
Name Description
index int
builderForValue ChangeStreamRecord.PartitionEventRecord.MoveInEvent.Builder
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

setMoveOutEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveOutEvent value)

public ChangeStreamRecord.PartitionEventRecord.Builder setMoveOutEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveOutEvent value)

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Parameters
Name Description
index int
value ChangeStreamRecord.PartitionEventRecord.MoveOutEvent
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

setMoveOutEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder builderForValue)

public ChangeStreamRecord.PartitionEventRecord.Builder setMoveOutEvents(int index, ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder builderForValue)

Set when one or more key ranges are moved out of the change stream partition identified by partition_token.

Example: Two key ranges are moved out of partition (P1) to partition (P2) and partition (P3) in a single transaction at timestamp T.

The PartitionEventRecord returned in P1 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P1" move_out_events { destination_partition_token: "P2" } move_out_events { destination_partition_token: "P3" } }

The PartitionEventRecord returned in P2 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P2" move_in_events { source_partition_token: "P1" } }

The PartitionEventRecord returned in P3 will reflect the move as:

PartitionEventRecord { commit_timestamp: T partition_token: "P3" move_in_events { source_partition_token: "P1" } }

repeated .google.spanner.v1.ChangeStreamRecord.PartitionEventRecord.MoveOutEvent move_out_events = 5;

Parameters
Name Description
index int
builderForValue ChangeStreamRecord.PartitionEventRecord.MoveOutEvent.Builder
Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

setPartitionToken(String value)

public ChangeStreamRecord.PartitionEventRecord.Builder setPartitionToken(String value)

Unique partition identifier describing the partition this event occurred on. partition_token is equal to the partition token of the change stream partition currently queried to return this PartitionEventRecord.

string partition_token = 3;

Parameter
Name Description
value String

The partitionToken to set.

Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

This builder for chaining.

setPartitionTokenBytes(ByteString value)

public ChangeStreamRecord.PartitionEventRecord.Builder setPartitionTokenBytes(ByteString value)

Unique partition identifier describing the partition this event occurred on. partition_token is equal to the partition token of the change stream partition currently queried to return this PartitionEventRecord.

string partition_token = 3;

Parameter
Name Description
value ByteString

The bytes for partitionToken to set.

Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

This builder for chaining.

setRecordSequence(String value)

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

string record_sequence = 2;

Parameter
Name Description
value String

The recordSequence to set.

Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

This builder for chaining.

setRecordSequenceBytes(ByteString value)

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

string record_sequence = 2;

Parameter
Name Description
value ByteString

The bytes for recordSequence to set.

Returns
Type Description
ChangeStreamRecord.PartitionEventRecord.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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