Reference documentation and code samples for the Cloud Firestore V1 Client class ExecutePipelineResponse.
The response for Firestore.Execute .
Generated from protobuf message google.firestore.v1.ExecutePipelineResponse
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ transaction
string
Newly created transaction identifier. This field is only specified as part of the first response from the server, alongside the results
field when the original request specified ExecuteRequest.new_transaction
.
↳ results
array< Document
>
An ordered batch of results returned executing a pipeline. The batch size is variable, and can even be zero for when only a partial progress message is returned. The fields present in the returned documents are only those that were explicitly requested in the pipeline, this includes those like __name__
and __update_time__
. This is explicitly a divergence from Firestore.RunQuery
/ Firestore.GetDocument
RPCs which always return such fields even when they are not specified in the mask
.
↳ execution_time
Google\Protobuf\Timestamp
The time at which the results are valid. This is a (not strictly) monotonically increasing value across multiple responses in the same stream. The API guarantees that all previously returned results are still valid at the latest execution_time
. This allows the API consumer to treat the query if it ran at the latest execution_time
returned. If the query returns no results, a response with execution_time
and no results
will be sent, and this represents the time at which the operation was run.
↳ explain_stats
ExplainStats
Query explain stats. This is present on the lastresponse if the request configured explain to run in 'analyze' or 'explain' mode in the pipeline options. If the query does not return any results, a response with explain_stats
and no results
will still be sent.
getTransaction
Newly created transaction identifier.
This field is only specified as part of the first response from the server,
alongside the results
field when the original request specified ExecuteRequest.new_transaction
.
string
setTransaction
Newly created transaction identifier.
This field is only specified as part of the first response from the server,
alongside the results
field when the original request specified ExecuteRequest.new_transaction
.
var
string
$this
getResults
An ordered batch of results returned executing a pipeline.
The batch size is variable, and can even be zero for when only a partial
progress message is returned.
The fields present in the returned documents are only those that were
explicitly requested in the pipeline, this includes those like __name__
and __update_time__
. This is
explicitly a divergence from Firestore.RunQuery
/ Firestore.GetDocument
RPCs which always return such fields even when they are not specified in
the mask
.
setResults
An ordered batch of results returned executing a pipeline.
The batch size is variable, and can even be zero for when only a partial
progress message is returned.
The fields present in the returned documents are only those that were
explicitly requested in the pipeline, this includes those like __name__
and __update_time__
. This is
explicitly a divergence from Firestore.RunQuery
/ Firestore.GetDocument
RPCs which always return such fields even when they are not specified in
the mask
.
$this
getExecutionTime
The time at which the results are valid.
This is a (not strictly) monotonically increasing value across multiple
responses in the same stream. The API guarantees that all previously
returned results are still valid at the latest execution_time
. This
allows the API consumer to treat the query if it ran at the latest execution_time
returned.
If the query returns no results, a response with execution_time
and no results
will be sent, and this represents the time at which the operation
was run.
hasExecutionTime
clearExecutionTime
setExecutionTime
The time at which the results are valid.
This is a (not strictly) monotonically increasing value across multiple
responses in the same stream. The API guarantees that all previously
returned results are still valid at the latest execution_time
. This
allows the API consumer to treat the query if it ran at the latest execution_time
returned.
If the query returns no results, a response with execution_time
and no results
will be sent, and this represents the time at which the operation
was run.
$this
getExplainStats
Query explain stats.
This is present on the lastresponse if the request configured explain
to run in 'analyze' or 'explain' mode in the pipeline options. If the query
does not return any results, a response with explain_stats
and no results
will still be sent.
hasExplainStats
clearExplainStats
setExplainStats
Query explain stats.
This is present on the lastresponse if the request configured explain
to run in 'analyze' or 'explain' mode in the pipeline options. If the query
does not return any results, a response with explain_stats
and no results
will still be sent.
$this
