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 |
Pipeline
Required. The pipeline query to execute. |
↳ options |
array|Google\Protobuf\Internal\MapField
Optional. Optional query-level arguments. |
getPipeline
Required. The pipeline query to execute.
| Returns | |
|---|---|
| Type | Description |
Pipeline|null |
|
hasPipeline
clearPipeline
setPipeline
Required. The pipeline query to execute.
| Parameter | |
|---|---|
| Name | Description |
var |
Pipeline
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOptions
Optional. Optional query-level arguments.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setOptions
Optional. Optional query-level arguments.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|