Package com.google.spanner.v1

Class Transaction

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.spanner.v1.Transaction

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransactionOrBuilder, Serializable

@Generated
public final class Transaction
extends com.google.protobuf.GeneratedMessage
implements TransactionOrBuilder

 A transaction.
 

Protobuf type google.spanner.v1.Transaction

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Transaction.Builder	A transaction.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CACHE_UPDATE_FIELD_NUMBER
static final int	ID_FIELD_NUMBER
static final int	PRECOMMIT_TOKEN_FIELD_NUMBER
static final int	READ_TIMESTAMP_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
CacheUpdate	getCacheUpdate()	Optional.
CacheUpdateOrBuilder	getCacheUpdateOrBuilder()	Optional.
static Transaction	getDefaultInstance()
Transaction	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.ByteString	getId()	`id` may be used to identify the transaction in subsequent [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], [Commit][google.spanner.v1.Spanner.Commit], or [Rollback][google.spanner.v1.Spanner.Rollback] calls.
com.google.protobuf.Parser<Transaction>	getParserForType()
MultiplexedSessionPrecommitToken	getPrecommitToken()	A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the [BeginTransaction][google.spanner.v1.BeginTransactionRequest].
MultiplexedSessionPrecommitTokenOrBuilder	getPrecommitTokenOrBuilder()	A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the [BeginTransaction][google.spanner.v1.BeginTransactionRequest].
com.google.protobuf.Timestamp	getReadTimestamp()	For snapshot read-only transactions, the read timestamp chosen for the transaction.
com.google.protobuf.TimestampOrBuilder	getReadTimestampOrBuilder()	For snapshot read-only transactions, the read timestamp chosen for the transaction.
int	getSerializedSize()
boolean	hasCacheUpdate()	Optional.
int	hashCode()
boolean	hasPrecommitToken()	A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the [BeginTransaction][google.spanner.v1.BeginTransactionRequest].
boolean	hasReadTimestamp()	For snapshot read-only transactions, the read timestamp chosen for the transaction.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static Transaction.Builder	newBuilder()
static Transaction.Builder	newBuilder(Transaction prototype)
Transaction.Builder	newBuilderForType()
protected Transaction.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Transaction	parseDelimitedFrom(InputStream input)
static Transaction	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Transaction	parseFrom(byte[] data)
static Transaction	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Transaction	parseFrom(com.google.protobuf.ByteString data)
static Transaction	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Transaction	parseFrom(com.google.protobuf.CodedInputStream input)
static Transaction	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Transaction	parseFrom(InputStream input)
static Transaction	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Transaction	parseFrom(ByteBuffer data)
static Transaction	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Transaction>	parser()
Transaction.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

• Constant Field Values

READ_TIMESTAMP_FIELD_NUMBER

public static final int READ_TIMESTAMP_FIELD_NUMBER

See Also:

• Constant Field Values

PRECOMMIT_TOKEN_FIELD_NUMBER

public static final int PRECOMMIT_TOKEN_FIELD_NUMBER

See Also:

• Constant Field Values

CACHE_UPDATE_FIELD_NUMBER

public static final int CACHE_UPDATE_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getId

public com.google.protobuf.ByteString getId()

 `id` may be used to identify the transaction in subsequent
 [Read][google.spanner.v1.Spanner.Read],
 [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql],
 [Commit][google.spanner.v1.Spanner.Commit], or
 [Rollback][google.spanner.v1.Spanner.Rollback] calls.

 Single-use read-only transactions do not have IDs, because
 single-use transactions do not support multiple requests.
 

bytes id = 1;

Specified by:

getId in interface TransactionOrBuilder

Returns:

The id.

hasReadTimestamp

public boolean hasReadTimestamp()

 For snapshot read-only transactions, the read timestamp chosen
 for the transaction. Not returned by default: see
 [TransactionOptions.ReadOnly.return_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.return_read_timestamp].

 A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds.
 Example: `"2014-10-02T15:01:23.045123456Z"`.
 

.google.protobuf.Timestamp read_timestamp = 2;

Specified by:

hasReadTimestamp in interface TransactionOrBuilder

Returns:

Whether the readTimestamp field is set.

getReadTimestamp

public com.google.protobuf.Timestamp getReadTimestamp()

 For snapshot read-only transactions, the read timestamp chosen
 for the transaction. Not returned by default: see
 [TransactionOptions.ReadOnly.return_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.return_read_timestamp].

 A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds.
 Example: `"2014-10-02T15:01:23.045123456Z"`.
 

