Reference documentation and code samples for the Cloud Datastore V1 Client class RunAggregationQueryRequest.
The request for Datastore.RunAggregationQuery.
Generated from protobuf message google.datastore.v1.RunAggregationQueryRequest
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. |
↳ partition_id |
Google\Cloud\Datastore\V1\PartitionId
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 context partition ID. |
↳ read_options |
Google\Cloud\Datastore\V1\ReadOptions
The options for this query. |
↳ aggregation_query |
Google\Cloud\Datastore\V1\AggregationQuery
The query to run. |
↳ gql_query |
Google\Cloud\Datastore\V1\GqlQuery
The GQL query to run. This query must be an aggregation query. |
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 | |
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 context partition ID.
Generated from protobuf field .google.datastore.v1.PartitionId partition_id = 2;
| 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 context partition ID.
Generated from protobuf field .google.datastore.v1.PartitionId partition_id = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\V1\PartitionId
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadOptions
The options for this query.
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 query.
Generated from protobuf field .google.datastore.v1.ReadOptions read_options = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\V1\ReadOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAggregationQuery
The query to run.
Generated from protobuf field .google.datastore.v1.AggregationQuery aggregation_query = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\AggregationQuery|null | |
hasAggregationQuery
setAggregationQuery
The query to run.
Generated from protobuf field .google.datastore.v1.AggregationQuery aggregation_query = 3;
| 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.
Generated from protobuf field .google.datastore.v1.GqlQuery gql_query = 7;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\GqlQuery|null | |
hasGqlQuery
setGqlQuery
The GQL query to run. This query must be an aggregation query.
Generated from protobuf field .google.datastore.v1.GqlQuery gql_query = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\V1\GqlQuery
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryType
| Returns | |
|---|---|
| Type | Description |
string | |