Class BeginTransactionRequest.Builder (3.2.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
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public BeginTransactionRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public BeginTransactionRequest build()
Returns
buildPartial()
public BeginTransactionRequest buildPartial()
Returns
clear()
public BeginTransactionRequest.Builder clear()
Returns
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
clearField(Descriptors.FieldDescriptor field)
public BeginTransactionRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public BeginTransactionRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearOptions()
public BeginTransactionRequest.Builder clearOptions()
The options for the transaction.
Defaults to a read-write transaction.
.google.firestore.v1.TransactionOptions options = 2;
Returns
clone()
public BeginTransactionRequest.Builder clone()
Returns
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
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
getDefaultInstanceForType()
public BeginTransactionRequest getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getOptions()
public TransactionOptions getOptions()
The options for the transaction.
Defaults to a read-write transaction.
.google.firestore.v1.TransactionOptions options = 2;
Returns
getOptionsBuilder()
public TransactionOptions.Builder getOptionsBuilder()
The options for the transaction.
Defaults to a read-write transaction.
.google.firestore.v1.TransactionOptions options = 2;
Returns
getOptionsOrBuilder()
public TransactionOptionsOrBuilder getOptionsOrBuilder()
The options for the transaction.
Defaults to a read-write transaction.
.google.firestore.v1.TransactionOptions options = 2;
Returns
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
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(BeginTransactionRequest other)
public BeginTransactionRequest.Builder mergeFrom(BeginTransactionRequest other)
Parameter
Returns
public BeginTransactionRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public BeginTransactionRequest.Builder mergeFrom(Message other)
Parameter
Returns
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
Returns
mergeUnknownFields(UnknownFieldSet unknownFields)
public final BeginTransactionRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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
Name | Description |
value | String
The database to set.
|
Returns
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
setField(Descriptors.FieldDescriptor field, Object value)
public BeginTransactionRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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
Returns
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
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public BeginTransactionRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final BeginTransactionRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
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 2024-09-20 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-09-20 UTC."}
[[["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 2024-09-20 UTC."]]