Send feedback
Class TransactionOptions.Builder (3.38.0)
Stay organized with collections
Save and categorize content based on your preferences.
3.38.0 (latest)
3.37.0
3.36.0
3.35.1
3.33.4
3.32.2
3.31.9
3.30.11
3.28.0
3.27.2
3.26.5
3.25.1
3.24.3
3.22.0
3.21.4
3.20.0
3.17.0
3.16.3
3.15.7
3.14.4
3.13.2
3.12.1
3.11.0
3.10.0
3.9.6
3.8.2
3.7.10
3.6.0
3.5.0
3.4.2
3.3.0
3.2.0
3.1.0
3.0.21
public static final class TransactionOptions . Builder extends GeneratedMessage . Builder<TransactionOptions . Builder > implements TransactionOptionsOrBuilder
Options for creating a new transaction.
Protobuf type google.firestore.v1.TransactionOptions
Inherited Members
com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
build()
public TransactionOptions build ()
buildPartial()
public TransactionOptions buildPartial ()
clear()
public TransactionOptions . Builder clear ()
Overrides
clearMode()
public TransactionOptions . Builder clearMode ()
clearReadOnly()
public TransactionOptions . Builder clearReadOnly ()
The transaction can only be used for read operations.
.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;
clearReadWrite()
public TransactionOptions . Builder clearReadWrite ()
The transaction can be used for both read and write operations.
.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;
getDefaultInstanceForType()
public TransactionOptions getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
getModeCase()
public TransactionOptions . ModeCase getModeCase ()
getReadOnly()
public TransactionOptions . ReadOnly getReadOnly ()
The transaction can only be used for read operations.
.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;
getReadOnlyBuilder()
public TransactionOptions . ReadOnly . Builder getReadOnlyBuilder ()
The transaction can only be used for read operations.
.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;
getReadOnlyOrBuilder()
public TransactionOptions . ReadOnlyOrBuilder getReadOnlyOrBuilder ()
The transaction can only be used for read operations.
.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;
getReadWrite()
public TransactionOptions . ReadWrite getReadWrite ()
The transaction can be used for both read and write operations.
.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;
getReadWriteBuilder()
public TransactionOptions . ReadWrite . Builder getReadWriteBuilder ()
The transaction can be used for both read and write operations.
.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;
getReadWriteOrBuilder()
public TransactionOptions . ReadWriteOrBuilder getReadWriteOrBuilder ()
The transaction can be used for both read and write operations.
.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;
hasReadOnly()
public boolean hasReadOnly ()
The transaction can only be used for read operations.
.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;
Returns
Type
Description
boolean
Whether the readOnly field is set.
hasReadWrite()
public boolean hasReadWrite ()
The transaction can be used for both read and write operations.
.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;
Returns
Type
Description
boolean
Whether the readWrite field is set.
internalGetFieldAccessorTable()
protected GeneratedMessage . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(TransactionOptions other)
public TransactionOptions . Builder mergeFrom ( TransactionOptions other )
public TransactionOptions . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public TransactionOptions . Builder mergeFrom ( Message other )
Parameter
Name
Description
other
Message
Overrides
mergeReadOnly(TransactionOptions.ReadOnly value)
public TransactionOptions . Builder mergeReadOnly ( TransactionOptions . ReadOnly value )
The transaction can only be used for read operations.
.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;
mergeReadWrite(TransactionOptions.ReadWrite value)
public TransactionOptions . Builder mergeReadWrite ( TransactionOptions . ReadWrite value )
The transaction can be used for both read and write operations.
.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;
setReadOnly(TransactionOptions.ReadOnly value)
public TransactionOptions . Builder setReadOnly ( TransactionOptions . ReadOnly value )
The transaction can only be used for read operations.
.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;
setReadOnly(TransactionOptions.ReadOnly.Builder builderForValue)
public TransactionOptions . Builder setReadOnly ( TransactionOptions . ReadOnly . Builder builderForValue )
The transaction can only be used for read operations.
.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;
setReadWrite(TransactionOptions.ReadWrite value)
public TransactionOptions . Builder setReadWrite ( TransactionOptions . ReadWrite value )
The transaction can be used for both read and write operations.
.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;
setReadWrite(TransactionOptions.ReadWrite.Builder builderForValue)
public TransactionOptions . Builder setReadWrite ( TransactionOptions . ReadWrite . Builder builderForValue )
The transaction can be used for both read and write operations.
.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]