public static final class BeginTransactionRequest.Builder extends GeneratedMessage.Builder<BeginTransactionRequest.Builder> implements BeginTransactionRequestOrBuilderThe request for Firestore.BeginTransaction.
Protobuf type google.firestore.v1.BeginTransactionRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > BeginTransactionRequest.BuilderImplements
BeginTransactionRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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 |
|
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. |
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 |
|
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 |
|
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public BeginTransactionRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest.Builder |
|
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 |
|
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 |
StringThe 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 |
ByteStringThe bytes for database to set. |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest.Builder |
This builder for chaining. |
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 |
|