# Cloud Firestore V1 Client - Class StructuredPipeline (2.2.0-RC1)

2.2.0-RC1 2.1.0 (latest) 2.0.2-RC1 1.55.0 1.54.4 1.53.1 1.52.0 1.51.0 1.50.0 1.48.1 1.47.3 1.46.0 1.45.2 1.44.1 1.43.3 1.40.0 1.39.0 1.38.0 1.37.7 1.36.1 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.28.0 1.27.3 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 \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ pipeline` | `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.Pipeline` Required. The pipeline query to execute. |
| `↳ options` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` Optional. Optional query-level arguments. |

### getPipeline

Required. The pipeline query to execute.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.Pipeline|null` |   |

### hasPipeline

### clearPipeline

### setPipeline

Required. The pipeline query to execute.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.Pipeline` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOptions

Optional. Optional query-level arguments.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |   |

### setOptions

Optional. Optional query-level arguments.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |