Class: Google::Apis::DatastoreV1::ReadOptions

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

Overview

The options shared by read requests.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ReadOptions

Returns a new instance of ReadOptions.



2168
2169
2170
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2168

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

Instance Attribute Details

#new_transaction ⇒ Google::Apis::DatastoreV1::TransactionOptions

Options for beginning a new transaction. Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests. Corresponds to the JSON property newTransaction

Returns:



2148
2149
2150
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2148

def new_transaction
  @new_transaction
end

#read_consistency ⇒ String

The non-transactional read consistency to use. Corresponds to the JSON property readConsistency

Returns:

  • (String) 


2153
2154
2155
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2153

def read_consistency
  @read_consistency
end

#read_time ⇒ String

Reads entities as they were at the given time. This may not be older than 270 seconds. This value is only supported for Cloud Firestore in Datastore mode. Corresponds to the JSON property readTime

Returns:

  • (String) 


2159
2160
2161
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2159

def read_time
  @read_time
end

#transaction ⇒ String

The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction. Corresponds to the JSON property transaction NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


2166
2167
2168
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2166

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2173
2174
2175
2176
2177
2178
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2173

def update!(**args)
  @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
  @read_consistency = args[:read_consistency] if args.key?(:read_consistency)
  @read_time = args[:read_time] if args.key?(:read_time)
  @transaction = args[:transaction] if args.key?(:transaction)
end