Reference documentation and code samples for the Cloud Datastore V1 Client class LookupRequest.
The request for Datastore.Lookup.
Generated from protobuf message google.datastore.v1.LookupRequest
Namespace
Google \ Cloud \ Datastore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ project_id |
string
Required. The ID of the project against which to make the request. |
↳ database_id |
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. |
↳ read_options |
Google\Cloud\Datastore\V1\ReadOptions
The options for this lookup request. |
↳ keys |
array<Google\Cloud\Datastore\V1\Key>
Required. Keys of entities to look up. |
↳ property_mask |
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. |
getProjectId
Required. The ID of the project against which to make the request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProjectId
Required. The ID of the project against which to make the request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseId
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 | |
|---|---|
| Type | Description |
string |
|
setDatabaseId
The ID of the database against which to make the request.
'(default)' is not allowed; please use empty string '' to refer the default database.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReadOptions
The options for this lookup request.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\ReadOptions|null |
|
hasReadOptions
clearReadOptions
setReadOptions
The options for this lookup request.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\V1\ReadOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKeys
Required. Keys of entities to look up.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setKeys
Required. Keys of entities to look up.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Datastore\V1\Key>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPropertyMask
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 | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\PropertyMask|null |
|
hasPropertyMask
clearPropertyMask
setPropertyMask
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\V1\PropertyMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
projectId |
string
Required. The ID of the project against which to make the request. |
readOptions |
Google\Cloud\Datastore\V1\ReadOptions
The options for this lookup request. |
keys |
array<Google\Cloud\Datastore\V1\Key>
Required. Keys of entities to look up. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\LookupRequest |
|