Class BeginTransactionRequest.Builder (3.5.0)

Stay organized with collections Save and categorize content based on your preferences.
public static final class BeginTransactionRequest.Builder extends GeneratedMessageV3.Builder<BeginTransactionRequest.Builder> implements BeginTransactionRequestOrBuilder

The request for Firestore.BeginTransaction.

Protobuf type google.firestore.v1.BeginTransactionRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BeginTransactionRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BeginTransactionRequest.Builder
Overrides

build()

public BeginTransactionRequest build()
Returns
TypeDescription
BeginTransactionRequest

buildPartial()

public BeginTransactionRequest buildPartial()
Returns
TypeDescription
BeginTransactionRequest

clear()

public BeginTransactionRequest.Builder clear()
Returns
TypeDescription
BeginTransactionRequest.Builder
Overrides

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
TypeDescription
BeginTransactionRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BeginTransactionRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
BeginTransactionRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public BeginTransactionRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
BeginTransactionRequest.Builder
Overrides

clearOptions()

public BeginTransactionRequest.Builder clearOptions()

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

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

Returns
TypeDescription
BeginTransactionRequest.Builder

clone()

public BeginTransactionRequest.Builder clone()
Returns
TypeDescription
BeginTransactionRequest.Builder
Overrides

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

The bytes for database.

getDefaultInstanceForType()

public BeginTransactionRequest getDefaultInstanceForType()
Returns
TypeDescription
BeginTransactionRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getOptions()

public TransactionOptions getOptions()

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

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

Returns
TypeDescription
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
TypeDescription
TransactionOptions.Builder

getOptionsOrBuilder()

public TransactionOptionsOrBuilder getOptionsOrBuilder()

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

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

Returns
TypeDescription
TransactionOptionsOrBuilder

hasOptions()

public boolean hasOptions()

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

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

Returns
TypeDescription
boolean

Whether the options field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(BeginTransactionRequest other)

public BeginTransactionRequest.Builder mergeFrom(BeginTransactionRequest other)
Parameter
NameDescription
otherBeginTransactionRequest
Returns
TypeDescription
BeginTransactionRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BeginTransactionRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BeginTransactionRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public BeginTransactionRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
BeginTransactionRequest.Builder
Overrides

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
NameDescription
valueTransactionOptions
Returns
TypeDescription
BeginTransactionRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BeginTransactionRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BeginTransactionRequest.Builder
Overrides

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

The database to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for database to set.

Returns
TypeDescription
BeginTransactionRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BeginTransactionRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BeginTransactionRequest.Builder
Overrides

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
NameDescription
valueTransactionOptions
Returns
TypeDescription
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
NameDescription
builderForValueTransactionOptions.Builder
Returns
TypeDescription
BeginTransactionRequest.Builder

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

public BeginTransactionRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
BeginTransactionRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final BeginTransactionRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BeginTransactionRequest.Builder
Overrides