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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/datastore/v1/datastore.rb

Overview

The options shared by read requests.

Defined Under Namespace

Modules: ReadConsistency

Instance Attribute Summary collapse

Instance Attribute Details

#new_transaction ⇒ ::Google::Cloud::Datastore::V1::TransactionOptions

Returns 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:



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 460

class ReadOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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

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

Returns The non-transactional read consistency to use.

Returns:



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 460

class ReadOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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

#read_time ⇒ ::Google::Protobuf::Timestamp

Returns 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.



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 460

class ReadOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.

Returns:

  • (::String) —

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



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 460

class ReadOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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