The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between theirread_timeand this one. If the query returns no results, a response withread_timeand noresultwill be sent, and this represents the time at which the query was run.
Query explain metrics. This is only present when theRunAggregationQueryRequest.explain_optionsis provided, and it is sent only once with the last response in the stream.
The transaction that was started as part of this request.
Only present on the first response when the request requested to start
a new transaction.
Returns
Type
Description
string
setTransaction
The transaction that was started as part of this request.
Only present on the first response when the request requested to start
a new transaction.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getReadTime
The time at which the aggregate result was computed. This is always
monotonically increasing; in this case, the previous AggregationResult in
the result stream are guaranteed not to have changed between theirread_timeand this one.
If the query returns no results, a response withread_timeand noresultwill be sent, and this represents the time at which the query
was run.
The time at which the aggregate result was computed. This is always
monotonically increasing; in this case, the previous AggregationResult in
the result stream are guaranteed not to have changed between theirread_timeand this one.
If the query returns no results, a response withread_timeand noresultwill be sent, and this represents the time at which the query
was run.
Query explain metrics. This is only present when theRunAggregationQueryRequest.explain_optionsis provided, and it is sent only once with the last response in the stream.
Query explain metrics. This is only present when theRunAggregationQueryRequest.explain_optionsis provided, and it is sent only once with the last response in the stream.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class RunAggregationQueryResponse (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1.RunAggregationQueryResponse)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1.RunAggregationQueryResponse)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1.RunAggregationQueryResponse)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1.RunAggregationQueryResponse)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1.RunAggregationQueryResponse)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1.RunAggregationQueryResponse)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1.RunAggregationQueryResponse)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1.RunAggregationQueryResponse)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1.RunAggregationQueryResponse)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1.RunAggregationQueryResponse)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1.RunAggregationQueryResponse)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1.RunAggregationQueryResponse)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1.RunAggregationQueryResponse)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1.RunAggregationQueryResponse)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1.RunAggregationQueryResponse)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1.RunAggregationQueryResponse)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1.RunAggregationQueryResponse)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1.RunAggregationQueryResponse)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1.RunAggregationQueryResponse)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1.RunAggregationQueryResponse)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1.RunAggregationQueryResponse)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1.RunAggregationQueryResponse)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1.RunAggregationQueryResponse) \nReference documentation and code samples for the Cloud Firestore V1 Client class RunAggregationQueryResponse.\n\nThe response for\nFirestore.RunAggregationQuery.\n\nGenerated from protobuf message `google.firestore.v1.RunAggregationQueryResponse`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getResult\n\nA single aggregation result.\n\nNot present when reporting partial progress.\n\n### hasResult\n\n### clearResult\n\n### setResult\n\nA single aggregation result.\n\nNot present when reporting partial progress.\n\n### getTransaction\n\nThe transaction that was started as part of this request.\n\nOnly present on the first response when the request requested to start\na new transaction.\n\n### setTransaction\n\nThe transaction that was started as part of this request.\n\nOnly present on the first response when the request requested to start\na new transaction.\n\n### getReadTime\n\nThe time at which the aggregate result was computed. This is always\nmonotonically increasing; in this case, the previous AggregationResult in\nthe result stream are guaranteed not to have changed between their\n`read_time` and this one.\n\nIf the query returns no results, a response with `read_time` and no\n`result` will be sent, and this represents the time at which the query\nwas run.\n\n### hasReadTime\n\n### clearReadTime\n\n### setReadTime\n\nThe time at which the aggregate result was computed. This is always\nmonotonically increasing; in this case, the previous AggregationResult in\nthe result stream are guaranteed not to have changed between their\n`read_time` and this one.\n\nIf the query returns no results, a response with `read_time` and no\n`result` will be sent, and this represents the time at which the query\nwas run.\n\n### getExplainMetrics\n\nQuery explain metrics. This is only present when the\n[RunAggregationQueryRequest.explain_options](/php/docs/reference/cloud-firestore/latest/V1.RunAggregationQueryRequest#_Google_Cloud_Firestore_V1_RunAggregationQueryRequest__getExplainOptions__)\nis provided, and it is sent only once with the last response in the stream.\n\n### hasExplainMetrics\n\n### clearExplainMetrics\n\n### setExplainMetrics\n\nQuery explain metrics. This is only present when the\n[RunAggregationQueryRequest.explain_options](/php/docs/reference/cloud-firestore/latest/V1.RunAggregationQueryRequest#_Google_Cloud_Firestore_V1_RunAggregationQueryRequest__getExplainOptions__)\nis provided, and it is sent only once with the last response in the stream."]]
