public static final class TransactionOptions.ReadWrite.Builder extends GeneratedMessage.Builder<TransactionOptions.ReadWrite.Builder> implements TransactionOptions.ReadWriteOrBuilderOptions for a transaction that can be used to read and write documents.
Protobuf type google.firestore.v1.TransactionOptions.ReadWrite
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > TransactionOptions.ReadWrite.BuilderImplements
TransactionOptions.ReadWriteOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public TransactionOptions.ReadWrite build()| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ReadWrite |
|
buildPartial()
public TransactionOptions.ReadWrite buildPartial()| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ReadWrite |
|
clear()
public TransactionOptions.ReadWrite.Builder clear()| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ReadWrite.Builder |
|
clearConcurrencyMode()
public TransactionOptions.ReadWrite.Builder clearConcurrencyMode()Optional. The concurrency control mode to use for this transaction.
A database is able to use different concurrency modes for different transactions simultaneously.
3rd party auth requests are only allowed to create optimistic read-write transactions and must specify that here even if the database-level setting is already configured to optimistic.
.google.firestore.v1.TransactionOptions.ConcurrencyMode concurrency_mode = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ReadWrite.Builder |
This builder for chaining. |
clearRetryTransaction()
public TransactionOptions.ReadWrite.Builder clearRetryTransaction()An optional transaction to retry.
bytes retry_transaction = 1;
| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ReadWrite.Builder |
This builder for chaining. |
getConcurrencyMode()
public TransactionOptions.ConcurrencyMode getConcurrencyMode()Optional. The concurrency control mode to use for this transaction.
A database is able to use different concurrency modes for different transactions simultaneously.
3rd party auth requests are only allowed to create optimistic read-write transactions and must specify that here even if the database-level setting is already configured to optimistic.
.google.firestore.v1.TransactionOptions.ConcurrencyMode concurrency_mode = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ConcurrencyMode |
The concurrencyMode. |
getConcurrencyModeValue()
public int getConcurrencyModeValue()Optional. The concurrency control mode to use for this transaction.
A database is able to use different concurrency modes for different transactions simultaneously.
3rd party auth requests are only allowed to create optimistic read-write transactions and must specify that here even if the database-level setting is already configured to optimistic.
.google.firestore.v1.TransactionOptions.ConcurrencyMode concurrency_mode = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for concurrencyMode. |
getDefaultInstanceForType()
public TransactionOptions.ReadWrite getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ReadWrite |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getRetryTransaction()
public ByteString getRetryTransaction()An optional transaction to retry.
bytes retry_transaction = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The retryTransaction. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(TransactionOptions.ReadWrite other)
public TransactionOptions.ReadWrite.Builder mergeFrom(TransactionOptions.ReadWrite other)| Parameter | |
|---|---|
| Name | Description |
other |
TransactionOptions.ReadWrite |
| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ReadWrite.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TransactionOptions.ReadWrite.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ReadWrite.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public TransactionOptions.ReadWrite.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ReadWrite.Builder |
|
setConcurrencyMode(TransactionOptions.ConcurrencyMode value)
public TransactionOptions.ReadWrite.Builder setConcurrencyMode(TransactionOptions.ConcurrencyMode value)Optional. The concurrency control mode to use for this transaction.
A database is able to use different concurrency modes for different transactions simultaneously.
3rd party auth requests are only allowed to create optimistic read-write transactions and must specify that here even if the database-level setting is already configured to optimistic.
.google.firestore.v1.TransactionOptions.ConcurrencyMode concurrency_mode = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
TransactionOptions.ConcurrencyModeThe concurrencyMode to set. |
| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ReadWrite.Builder |
This builder for chaining. |
setConcurrencyModeValue(int value)
public TransactionOptions.ReadWrite.Builder setConcurrencyModeValue(int value)Optional. The concurrency control mode to use for this transaction.
A database is able to use different concurrency modes for different transactions simultaneously.
3rd party auth requests are only allowed to create optimistic read-write transactions and must specify that here even if the database-level setting is already configured to optimistic.
.google.firestore.v1.TransactionOptions.ConcurrencyMode concurrency_mode = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for concurrencyMode to set. |
| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ReadWrite.Builder |
This builder for chaining. |
setRetryTransaction(ByteString value)
public TransactionOptions.ReadWrite.Builder setRetryTransaction(ByteString value)An optional transaction to retry.
bytes retry_transaction = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe retryTransaction to set. |
| Returns | |
|---|---|
| Type | Description |
TransactionOptions.ReadWrite.Builder |
This builder for chaining. |