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

Inherits:

Object

• Object
• Google::Apis::DatastoreV1::ReadOptions

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

• #read_consistency ⇒ String

  The non-transactional read consistency to use.

• #transaction ⇒ String

  The identifier of the transaction in which to read.

Instance Method Summary

• #initialize(**args) ⇒ ReadOptions constructor

  A new instance of ReadOptions.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ ReadOptions

Returns a new instance of ReadOptions.

# File 'lib/google/apis/datastore_v1/classes.rb', line 1890

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

Instance Attribute Details

#read_consistency ⇒ String

The non-transactional read consistency to use. Cannot be set to STRONG for global queries. Corresponds to the JSON property readConsistency

Returns:

• (String)

# File 'lib/google/apis/datastore_v1/classes.rb', line 1881

def read_consistency
  @read_consistency
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)

# File 'lib/google/apis/datastore_v1/classes.rb', line 1888

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/datastore_v1/classes.rb', line 1895

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