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
Methods
__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. |
getProjectId
Required. The ID of the project against which to make the request.
Generated from protobuf field string project_id = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setProjectId
Required. The ID of the project against which to make the request.
Generated from protobuf field string project_id = 8 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field string database_id = 9;
| 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.
Generated from protobuf field string database_id = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadOptions
The options for this lookup request.
Generated from protobuf field .google.datastore.v1.ReadOptions read_options = 1;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\ReadOptions|null | |
hasReadOptions
clearReadOptions
setReadOptions
The options for this lookup request.
Generated from protobuf field .google.datastore.v1.ReadOptions read_options = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\V1\ReadOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKeys
Required. Keys of entities to look up.
Generated from protobuf field repeated .google.datastore.v1.Key keys = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setKeys
Required. Keys of entities to look up.
Generated from protobuf field repeated .google.datastore.v1.Key keys = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Datastore\V1\Key>
|
| Returns | |
|---|---|
| Type | Description |
$this | |