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 \ V1Methods
__construct
Constructor.
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
↳ 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.
↳ 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.
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
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
var
string
$this
getStructuredAggregationQuery
An aggregation query.
hasStructuredAggregationQuery
setStructuredAggregationQuery
An aggregation query.
$this
getTransaction
Run the aggregation within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
string
hasTransaction
setTransaction
Run the aggregation within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
var
string
$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.
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.
$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.
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.
$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.
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.
var
int
$this
getQueryType
string
getConsistencySelector
string
