com.google.api.services.spanner.v1.model

Class ChangeStreamRecord

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.ChangeStreamRecord

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ChangeStreamRecord
extends com.google.api.client.json.GenericJson

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_ (where is the name of the change stream), and it returns a table with only one column called ChangeRecord.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ChangeStreamRecord()

Method Summary

Modifier and Type	Method and Description
ChangeStreamRecord	clone()
DataChangeRecord	getDataChangeRecord() Data change record describing a data change for a change stream partition.
HeartbeatRecord	getHeartbeatRecord() Heartbeat record describing a heartbeat for a change stream partition.
PartitionEndRecord	getPartitionEndRecord() Partition end record describing a terminated change stream partition.
PartitionEventRecord	getPartitionEventRecord() Partition event record describing key range changes for a change stream partition.
PartitionStartRecord	getPartitionStartRecord() Partition start record describing a new change stream partition.
ChangeStreamRecord	set(String fieldName, Object value)
ChangeStreamRecord	setDataChangeRecord(DataChangeRecord dataChangeRecord) Data change record describing a data change for a change stream partition.
ChangeStreamRecord	setHeartbeatRecord(HeartbeatRecord heartbeatRecord) Heartbeat record describing a heartbeat for a change stream partition.
ChangeStreamRecord	setPartitionEndRecord(PartitionEndRecord partitionEndRecord) Partition end record describing a terminated change stream partition.
ChangeStreamRecord	setPartitionEventRecord(PartitionEventRecord partitionEventRecord) Partition event record describing key range changes for a change stream partition.
ChangeStreamRecord	setPartitionStartRecord(PartitionStartRecord partitionStartRecord) Partition start record describing a new change stream partition.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ChangeStreamRecord

public ChangeStreamRecord()

Method Detail

getDataChangeRecord

public DataChangeRecord getDataChangeRecord()

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

Returns:

value or null for none

setDataChangeRecord

public ChangeStreamRecord setDataChangeRecord(DataChangeRecord dataChangeRecord)

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

Parameters:

dataChangeRecord - dataChangeRecord or null for none

getHeartbeatRecord

public HeartbeatRecord getHeartbeatRecord()

Heartbeat record describing a heartbeat for a change stream partition.

Returns:

value or null for none

setHeartbeatRecord

public ChangeStreamRecord setHeartbeatRecord(HeartbeatRecord heartbeatRecord)

Heartbeat record describing a heartbeat for a change stream partition.

Parameters:

heartbeatRecord - heartbeatRecord or null for none

getPartitionEndRecord

public PartitionEndRecord getPartitionEndRecord()

Partition end record describing a terminated change stream partition.

Returns:

value or null for none

setPartitionEndRecord

public ChangeStreamRecord setPartitionEndRecord(PartitionEndRecord partitionEndRecord)

Partition end record describing a terminated change stream partition.

Parameters:

partitionEndRecord - partitionEndRecord or null for none

getPartitionEventRecord

public PartitionEventRecord getPartitionEventRecord()

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

Returns:

value or null for none

setPartitionEventRecord

public ChangeStreamRecord setPartitionEventRecord(PartitionEventRecord partitionEventRecord)

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

Parameters:

partitionEventRecord - partitionEventRecord or null for none

getPartitionStartRecord

public PartitionStartRecord getPartitionStartRecord()

Partition start record describing a new change stream partition.

Returns:

value or null for none

setPartitionStartRecord

public ChangeStreamRecord setPartitionStartRecord(PartitionStartRecord partitionStartRecord)

Partition start record describing a new change stream partition.

Parameters:

partitionStartRecord - partitionStartRecord or null for none

set

public ChangeStreamRecord set(String fieldName,
                              Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ChangeStreamRecord clone()

Overrides:

clone in class com.google.api.client.json.GenericJson