Class TransactionOptions.Builder (3.1.0)

Version 3.1.0

• 3.20.0 (latest)
• 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 GeneratedMessageV3.Builder<TransactionOptions.Builder> implements TransactionOptionsOrBuilder

Options for creating a new transaction.

Protobuf type google.firestore.v1.TransactionOptions

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransactionOptions.Builder

Implements

TransactionOptionsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransactionOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
TransactionOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public TransactionOptions build()

Returns

Type	Description
TransactionOptions

buildPartial()

public TransactionOptions buildPartial()

Returns

Type	Description
TransactionOptions

clear()

public TransactionOptions.Builder clear()

Returns

Type	Description
TransactionOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public TransactionOptions.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
TransactionOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearMode()

public TransactionOptions.Builder clearMode()

Returns

Type	Description
TransactionOptions.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public TransactionOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
TransactionOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearReadOnly()

public TransactionOptions.Builder clearReadOnly()

The transaction can only be used for read operations.

.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;

Returns

Type	Description
TransactionOptions.Builder

clearReadWrite()

public TransactionOptions.Builder clearReadWrite()

The transaction can be used for both read and write operations.

.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;

Returns

Type	Description
TransactionOptions.Builder

clone()

public TransactionOptions.Builder clone()

Returns

Type	Description
TransactionOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public TransactionOptions getDefaultInstanceForType()

Returns

Type	Description
TransactionOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getModeCase()

public TransactionOptions.ModeCase getModeCase()

Returns

Type	Description
TransactionOptions.ModeCase

getReadOnly()

public TransactionOptions.ReadOnly getReadOnly()

The transaction can only be used for read operations.

.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;

Returns

Type	Description
TransactionOptions.ReadOnly	The readOnly.

getReadOnlyBuilder()

public TransactionOptions.ReadOnly.Builder getReadOnlyBuilder()

The transaction can only be used for read operations.

.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;

Returns

Type	Description
TransactionOptions.ReadOnly.Builder

getReadOnlyOrBuilder()

public TransactionOptions.ReadOnlyOrBuilder getReadOnlyOrBuilder()

The transaction can only be used for read operations.

.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;

Returns

Type	Description
TransactionOptions.ReadOnlyOrBuilder

getReadWrite()

public TransactionOptions.ReadWrite getReadWrite()

The transaction can be used for both read and write operations.

.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;

Returns

Type	Description
TransactionOptions.ReadWrite	The readWrite.

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;

Returns

Type	Description
TransactionOptions.ReadWrite.Builder

getReadWriteOrBuilder()

public TransactionOptions.ReadWriteOrBuilder getReadWriteOrBuilder()

The transaction can be used for both read and write operations.

.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;

Returns

Type	Description
TransactionOptions.ReadWriteOrBuilder

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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(TransactionOptions other)

public TransactionOptions.Builder mergeFrom(TransactionOptions other)

Parameter

Name	Description
other	TransactionOptions

Returns

Type	Description
TransactionOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
TransactionOptions.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public TransactionOptions.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
TransactionOptions.Builder

Overrides

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

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;

Parameter

Name	Description
value	TransactionOptions.ReadOnly

Returns

Type	Description
TransactionOptions.Builder

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;

Parameter

Name	Description
value	TransactionOptions.ReadWrite

Returns

Type	Description
TransactionOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransactionOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
TransactionOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public TransactionOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
TransactionOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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;

Parameter

Name	Description
value	TransactionOptions.ReadOnly

Returns

Type	Description
TransactionOptions.Builder

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;

Parameter

Name	Description
builderForValue	TransactionOptions.ReadOnly.Builder

Returns

Type	Description
TransactionOptions.Builder

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;

Parameter

Name	Description
value	TransactionOptions.ReadWrite

Returns

Type	Description
TransactionOptions.Builder

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;

Parameter

Name	Description
builderForValue	TransactionOptions.ReadWrite.Builder

Returns

Type	Description
TransactionOptions.Builder

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
TransactionOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final TransactionOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
TransactionOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)