Class BeginTransactionRequest.Builder (3.3.0)

Version 3.3.0

• 3.28.0 (latest)
• 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 BeginTransactionRequest.Builder extends GeneratedMessageV3.Builder<BeginTransactionRequest.Builder> implements BeginTransactionRequestOrBuilder

The request for Firestore.BeginTransaction.

Protobuf type google.firestore.v1.BeginTransactionRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.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)

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 BeginTransactionRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
BeginTransactionRequest.Builder

Overrides

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

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDatabase()

public BeginTransactionRequest.Builder clearDatabase()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
BeginTransactionRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BeginTransactionRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
BeginTransactionRequest.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public BeginTransactionRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
BeginTransactionRequest.Builder

Overrides

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

clearOptions()

public BeginTransactionRequest.Builder clearOptions()

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Returns

Type	Description
BeginTransactionRequest.Builder

clone()

public BeginTransactionRequest.Builder clone()

Returns

Type	Description
BeginTransactionRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDatabase()

public String getDatabase()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for database.

getDefaultInstanceForType()

public BeginTransactionRequest getDefaultInstanceForType()

Returns

Type	Description
BeginTransactionRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getOptions()

public TransactionOptions getOptions()

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Returns

Type	Description
TransactionOptions	The options.

getOptionsBuilder()

public TransactionOptions.Builder getOptionsBuilder()

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Returns

Type	Description
TransactionOptions.Builder

getOptionsOrBuilder()

public TransactionOptionsOrBuilder getOptionsOrBuilder()

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Returns

Type	Description
TransactionOptionsOrBuilder

hasOptions()

public boolean hasOptions()

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Returns

Type	Description
boolean	Whether the options 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(BeginTransactionRequest other)

public BeginTransactionRequest.Builder mergeFrom(BeginTransactionRequest other)

Parameter

Name	Description
other	BeginTransactionRequest

Returns

Type	Description
BeginTransactionRequest.Builder

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)

mergeOptions(TransactionOptions value)

public BeginTransactionRequest.Builder mergeOptions(TransactionOptions value)

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Parameter

Name	Description
value	TransactionOptions

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

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

setDatabase(String value)

public BeginTransactionRequest.Builder setDatabase(String value)

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	String The database to set.

Returns

Type	Description
BeginTransactionRequest.Builder	This builder for chaining.

setDatabaseBytes(ByteString value)

public BeginTransactionRequest.Builder setDatabaseBytes(ByteString value)

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	ByteString The bytes for database to set.

Returns

Type	Description
BeginTransactionRequest.Builder	This builder for chaining.

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

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

setOptions(TransactionOptions value)

public BeginTransactionRequest.Builder setOptions(TransactionOptions value)

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Parameter

Name	Description
value	TransactionOptions

Returns

Type	Description
BeginTransactionRequest.Builder

setOptions(TransactionOptions.Builder builderForValue)

public BeginTransactionRequest.Builder setOptions(TransactionOptions.Builder builderForValue)

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final BeginTransactionRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
BeginTransactionRequest.Builder

Overrides

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