Class Transaction.Builder (6.116.0)

6.116.0 (latest) 6.111.1 6.108.0 6.107.0 6.103.0 6.102.1 6.101.1 6.100.0 6.99.0 6.98.1 6.97.1 6.96.1 6.95.1 6.94.0 6.93.0 6.89.0 6.88.0 6.87.0 6.86.0 6.85.0 6.83.0 6.82.0 6.80.1 6.79.0 6.77.0 6.74.1 6.72.0 6.71.0 6.69.0 6.68.0 6.66.0 6.65.1 6.62.0 6.60.0 6.58.0 6.57.0 6.56.0 6.55.0 6.54.0 6.53.0 6.52.1 6.51.0 6.50.1 6.49.0 6.25.1 6.24.0 6.23.4 6.22.0 6.21.2 6.20.0 6.19.1 6.18.0 6.17.4 6.14.1

public static final class Transaction.Builder extends GeneratedMessage.Builder<Transaction.Builder> implements TransactionOrBuilder

A transaction.

Protobuf type google.spanner.v1.Transaction

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Transaction.Builder

Implements

TransactionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public Transaction build()

Returns
Type	Description
Transaction

buildPartial()

public Transaction buildPartial()

Returns
Type	Description
Transaction

clear()

public Transaction.Builder clear()

Returns
Type	Description
Transaction.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearCacheUpdate()

public Transaction.Builder clearCacheUpdate()

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];

Returns
Type	Description
Transaction.Builder

clearId()

public Transaction.Builder clearId()

id may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls.

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

bytes id = 1;

Returns
Type	Description
Transaction.Builder	This builder for chaining.

clearPrecommitToken()

public Transaction.Builder clearPrecommitToken()

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. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.

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

Returns
Type	Description
Transaction.Builder

clearReadTimestamp()

public Transaction.Builder clearReadTimestamp()

For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see 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;

Returns
Type	Description
Transaction.Builder

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];

Returns
Type	Description
CacheUpdate	The cacheUpdate.

getCacheUpdateBuilder()

public CacheUpdate.Builder getCacheUpdateBuilder()

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];

Returns
Type	Description
CacheUpdate.Builder

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];

Returns
Type	Description
CacheUpdateOrBuilder

getDefaultInstanceForType()

public Transaction getDefaultInstanceForType()

Returns
Type	Description
Transaction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getId()

public ByteString getId()

id may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls.

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

bytes id = 1;

Returns
Type	Description
ByteString	The id.

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. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.

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

Returns
Type	Description
MultiplexedSessionPrecommitToken	The precommitToken.

getPrecommitTokenBuilder()

public MultiplexedSessionPrecommitToken.Builder getPrecommitTokenBuilder()

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. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.

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

Returns
Type	Description
MultiplexedSessionPrecommitToken.Builder

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. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.

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

Returns
Type	Description
MultiplexedSessionPrecommitTokenOrBuilder

getReadTimestamp()

public Timestamp getReadTimestamp()

For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see 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;

Returns
Type	Description
Timestamp	The readTimestamp.

getReadTimestampBuilder()

public Timestamp.Builder getReadTimestampBuilder()

For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see 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;

Returns
Type	Description
Builder

getReadTimestampOrBuilder()

public TimestampOrBuilder getReadTimestampOrBuilder()

For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see 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;

Returns
Type	Description
TimestampOrBuilder

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];

Returns
Type	Description
boolean	Whether the cacheUpdate field is set.

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. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.

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

Returns
Type	Description
boolean	Whether the precommitToken field is set.

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.

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

.google.protobuf.Timestamp read_timestamp = 2;

Returns
Type	Description
boolean	Whether the readTimestamp field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeCacheUpdate(CacheUpdate value)

public Transaction.Builder mergeCacheUpdate(CacheUpdate value)

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];

Parameter
Name	Description
value	CacheUpdate

Returns
Type	Description
Transaction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Transaction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Transaction.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Transaction.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Transaction.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(Transaction other)

public Transaction.Builder mergeFrom(Transaction other)

Parameter
Name	Description
other	Transaction

Returns
Type	Description
Transaction.Builder

mergePrecommitToken(MultiplexedSessionPrecommitToken value)

public Transaction.Builder mergePrecommitToken(MultiplexedSessionPrecommitToken value)

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. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.

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

Parameter
Name	Description
value	MultiplexedSessionPrecommitToken

Returns
Type	Description
Transaction.Builder

mergeReadTimestamp(Timestamp value)

public Transaction.Builder mergeReadTimestamp(Timestamp value)

For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see 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;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Transaction.Builder

setCacheUpdate(CacheUpdate value)

public Transaction.Builder setCacheUpdate(CacheUpdate value)

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];

Parameter
Name	Description
value	CacheUpdate

Returns
Type	Description
Transaction.Builder

setCacheUpdate(CacheUpdate.Builder builderForValue)

public Transaction.Builder setCacheUpdate(CacheUpdate.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	CacheUpdate.Builder

Returns
Type	Description
Transaction.Builder

setId(ByteString value)

public Transaction.Builder setId(ByteString value)

id may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls.

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

bytes id = 1;

Parameter
Name	Description
value	ByteString The id to set.

Returns
Type	Description
Transaction.Builder	This builder for chaining.

setPrecommitToken(MultiplexedSessionPrecommitToken value)

public Transaction.Builder setPrecommitToken(MultiplexedSessionPrecommitToken value)

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. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.

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

Parameter
Name	Description
value	MultiplexedSessionPrecommitToken

Returns
Type	Description
Transaction.Builder

setPrecommitToken(MultiplexedSessionPrecommitToken.Builder builderForValue)

public Transaction.Builder setPrecommitToken(MultiplexedSessionPrecommitToken.Builder builderForValue)

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. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.

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

Parameter
Name	Description
builderForValue	MultiplexedSessionPrecommitToken.Builder

Returns
Type	Description
Transaction.Builder

setReadTimestamp(Timestamp value)

public Transaction.Builder setReadTimestamp(Timestamp value)

For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see 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;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Transaction.Builder

setReadTimestamp(Timestamp.Builder builderForValue)

public Transaction.Builder setReadTimestamp(Timestamp.Builder builderForValue)

For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see 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;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Transaction.Builder