Class: Google::Apis::FirestoreV1::TransactionOptions

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

Options for creating a new transaction.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TransactionOptions

Returns a new instance of TransactionOptions.



3941
3942
3943
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3941

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#read_only ⇒ Google::Apis::FirestoreV1::ReadOnly

Options for a transaction that can only be used to read documents. Corresponds to the JSON property readOnly

Returns:



3932
3933
3934
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3932

def read_only
  @read_only
end

#read_write ⇒ Google::Apis::FirestoreV1::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. Corresponds to the JSON property readWrite

Returns:



3939
3940
3941
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3939

def read_write
  @read_write
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3946
3947
3948
3949
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3946

def update!(**args)
  @read_only = args[:read_only] if args.key?(:read_only)
  @read_write = args[:read_write] if args.key?(:read_write)
end