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

Class PartitionEndRecord

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.PartitionEndRecord

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A partition end record serves as a notification that the client should stop reading the partition. No further records are expected to be retrieved on it.

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
PartitionEndRecord()

Method Summary

Modifier and Type	Method and Description
PartitionEndRecord	clone()
String	getEndTimestamp() End timestamp at which the change stream partition is terminated.
String	getPartitionToken() Unique partition identifier describing the terminated change stream partition.
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.
PartitionEndRecord	set(String fieldName, Object value)
PartitionEndRecord	setEndTimestamp(String endTimestamp) End timestamp at which the change stream partition is terminated.
PartitionEndRecord	setPartitionToken(String partitionToken) Unique partition identifier describing the terminated change stream partition.
PartitionEndRecord	setRecordSequence(String recordSequence) Record sequence numbers are unique and monotonically increasing (but not necessarily contiguous) for a specific timestamp across record types in the same 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

PartitionEndRecord

public PartitionEndRecord()

Method Detail

getEndTimestamp

public String getEndTimestamp()

End timestamp at which the change stream partition is terminated. All changes generated by this partition will have timestamps <= end_timestamp. DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition. PartitionEndRecord is the last record returned for a partition.

Returns:

value or null for none

setEndTimestamp

public PartitionEndRecord setEndTimestamp(String endTimestamp)

End timestamp at which the change stream partition is terminated. All changes generated by this partition will have timestamps <= end_timestamp. DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition. PartitionEndRecord is the last record returned for a partition.

Parameters:

endTimestamp - endTimestamp or null for none

getPartitionToken

public String getPartitionToken()

Unique partition identifier describing the terminated change stream partition. partition_token is equal to the partition token of the change stream partition currently queried to return this PartitionEndRecord.

Returns:

value or null for none

setPartitionToken

public PartitionEndRecord setPartitionToken(String partitionToken)

Unique partition identifier describing the terminated change stream partition. partition_token is equal to the partition token of the change stream partition currently queried to return this PartitionEndRecord.

Parameters:

partitionToken - partitionToken or null for none

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.

Returns:

value or null for none

setRecordSequence

public PartitionEndRecord setRecordSequence(String recordSequence)

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.

Parameters:

recordSequence - recordSequence or null for none

set

public PartitionEndRecord set(String fieldName,
                              Object value)

Overrides:

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

clone

public PartitionEndRecord clone()

Overrides:

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