Cloud Firestore V1 Client - Class RunAggregationQueryRequest (1.46.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class RunAggregationQueryRequest.

The request for Firestore.RunAggregationQuery.

Generated from protobuf message google.firestore.v1.RunAggregationQueryRequest

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

↳ structured_aggregation_query Google\Cloud\Firestore\V1\StructuredAggregationQuery

An aggregation query.

↳ transaction string

Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in.

↳ new_transaction Google\Cloud\Firestore\V1\TransactionOptions

Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.

↳ read_time Google\Protobuf\Timestamp

Executes the query at the given timestamp. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

↳ explain_options Google\Cloud\Firestore\V1\ExplainOptions

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

getParent

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}.

For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Returns
Type Description
string

setParent

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}.

For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Parameter
Name Description
var string
Returns
Type Description
$this

getStructuredAggregationQuery

An aggregation query.

Returns
Type Description
Google\Cloud\Firestore\V1\StructuredAggregationQuery|null

hasStructuredAggregationQuery

setStructuredAggregationQuery

An aggregation query.

Parameter
Name Description
var Google\Cloud\Firestore\V1\StructuredAggregationQuery
Returns
Type Description
$this

getTransaction

Run the aggregation within an already active transaction.

The value here is the opaque transaction ID to execute the query in.

Returns
Type Description
string

hasTransaction

setTransaction

Run the aggregation within an already active transaction.

The value here is the opaque transaction ID to execute the query in.

Parameter
Name Description
var string
Returns
Type Description
$this

getNewTransaction

Starts a new transaction as part of the query, defaulting to read-only.

The new transaction ID will be returned as the first response in the stream.

Returns
Type Description
Google\Cloud\Firestore\V1\TransactionOptions|null

hasNewTransaction

setNewTransaction

Starts a new transaction as part of the query, defaulting to read-only.

The new transaction ID will be returned as the first response in the stream.

Parameter
Name Description
var Google\Cloud\Firestore\V1\TransactionOptions
Returns
Type Description
$this

getReadTime

Executes the query at the given timestamp.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasReadTime

setReadTime

Executes the query at the given timestamp.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getExplainOptions

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

Returns
Type Description
Google\Cloud\Firestore\V1\ExplainOptions|null

hasExplainOptions

clearExplainOptions

setExplainOptions

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

Parameter
Name Description
var Google\Cloud\Firestore\V1\ExplainOptions
Returns
Type Description
$this

getQueryType

Returns
Type Description
string

getConsistencySelector

Returns
Type Description
string