Cloud Datastore V1 Client - Class LookupResponse (1.25.0)

Reference documentation and code samples for the Cloud Datastore V1 Client class LookupResponse.

The response for Datastore.Lookup.

Generated from protobuf message google.datastore.v1.LookupResponse

Namespace

Google \ Cloud \ Datastore \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ found array<Google\Cloud\Datastore\V1\EntityResult>

Entities found as ResultType.FULL entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.

↳ missing array<Google\Cloud\Datastore\V1\EntityResult>

Entities not found as ResultType.KEY_ONLY entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.

↳ deferred array<Google\Cloud\Datastore\V1\Key>

A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input.

↳ transaction string

The identifier of the transaction that was started as part of this Lookup request. Set only when ReadOptions.new_transaction was set in LookupRequest.read_options.

↳ read_time Google\Protobuf\Timestamp

The time at which these entities were read or found missing.

getFound

Entities found as ResultType.FULL entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFound

Entities found as ResultType.FULL entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.

Parameter
NameDescription
var array<Google\Cloud\Datastore\V1\EntityResult>
Returns
TypeDescription
$this

getMissing

Entities not found as ResultType.KEY_ONLY entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMissing

Entities not found as ResultType.KEY_ONLY entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.

Parameter
NameDescription
var array<Google\Cloud\Datastore\V1\EntityResult>
Returns
TypeDescription
$this

getDeferred

A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDeferred

A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input.

Parameter
NameDescription
var array<Google\Cloud\Datastore\V1\Key>
Returns
TypeDescription
$this

getTransaction

The identifier of the transaction that was started as part of this Lookup request.

Set only when ReadOptions.new_transaction was set in LookupRequest.read_options.

Returns
TypeDescription
string

setTransaction

The identifier of the transaction that was started as part of this Lookup request.

Set only when ReadOptions.new_transaction was set in LookupRequest.read_options.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadTime

The time at which these entities were read or found missing.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasReadTime

clearReadTime

setReadTime

The time at which these entities were read or found missing.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this