Class Transaction.Builder (6.108.0)

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

A transaction.

Protobuf type google.spanner.v1.Transaction

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

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

getDefaultInstanceForType()

public Transaction getDefaultInstanceForType()
Returns
Type Description
Transaction

getDescriptorForType()

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

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

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

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