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

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

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.

Note: The following fields are mutually exclusive: new_transaction, read_consistency, transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

Note: The following fields are mutually exclusive: new_transaction, read_consistency, transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

Note: The following fields are mutually exclusive: new_transaction, read_consistency, transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

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

Returns

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

Note: The following fields are mutually exclusive: read_consistency, transaction, new_transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

Note: The following fields are mutually exclusive: read_consistency, transaction, new_transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

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

Note: The following fields are mutually exclusive: read_consistency, transaction, new_transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

Note: The following fields are mutually exclusive: read_time, read_consistency, transaction, new_transaction. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

Note: The following fields are mutually exclusive: read_time, read_consistency, transaction, new_transaction. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

Note: The following fields are mutually exclusive: read_time, read_consistency, transaction, new_transaction. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

Note: The following fields are mutually exclusive: transaction, read_consistency, new_transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

Note: The following fields are mutually exclusive: transaction, read_consistency, new_transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

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

Note: The following fields are mutually exclusive: transaction, read_consistency, new_transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.