TransactionOptions

Options for creating a new transaction.

JSON representation
{

  // Union field mode can be only one of the following:
  "readOnly": {
    object (ReadOnly)
  },
  "readWrite": {
    object (ReadWrite)
  }
  // End of list of possible types for union field mode.
}
Fields
Union field mode. The mode of the transaction. mode can be only one of the following:
readOnly

object (ReadOnly)

The transaction can only be used for read operations.

readWrite

object (ReadWrite)

The transaction can be used for both read and write operations.

ReadOnly

Options for a transaction that can only be used to read documents.

JSON representation
{

  // Union field consistency_selector can be only one of the following:
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
Fields
Union field consistency_selector. The consistency mode for this transaction. If not set, defaults to strong consistency. consistency_selector can be only one of the following:
readTime

string (Timestamp format)

Reads documents at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

ReadWrite

Options for a transaction that can be used to read and write documents.

Firestore does not allow 3rd party auth requests to create read-write. transactions.

JSON representation
{
  "retryTransaction": string
}
Fields
retryTransaction

string (bytes format)

An optional transaction to retry.

A base64-encoded string.