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.



1985
1986
1987
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1985

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

Instance Attribute Details

#read_consistency ⇒ String

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

Returns:

  • (String) 


1970
1971
1972
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1970

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) 


1976
1977
1978
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1976

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) 


1983
1984
1985
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1983

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1990
1991
1992
1993
1994
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1990

def update!(**args)
  @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