public final class TransactionOptionsDescribes options for transactions, passed at transaction creation time.
Notes on usage:
The recommended way to instantiate a TransactionsOptions object is to statically import
Builder.* and invoke a static creation method followed by an instance mutator (if
needed):
import static com.google.appengine.api.datastore.TransactionOptions.Builder.*;
...
datastoreService.beginTransaction(withXG(true));
Methods
allowsMultipleEntityGroups() (deprecated)
public Boolean allowsMultipleEntityGroups()| Returns | |
|---|---|
| Type | Description |
Boolean |
|
clearMultipleEntityGroups() (deprecated)
public TransactionOptions clearMultipleEntityGroups()Deprecated. Use #clearXG() instead.
See #clearXG.
| Returns | |
|---|---|
| Type | Description |
TransactionOptions |
|
clearXG()
public TransactionOptions clearXG()Return the cross-group transaction setting to default (disabled).
| Returns | |
|---|---|
| Type | Description |
TransactionOptions |
|
equals(@Nullable Object o)
public boolean equals(@Nullable Object o)| Parameter | |
|---|---|
| Name | Description |
o |
@org.checkerframework.checker.nullness.qual.Nullable java.lang.Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
isXG()
public boolean isXG()| Returns | |
|---|---|
| Type | Description |
boolean |
|
multipleEntityGroups(boolean enable) (deprecated)
public TransactionOptions multipleEntityGroups(boolean enable)Deprecated. Use setXG(boolean) instead.
See #setXG.
| Parameter | |
|---|---|
| Name | Description |
enable |
boolean |
| Returns | |
|---|---|
| Type | Description |
TransactionOptions |
|
previousTransaction()
public @Nullable Transaction previousTransaction()Return the previous transaction that is being retried, or null if none was provided.
| Returns | |
|---|---|
| Type | Description |
@org.checkerframework.checker.nullness.qual.Nullable com.google.appengine.api.datastore.Transaction |
|
setPreviousTransaction(Transaction previousTransaction)
public TransactionOptions setPreviousTransaction(Transaction previousTransaction)Set which previous transaction to retry. Can only be used for READ_WRITE transactions. The
previous transaction should have been created with the same TransactionOptions, with
the exception of the previousTransaction property.
A rollback is not required, and should not be performed, prior to retrying the transaction.
| Parameter | |
|---|---|
| Name | Description |
previousTransaction |
Transactionthe transaction to retry. |
| Returns | |
|---|---|
| Type | Description |
TransactionOptions |
|
setTransactionMode(TransactionOptions.Mode mode)
public TransactionOptions setTransactionMode(TransactionOptions.Mode mode)Set the mode of the transaction.
Specifying the mode of the transaction can help to improve throughput, as it provides additional information about the intent (or lack of intent, in the case of read only transaction) to perform a write as part of the transaction.
| Parameter | |
|---|---|
| Name | Description |
mode |
TransactionOptions.Mode |
| Returns | |
|---|---|
| Type | Description |
TransactionOptions |
|
setXG(boolean enable)
public TransactionOptions setXG(boolean enable)Enable or disable the use of cross-group transactions.
| Parameter | |
|---|---|
| Name | Description |
enable |
booleantrue to cross-group transactions, false to restrict transactions to a single entity group. |
| Returns | |
|---|---|
| Type | Description |
TransactionOptions |
|
toString()
public String toString()| Returns | |
|---|---|
| Type | Description |
String |
|
transactionMode()
public @Nullable TransactionOptions.Mode transactionMode()Return the mode of the transaction, or null if none was specified.
| Returns | |
|---|---|
| Type | Description |
@org.checkerframework.checker.nullness.qual.Nullable com.google.appengine.api.datastore.TransactionOptions.Mode |
|