Cloud Datastore V1 Client - Class RunAggregationQueryRequest (1.19.0)
Reference documentation and code samples for the Cloud Datastore V1 Client class RunAggregationQueryRequest.
The request forDatastore.RunAggregationQuery.
Generated from protobuf messagegoogle.datastore.v1.RunAggregationQueryRequest
Methods
__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 | Google\Cloud\Datastore\V1\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 | Google\Cloud\Datastore\V1\ReadOptionsThe options for this query. |
↳ aggregation_query | Google\Cloud\Datastore\V1\AggregationQueryThe query to run. |
↳ gql_query | Google\Cloud\Datastore\V1\GqlQueryThe GQL query to run. This query must be an aggregation query. |
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 |
Google\Cloud\Datastore\V1\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 | Google\Cloud\Datastore\V1\PartitionId |
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadOptions
The options for this query.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\ReadOptions|null | |
hasReadOptions
clearReadOptions
setReadOptions
The options for this query.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\Datastore\V1\ReadOptions |
| Returns | |
|---|---|
| Type | Description |
$this | |
getAggregationQuery
The query to run.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\AggregationQuery|null | |
hasAggregationQuery
setAggregationQuery
The query to run.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\Datastore\V1\AggregationQuery |
| Returns | |
|---|---|
| Type | Description |
$this | |
getGqlQuery
The GQL query to run. This query must be an aggregation query.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\GqlQuery|null | |
hasGqlQuery
setGqlQuery
The GQL query to run. This query must be an aggregation query.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Cloud\Datastore\V1\GqlQuery |
| 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.