Reference documentation and code samples for the Cloud Firestore V1 Client class RunQueryResponse.
The response for Firestore.RunQuery .
Generated from protobuf message google.firestore.v1.RunQueryResponse
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
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.
↳ document
↳ read_time
Google\Protobuf\Timestamp
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.
↳ done
bool
If present, Firestore has completely finished the request and no more documents will be returned.
↳ explain_metrics
ExplainMetrics
Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.
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.
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.
var
string
$this
getDocument
A query result, not set when reporting partial progress.
hasDocument
clearDocument
setDocument
A query result, not set when reporting partial progress.
$this
getReadTime
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.
hasReadTime
clearReadTime
setReadTime
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.
$this
getSkippedResults
The number of results that have been skipped due to an offset between the last response and the current response.
int
setSkippedResults
The number of results that have been skipped due to an offset between the last response and the current response.
var
int
$this
getDone
If present, Firestore has completely finished the request and no more documents will be returned.
bool
hasDone
setDone
If present, Firestore has completely finished the request and no more documents will be returned.
var
bool
$this
getExplainMetrics
Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.
hasExplainMetrics
clearExplainMetrics
setExplainMetrics
Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.
$this
getContinuationSelector
string
