Cloud Firestore V1 Client - Class RunAggregationQueryRequest (1.31.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

Methods

__construct

Constructor.

Parameters
NameDescription
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. Requires: * Cannot be more than 270 seconds in the past.

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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getStructuredAggregationQuery

An aggregation query.

Returns
TypeDescription
Google\Cloud\Firestore\V1\StructuredAggregationQuery|null

hasStructuredAggregationQuery

setStructuredAggregationQuery

An aggregation query.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\StructuredAggregationQuery
Returns
TypeDescription
$this

getTransaction

Run the aggregation within an already active transaction.

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

Returns
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Cloud\Firestore\V1\TransactionOptions
Returns
TypeDescription
$this

getReadTime

Executes the query at the given timestamp.

Requires:

  • Cannot be more than 270 seconds in the past.
Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasReadTime

setReadTime

Executes the query at the given timestamp.

Requires:

  • Cannot be more than 270 seconds in the past.
Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getQueryType

Returns
TypeDescription
string

getConsistencySelector

Returns
TypeDescription
string