Class: Google::Firestore::V1::TransactionOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/v1/doc/google/firestore/v1/common.rb

Overview

Options for creating a new transaction.

Defined Under Namespace

Classes: ReadOnly, ReadWrite

Instance Attribute Summary collapse

Instance Attribute Details

#read_only ⇒ Google::Firestore::V1::TransactionOptions::ReadOnly

Returns The transaction can only be used for read operations.

Returns:



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/common.rb', line 48

class TransactionOptions
  # Options for a transaction that can be used to read and write documents.
  # @!attribute [rw] retry_transaction
  #   @return [String]
  #     An optional transaction to retry.
  class ReadWrite; end

  # Options for a transaction that can only be used to read documents.
  # @!attribute [rw] read_time
  #   @return [Google::Protobuf::Timestamp]
  #     Reads documents at the given time.
  #     This may not be older than 60 seconds.
  class ReadOnly; end
end

#read_write ⇒ Google::Firestore::V1::TransactionOptions::ReadWrite

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

Returns:



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/common.rb', line 48

class TransactionOptions
  # Options for a transaction that can be used to read and write documents.
  # @!attribute [rw] retry_transaction
  #   @return [String]
  #     An optional transaction to retry.
  class ReadWrite; end

  # Options for a transaction that can only be used to read documents.
  # @!attribute [rw] read_time
  #   @return [Google::Protobuf::Timestamp]
  #     Reads documents at the given time.
  #     This may not be older than 60 seconds.
  class ReadOnly; end
end