Class BeginTransactionRequest.Builder (6.83.0)

public static final class BeginTransactionRequest.Builder extends GeneratedMessageV3.Builder<BeginTransactionRequest.Builder> implements BeginTransactionRequestOrBuilder

The request for BeginTransaction.

Protobuf type google.spanner.v1.BeginTransactionRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BeginTransactionRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BeginTransactionRequest.Builder
Overrides

build()

public BeginTransactionRequest build()
Returns
Type Description
BeginTransactionRequest

buildPartial()

public BeginTransactionRequest buildPartial()
Returns
Type Description
BeginTransactionRequest

clear()

public BeginTransactionRequest.Builder clear()
Returns
Type Description
BeginTransactionRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public BeginTransactionRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BeginTransactionRequest.Builder
Overrides

clearMutationKey()

public BeginTransactionRequest.Builder clearMutationKey()

Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BeginTransactionRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public BeginTransactionRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BeginTransactionRequest.Builder
Overrides

clearOptions()

public BeginTransactionRequest.Builder clearOptions()

Required. Options for the new transaction.

.google.spanner.v1.TransactionOptions options = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BeginTransactionRequest.Builder

clearRequestOptions()

public BeginTransactionRequest.Builder clearRequestOptions()

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

.google.spanner.v1.RequestOptions request_options = 3;

Returns
Type Description
BeginTransactionRequest.Builder

clearSession()

public BeginTransactionRequest.Builder clearSession()

Required. The session in which the transaction runs.

string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
BeginTransactionRequest.Builder

This builder for chaining.

clone()

public BeginTransactionRequest.Builder clone()
Returns
Type Description
BeginTransactionRequest.Builder
Overrides

getDefaultInstanceForType()

public BeginTransactionRequest getDefaultInstanceForType()
Returns
Type Description
BeginTransactionRequest

getDescriptorForType()

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

getMutationKey()

public Mutation getMutationKey()

Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Mutation

The mutationKey.

getMutationKeyBuilder()

public Mutation.Builder getMutationKeyBuilder()

Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Mutation.Builder

getMutationKeyOrBuilder()

public MutationOrBuilder getMutationKeyOrBuilder()

Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MutationOrBuilder

getOptions()

public TransactionOptions getOptions()

Required. Options for the new transaction.

.google.spanner.v1.TransactionOptions options = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransactionOptions

The options.

getOptionsBuilder()

public TransactionOptions.Builder getOptionsBuilder()

Required. Options for the new transaction.

.google.spanner.v1.TransactionOptions options = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransactionOptions.Builder

getOptionsOrBuilder()

public TransactionOptionsOrBuilder getOptionsOrBuilder()

Required. Options for the new transaction.

.google.spanner.v1.TransactionOptions options = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransactionOptionsOrBuilder

getRequestOptions()

public RequestOptions getRequestOptions()

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

.google.spanner.v1.RequestOptions request_options = 3;

Returns
Type Description
RequestOptions

The requestOptions.

getRequestOptionsBuilder()

public RequestOptions.Builder getRequestOptionsBuilder()

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

.google.spanner.v1.RequestOptions request_options = 3;

Returns
Type Description
RequestOptions.Builder

getRequestOptionsOrBuilder()

public RequestOptionsOrBuilder getRequestOptionsOrBuilder()

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

.google.spanner.v1.RequestOptions request_options = 3;

Returns
Type Description
RequestOptionsOrBuilder

getSession()

public String getSession()

Required. The session in which the transaction runs.

string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The session.

getSessionBytes()

public ByteString getSessionBytes()

Required. The session in which the transaction runs.

string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for session.

hasMutationKey()

public boolean hasMutationKey()

Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the mutationKey field is set.

hasOptions()

public boolean hasOptions()

Required. Options for the new transaction.

.google.spanner.v1.TransactionOptions options = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the options field is set.

hasRequestOptions()

public boolean hasRequestOptions()

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

.google.spanner.v1.RequestOptions request_options = 3;

Returns
Type Description
boolean

Whether the requestOptions field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BeginTransactionRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BeginTransactionRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeFrom(BeginTransactionRequest other)

public BeginTransactionRequest.Builder mergeFrom(BeginTransactionRequest other)
Parameter
Name Description
other BeginTransactionRequest
Returns
Type Description
BeginTransactionRequest.Builder

mergeMutationKey(Mutation value)

public BeginTransactionRequest.Builder mergeMutationKey(Mutation value)

Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Mutation
Returns
Type Description
BeginTransactionRequest.Builder

mergeOptions(TransactionOptions value)

public BeginTransactionRequest.Builder mergeOptions(TransactionOptions value)

Required. Options for the new transaction.

.google.spanner.v1.TransactionOptions options = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value TransactionOptions
Returns
Type Description
BeginTransactionRequest.Builder

mergeRequestOptions(RequestOptions value)

public BeginTransactionRequest.Builder mergeRequestOptions(RequestOptions value)

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

.google.spanner.v1.RequestOptions request_options = 3;

Parameter
Name Description
value RequestOptions
Returns
Type Description
BeginTransactionRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BeginTransactionRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BeginTransactionRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public BeginTransactionRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BeginTransactionRequest.Builder
Overrides

setMutationKey(Mutation value)

public BeginTransactionRequest.Builder setMutationKey(Mutation value)

Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Mutation
Returns
Type Description
BeginTransactionRequest.Builder

setMutationKey(Mutation.Builder builderForValue)

public BeginTransactionRequest.Builder setMutationKey(Mutation.Builder builderForValue)

Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Mutation.Builder
Returns
Type Description
BeginTransactionRequest.Builder

setOptions(TransactionOptions value)

public BeginTransactionRequest.Builder setOptions(TransactionOptions value)

Required. Options for the new transaction.

.google.spanner.v1.TransactionOptions options = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value TransactionOptions
Returns
Type Description
BeginTransactionRequest.Builder

setOptions(TransactionOptions.Builder builderForValue)

public BeginTransactionRequest.Builder setOptions(TransactionOptions.Builder builderForValue)

Required. Options for the new transaction.

.google.spanner.v1.TransactionOptions options = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue TransactionOptions.Builder
Returns
Type Description
BeginTransactionRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BeginTransactionRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BeginTransactionRequest.Builder
Overrides

setRequestOptions(RequestOptions value)

public BeginTransactionRequest.Builder setRequestOptions(RequestOptions value)

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

.google.spanner.v1.RequestOptions request_options = 3;

Parameter
Name Description
value RequestOptions
Returns
Type Description
BeginTransactionRequest.Builder

setRequestOptions(RequestOptions.Builder builderForValue)

public BeginTransactionRequest.Builder setRequestOptions(RequestOptions.Builder builderForValue)

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

.google.spanner.v1.RequestOptions request_options = 3;

Parameter
Name Description
builderForValue RequestOptions.Builder
Returns
Type Description
BeginTransactionRequest.Builder

setSession(String value)

public BeginTransactionRequest.Builder setSession(String value)

Required. The session in which the transaction runs.

string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The session to set.

Returns
Type Description
BeginTransactionRequest.Builder

This builder for chaining.

setSessionBytes(ByteString value)

public BeginTransactionRequest.Builder setSessionBytes(ByteString value)

Required. The session in which the transaction runs.

string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for session to set.

Returns
Type Description
BeginTransactionRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BeginTransactionRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BeginTransactionRequest.Builder
Overrides