Reference documentation and code samples for the Cloud Firestore V1 Client class StructuredPipeline.
A Firestore query represented as an ordered list of operations / stages.
This is considered the top-level function which plans and executes a query.
It is logically equivalent to query(stages, options)
, but prevents the
client from having to build a function wrapper.
Generated from protobuf message google.firestore.v1.StructuredPipeline
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ pipeline
↳ options
getPipeline
Required. The pipeline query to execute.
hasPipeline
clearPipeline
setPipeline
Required. The pipeline query to execute.
Returns
Type
Description
$this
getOptions
Optional. Optional query-level arguments.
setOptions
Optional. Optional query-level arguments.
Returns
Type
Description
$this
