Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::LookupRequest (v1.4.1)

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

The request for Datastore.Lookup.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#database_id

def database_id() -> ::String
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.

#database_id=

def database_id=(value) -> ::String
Parameter
  • value (::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.

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.

#keys

def keys() -> ::Array<::Google::Cloud::Datastore::V1::Key>
Returns

#keys=

def keys=(value) -> ::Array<::Google::Cloud::Datastore::V1::Key>
Parameter
Returns

#project_id

def project_id() -> ::String
Returns
  • (::String) — Required. The ID of the project against which to make the request.

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::String) — 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.

#property_mask

def property_mask() -> ::Google::Cloud::Datastore::V1::PropertyMask
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.

#property_mask=

def property_mask=(value) -> ::Google::Cloud::Datastore::V1::PropertyMask
Parameter
  • value (::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.

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.

#read_options

def read_options() -> ::Google::Cloud::Datastore::V1::ReadOptions
Returns

#read_options=

def read_options=(value) -> ::Google::Cloud::Datastore::V1::ReadOptions
Parameter
Returns