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
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ found |
array<Google\Cloud\Datastore\V1\EntityResult>
Entities found as |
↳ missing |
array<Google\Cloud\Datastore\V1\EntityResult>
Entities not found as |
↳ 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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
var |
array<Google\Cloud\Datastore\V1\EntityResult>
|
Returns | |
---|---|
Type | Description |
$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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
var |
array<Google\Cloud\Datastore\V1\EntityResult>
|
Returns | |
---|---|
Type | Description |
$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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
var |
array<Google\Cloud\Datastore\V1\Key>
|
Returns | |
---|---|
Type | Description |
$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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getReadTime
The time at which these entities were read or found missing.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasReadTime
clearReadTime
setReadTime
The time at which these entities were read or found missing.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |