Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::ReadOptions (v1.0.0)

Version 1.0.0

• 1.0.1 (latest)
• 1.0.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.3
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.5

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::ReadOptions.

The options shared by read requests.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#new_transaction

def new_transaction() -> ::Google::Cloud::Datastore::V1::TransactionOptions

Returns

• (::Google::Cloud::Datastore::V1::TransactionOptions) — Options for beginning a new transaction for this request.

  The new transaction identifier will be returned in the corresponding response as either LookupResponse.transaction or RunQueryResponse.transaction.

#new_transaction=

def new_transaction=(value) -> ::Google::Cloud::Datastore::V1::TransactionOptions

Parameter

• value (::Google::Cloud::Datastore::V1::TransactionOptions) — Options for beginning a new transaction for this request.

  The new transaction identifier will be returned in the corresponding response as either LookupResponse.transaction or RunQueryResponse.transaction.

Returns

• (::Google::Cloud::Datastore::V1::TransactionOptions) — Options for beginning a new transaction for this request.

  The new transaction identifier will be returned in the corresponding response as either LookupResponse.transaction or RunQueryResponse.transaction.

#read_consistency

def read_consistency() -> ::Google::Cloud::Datastore::V1::ReadOptions::ReadConsistency

Returns

• (::Google::Cloud::Datastore::V1::ReadOptions::ReadConsistency) — The non-transactional read consistency to use.

#read_consistency=

def read_consistency=(value) -> ::Google::Cloud::Datastore::V1::ReadOptions::ReadConsistency

Parameter

• value (::Google::Cloud::Datastore::V1::ReadOptions::ReadConsistency) — The non-transactional read consistency to use.

Returns

• (::Google::Cloud::Datastore::V1::ReadOptions::ReadConsistency) — The non-transactional read consistency to use.

#read_time

def read_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Reads entities as they were at the given time. This value is only supported for Cloud Firestore in Datastore mode.

  This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

#read_time=

def read_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — Reads entities as they were at the given time. This value is only supported for Cloud Firestore in Datastore mode.

  This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

Returns

• (::Google::Protobuf::Timestamp) — Reads entities as they were at the given time. This value is only supported for Cloud Firestore in Datastore mode.

  This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

#transaction

def transaction() -> ::String

Returns

• (::String) — The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.

#transaction=

def transaction=(value) -> ::String

Parameter

• value (::String) — The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.

Returns

• (::String) — The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.