Cloud Datastore V1 Client - Class RunAggregationQueryRequest (1.26.0)

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

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.

↳ 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.

↳ mode int

Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to NORMAL mode where no additional statistics will be returned with the query results.

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

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.

Returns
TypeDescription
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.

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

getReadOptions

The options for this query.

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

hasReadOptions

clearReadOptions

setReadOptions

The options for this query.

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

getAggregationQuery

The query to run.

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

hasAggregationQuery

setAggregationQuery

The query to run.

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

getGqlQuery

The GQL query to run. This query must be an aggregation query.

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

hasGqlQuery

setGqlQuery

The GQL query to run. This query must be an aggregation query.

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

getMode

Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to NORMAL mode where no additional statistics will be returned with the query results.

Returns
TypeDescription
int

setMode

Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to NORMAL mode where no additional statistics will be returned with the query results.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getQueryType

Returns
TypeDescription
string