Cloud Datastore V1 Client - Class LookupRequest (1.23.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.

Returns
TypeDescription
string

setProjectId

Required. The ID of the project against which to make the request.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getReadOptions

The options for this lookup request.

Returns
TypeDescription
Google\Cloud\Datastore\V1\ReadOptions|null

hasReadOptions

clearReadOptions

setReadOptions

The options for this lookup request.

Parameter
NameDescription
var Google\Cloud\Datastore\V1\ReadOptions
Returns
TypeDescription
$this

getKeys

Required. Keys of entities to look up.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setKeys

Required. Keys of entities to look up.

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

static::build

Parameters
NameDescription
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
TypeDescription
Google\Cloud\Datastore\V1\LookupRequest