Reference documentation and code samples for the Cloud Firestore V1beta1 Client class RunQueryResponse.
The response for Firestore.RunQuery.
Generated from protobuf message google.firestore.v1beta1.RunQueryResponse
Namespace
Google \ Cloud \ Firestore \ V1beta1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ transaction
string
The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.
The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their read_time and this one. If the query returns no results, a response with read_time and no document will be sent, and this represents the time at which the query was run.
↳ skipped_results
int
The number of results that have been skipped due to an offset between the last response and the current response.
getTransaction
The transaction that was started as part of this request.
Can only be set in the first response, and only if
RunQueryRequest.new_transaction was set in the request.
If set, no other fields will be set in this response.
Returns
Type
Description
string
setTransaction
The transaction that was started as part of this request.
Can only be set in the first response, and only if
RunQueryRequest.new_transaction was set in the request.
If set, no other fields will be set in this response.
The time at which the document was read. This may be monotonically
increasing; in this case, the previous documents in the result stream are
guaranteed not to have changed between their read_time and this one.
If the query returns no results, a response with read_time and no
document will be sent, and this represents the time at which the query
was run.
The time at which the document was read. This may be monotonically
increasing; in this case, the previous documents in the result stream are
guaranteed not to have changed between their read_time and this one.
If the query returns no results, a response with read_time and no
document will be sent, and this represents the time at which the query
was run.
[[["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 V1beta1 Client - Class RunQueryResponse (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1beta1.RunQueryResponse)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1beta1.RunQueryResponse)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1beta1.RunQueryResponse)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1beta1.RunQueryResponse)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1beta1.RunQueryResponse)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1beta1.RunQueryResponse)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1beta1.RunQueryResponse)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1beta1.RunQueryResponse)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1beta1.RunQueryResponse)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1beta1.RunQueryResponse)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1beta1.RunQueryResponse)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1beta1.RunQueryResponse)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1beta1.RunQueryResponse)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1beta1.RunQueryResponse)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1beta1.RunQueryResponse)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1beta1.RunQueryResponse)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1beta1.RunQueryResponse)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1beta1.RunQueryResponse)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1beta1.RunQueryResponse)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1beta1.RunQueryResponse)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1beta1.RunQueryResponse)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1beta1.RunQueryResponse)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1beta1.RunQueryResponse) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Cloud Firestore V1beta1 Client class RunQueryResponse.\n\nThe response for Firestore.RunQuery.\n\nGenerated from protobuf message `google.firestore.v1beta1.RunQueryResponse`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getTransaction\n\nThe transaction that was started as part of this request.\n\nCan only be set in the first response, and only if\n[RunQueryRequest.new_transaction](/php/docs/reference/cloud-firestore/latest/V1beta1.RunQueryRequest#_Google_Cloud_Firestore_V1beta1_RunQueryRequest__getNewTransaction__) was set in the request.\nIf set, no other fields will be set in this response.\n\n### setTransaction\n\nThe transaction that was started as part of this request.\n\nCan only be set in the first response, and only if\n[RunQueryRequest.new_transaction](/php/docs/reference/cloud-firestore/latest/V1beta1.RunQueryRequest#_Google_Cloud_Firestore_V1beta1_RunQueryRequest__getNewTransaction__) was set in the request.\nIf set, no other fields will be set in this response.\n\n### getDocument\n\nA query result.\n\nNot set when reporting partial progress.\n\n### setDocument\n\nA query result.\n\nNot set when reporting partial progress.\n\n### getReadTime\n\nThe time at which the document was read. This may be monotonically\nincreasing; in this case, the previous documents in the result stream are\nguaranteed not to have changed between their `read_time` and this one.\n\nIf the query returns no results, a response with `read_time` and no\n`document` will be sent, and this represents the time at which the query\nwas run.\n\n### setReadTime\n\nThe time at which the document was read. This may be monotonically\nincreasing; in this case, the previous documents in the result stream are\nguaranteed not to have changed between their `read_time` and this one.\n\nIf the query returns no results, a response with `read_time` and no\n`document` will be sent, and this represents the time at which the query\nwas run.\n\n### getSkippedResults\n\nThe number of results that have been skipped due to an offset between\nthe last response and the current response.\n\n### setSkippedResults\n\nThe number of results that have been skipped due to an offset between\nthe last response and the current response."]]