.google.protobuf.Timestamp read_timestamp = 2;

Specified by:

getReadTimestamp in interface TransactionOrBuilder

Returns:

The readTimestamp.

getReadTimestampOrBuilder

public com.google.protobuf.TimestampOrBuilder getReadTimestampOrBuilder()

 For snapshot read-only transactions, the read timestamp chosen
 for the transaction. Not returned by default: see
 [TransactionOptions.ReadOnly.return_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.return_read_timestamp].

 A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds.
 Example: `"2014-10-02T15:01:23.045123456Z"`.
 

.google.protobuf.Timestamp read_timestamp = 2;

Specified by:

getReadTimestampOrBuilder in interface TransactionOrBuilder

hasPrecommitToken

public boolean hasPrecommitToken()

 A precommit token is included in the response of a BeginTransaction
 request if the read-write transaction is on a multiplexed session and
 a mutation_key was specified in the
 [BeginTransaction][google.spanner.v1.BeginTransactionRequest].
 The precommit token with the highest sequence number from this transaction
 attempt should be passed to the [Commit][google.spanner.v1.Spanner.Commit]
 request for this transaction.
 

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3;

Specified by:

hasPrecommitToken in interface TransactionOrBuilder

Returns:

Whether the precommitToken field is set.

getPrecommitToken

public MultiplexedSessionPrecommitToken getPrecommitToken()

 A precommit token is included in the response of a BeginTransaction
 request if the read-write transaction is on a multiplexed session and
 a mutation_key was specified in the
 [BeginTransaction][google.spanner.v1.BeginTransactionRequest].
 The precommit token with the highest sequence number from this transaction
 attempt should be passed to the [Commit][google.spanner.v1.Spanner.Commit]
 request for this transaction.
 

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3;

Specified by:

getPrecommitToken in interface TransactionOrBuilder

Returns:

The precommitToken.

getPrecommitTokenOrBuilder

public MultiplexedSessionPrecommitTokenOrBuilder getPrecommitTokenOrBuilder()

 A precommit token is included in the response of a BeginTransaction
 request if the read-write transaction is on a multiplexed session and
 a mutation_key was specified in the
 [BeginTransaction][google.spanner.v1.BeginTransactionRequest].
 The precommit token with the highest sequence number from this transaction
 attempt should be passed to the [Commit][google.spanner.v1.Spanner.Commit]
 request for this transaction.
 

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3;

Specified by:

getPrecommitTokenOrBuilder in interface TransactionOrBuilder

hasCacheUpdate

public boolean hasCacheUpdate()

 Optional. A cache update expresses a set of changes the client should
 incorporate into its location cache. The client should discard the changes
 if they are older than the data it already has. This data can be obtained
 in response to requests that included a `RoutingHint` field, but may also
 be obtained by explicit location-fetching RPCs which may be added in the
 future.
 

.google.spanner.v1.CacheUpdate cache_update = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasCacheUpdate in interface TransactionOrBuilder

Returns:

Whether the cacheUpdate field is set.

getCacheUpdate

public CacheUpdate getCacheUpdate()

 Optional. A cache update expresses a set of changes the client should
 incorporate into its location cache. The client should discard the changes
 if they are older than the data it already has. This data can be obtained
 in response to requests that included a `RoutingHint` field, but may also
 be obtained by explicit location-fetching RPCs which may be added in the
 future.
 

.google.spanner.v1.CacheUpdate cache_update = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCacheUpdate in interface TransactionOrBuilder

Returns:

The cacheUpdate.

getCacheUpdateOrBuilder

public CacheUpdateOrBuilder getCacheUpdateOrBuilder()

 Optional. A cache update expresses a set of changes the client should
 incorporate into its location cache. The client should discard the changes
 if they are older than the data it already has. This data can be obtained
 in response to requests that included a `RoutingHint` field, but may also
 be obtained by explicit location-fetching RPCs which may be added in the
 future.
 

.google.spanner.v1.CacheUpdate cache_update = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCacheUpdateOrBuilder in interface TransactionOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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 Transaction parseFrom(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Transaction parseFrom(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Transaction parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Transaction parseFrom(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Transaction parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Transaction parseFrom(com.google.protobuf.CodedInputStream input)
                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Transaction.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Transaction.Builder newBuilder()

newBuilder

public static Transaction.Builder newBuilder(Transaction prototype)

toBuilder

public Transaction.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Transaction.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Transaction getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Transaction> 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.GeneratedMessage

getDefaultInstanceForType

public Transaction getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder