Class: Google::Datastore::V1::ReadOptions

Inherits:

Object

Object
Google::Datastore::V1::ReadOptions

show all

Defined in:: lib/google/cloud/datastore/v1/doc/google/datastore/v1/datastore.rb

Overview

The options shared by read requests.

Defined Under Namespace

Modules: ReadConsistency

Instance Attribute Summary collapse

#read_consistency ⇒ Google::Datastore::V1::ReadOptions::ReadConsistency
The non-transactional read consistency to use.
#transaction ⇒ String
The identifier of the transaction in which to read.

Instance Attribute Details

#read_consistency ⇒ `Google::Datastore::V1::ReadOptions::ReadConsistency`

Returns The non-transactional read consistency to use. Cannot be set to +STRONG+ for global queries.

Returns:

(Google::Datastore::V1::ReadOptions::ReadConsistency) —
The non-transactional read consistency to use. Cannot be set to +STRONG+ for global queries.

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/datastore.rb', line 225

class ReadOptions
  # The possible values for read consistencies.
  module ReadConsistency
    # Unspecified. This value must not be used.
    READ_CONSISTENCY_UNSPECIFIED = 0

    # Strong consistency.
    STRONG = 1

    # Eventual consistency.
    EVENTUAL = 2
  end
end

#transaction ⇒ `String`

Returns The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore::BeginTransaction.