Class BeginTransactionRequest.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 BeginTransactionRequest.Builder extends GeneratedMessage.Builder<BeginTransactionRequest.Builder> implements BeginTransactionRequestOrBuilder

The request for BeginTransaction.

Protobuf type google.spanner.v1.BeginTransactionRequest

Inheritance

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

Implements

BeginTransactionRequestOrBuilder

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

GeneratedMessage.Builder<BuilderType>.clear()

clearMutationKey()

public BeginTransactionRequest.Builder clearMutationKey()

Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

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

Returns
Type	Description
BeginTransactionRequest.Builder

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 doesn't 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

clearRoutingHint()

public BeginTransactionRequest.Builder clearRoutingHint()

Optional. Makes the Spanner requests location-aware if present.

It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

.google.spanner.v1.RoutingHint routing_hint = 5 [(.google.api.field_behavior) = OPTIONAL];

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.

getDefaultInstanceForType()

public BeginTransactionRequest getDefaultInstanceForType()

Returns
Type	Description
BeginTransactionRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getMutationKey()

public Mutation getMutationKey()

Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

.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 don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

.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 don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

.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 doesn't 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 doesn't 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 doesn't 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

getRoutingHint()

public RoutingHint getRoutingHint()

Optional. Makes the Spanner requests location-aware if present.

It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

.google.spanner.v1.RoutingHint routing_hint = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RoutingHint	The routingHint.

getRoutingHintBuilder()

public RoutingHint.Builder getRoutingHintBuilder()

Optional. Makes the Spanner requests location-aware if present.

It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

.google.spanner.v1.RoutingHint routing_hint = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RoutingHint.Builder

getRoutingHintOrBuilder()

public RoutingHintOrBuilder getRoutingHintOrBuilder()

Optional. Makes the Spanner requests location-aware if present.

It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

.google.spanner.v1.RoutingHint routing_hint = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RoutingHintOrBuilder

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 don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

.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 doesn't 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.

hasRoutingHint()

public boolean hasRoutingHint()

Optional. Makes the Spanner requests location-aware if present.

It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

.google.spanner.v1.RoutingHint routing_hint = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the routingHint 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()

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

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BeginTransactionRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BeginTransactionRequest.Builder

Overrides

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

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 don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

.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 doesn't 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

mergeRoutingHint(RoutingHint value)

public BeginTransactionRequest.Builder mergeRoutingHint(RoutingHint value)

Optional. Makes the Spanner requests location-aware if present.

It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

.google.spanner.v1.RoutingHint routing_hint = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	RoutingHint

Returns
Type	Description
BeginTransactionRequest.Builder

setMutationKey(Mutation value)

public BeginTransactionRequest.Builder setMutationKey(Mutation value)

Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

.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 don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

.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

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 doesn't 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 doesn't 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

setRoutingHint(RoutingHint value)

public BeginTransactionRequest.Builder setRoutingHint(RoutingHint value)

Optional. Makes the Spanner requests location-aware if present.

It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

.google.spanner.v1.RoutingHint routing_hint = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	RoutingHint

Returns
Type	Description
BeginTransactionRequest.Builder

setRoutingHint(RoutingHint.Builder builderForValue)

public BeginTransactionRequest.Builder setRoutingHint(RoutingHint.Builder builderForValue)

Optional. Makes the Spanner requests location-aware if present.

It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

.google.spanner.v1.RoutingHint routing_hint = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	RoutingHint.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.