Class: Google::Cloud::Datastore::V1::LookupRequest

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

Overview

The request for Datastore.Lookup.

Instance Attribute Summary collapse

Instance Attribute Details

#database_id ⇒ ::String

Returns The ID of the database against which to make the request.

'(default)' is not allowed; please use empty string '' to refer the default database.

Returns:

  • (::String) —

    The ID of the database against which to make the request.

    '(default)' is not allowed; please use empty string '' to refer the default database.



48
49
50
51
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 48

class LookupRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#keys ⇒ ::Array<::Google::Cloud::Datastore::V1::Key>

Returns Required. Keys of entities to look up.

Returns:



48
49
50
51
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 48

class LookupRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#project_id ⇒ ::String

Returns Required. The ID of the project against which to make the request.

Returns:

  • (::String) —

    Required. The ID of the project against which to make the request.



48
49
50
51
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 48

class LookupRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#property_mask ⇒ ::Google::Cloud::Datastore::V1::PropertyMask

Returns The properties to return. Defaults to returning all properties.

If this field is set and an entity has a property not referenced in the mask, it will be absent from [LookupResponse.found.entity.properties][].

The entity's key is always returned.

Returns:

  • (::Google::Cloud::Datastore::V1::PropertyMask) —

    The properties to return. Defaults to returning all properties.

    If this field is set and an entity has a property not referenced in the mask, it will be absent from [LookupResponse.found.entity.properties][].

    The entity's key is always returned.



48
49
50
51
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 48

class LookupRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_options ⇒ ::Google::Cloud::Datastore::V1::ReadOptions

Returns The options for this lookup request.

Returns:



48
49
50
51
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 48

class LookupRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end