Cloud Datastore V1 Client - Class RunQueryRequest (2.0.3)
Reference documentation and code samples for the Cloud Datastore V1 Client class RunQueryRequest.
The request forDatastore.RunQuery.
Generated from protobuf messagegoogle.datastore.v1.RunQueryRequest
Namespace
Google \ Cloud \ Datastore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ project_id | stringRequired. The ID of the project against which to make the request. |
↳ database_id | stringThe ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database. |
↳ partition_id | PartitionIdEntities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID. |
↳ read_options | ReadOptionsThe options for this query. |
↳ query | QueryThe query to run. |
↳ gql_query | GqlQueryThe GQL query to run. This query must be a non-aggregation query. |
↳ property_mask | PropertyMaskThe properties to return. This field must not be set for a projection query. SeeLookupRequest.property_mask. |
↳ explain_options | ExplainOptionsOptional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be 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 defaultdatabase.
| 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 defaultdatabase.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPartitionId
Entities are partitioned into subsets, identified by a partition ID.
Queries are scoped to a single partition.This partition ID is normalized with the standard default contextpartition ID.
| Returns | |
|---|---|
| Type | Description |
PartitionId|null | |
hasPartitionId
clearPartitionId
setPartitionId
Entities are partitioned into subsets, identified by a partition ID.
Queries are scoped to a single partition.This partition ID is normalized with the standard default contextpartition ID.
| Parameter | |
|---|---|
| Name | Description |
var | PartitionId |
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadOptions
The options for this query.
| Returns | |
|---|---|
| Type | Description |
ReadOptions|null | |
hasReadOptions
clearReadOptions
setReadOptions
The options for this query.
| Parameter | |
|---|---|
| Name | Description |
var | ReadOptions |
| Returns | |
|---|---|
| Type | Description |
$this | |
getQuery
The query to run.
| Returns | |
|---|---|
| Type | Description |
Query|null | |
hasQuery
setQuery
The query to run.
| Parameter | |
|---|---|
| Name | Description |
var | Query |
| Returns | |
|---|---|
| Type | Description |
$this | |
getGqlQuery
The GQL query to run. This query must be a non-aggregation query.
| Returns | |
|---|---|
| Type | Description |
GqlQuery|null | |
hasGqlQuery
setGqlQuery
The GQL query to run. This query must be a non-aggregation query.
| Parameter | |
|---|---|
| Name | Description |
var | GqlQuery |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPropertyMask
The properties to return.
This field must not be set for a projection query.SeeLookupRequest.property_mask.
| Returns | |
|---|---|
| Type | Description |
PropertyMask|null | |
hasPropertyMask
clearPropertyMask
setPropertyMask
The properties to return.
This field must not be set for a projection query.SeeLookupRequest.property_mask.
| Parameter | |
|---|---|
| Name | Description |
var | PropertyMask |
| Returns | |
|---|---|
| Type | Description |
$this | |
getExplainOptions
Optional. Explain options for the query. If set, additional querystatistics will be returned. If not, only query results will be returned.
| Returns | |
|---|---|
| Type | Description |
ExplainOptions|null | |
hasExplainOptions
clearExplainOptions
setExplainOptions
Optional. Explain options for the query. If set, additional querystatistics will be returned. If not, only query results will be returned.
| Parameter | |
|---|---|
| Name | Description |
var | ExplainOptions |
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryType
| Returns | |
|---|---|
| Type | Description |
string | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-24 UTC.