# Cloud Firestore V1 Client - Class ExecutePipelineRequest (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 ExecutePipelineRequest.

The request for
Firestore.ExecutePipeline.

Generated from protobuf message `google.firestore.v1.ExecutePipelineRequest`

## Namespace

Google \\ Cloud \\ Firestore \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ database` | `string` Required. Database identifier, in the form `projects/{project}/databases/{database}`. |
| `↳ structured_pipeline` | `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.StructuredPipeline` A pipelined operation. |
| `↳ transaction` | `string` Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in. |
| `↳ new_transaction` | `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.TransactionOptions` Execute the pipeline in a new transaction. The identifier of the newly created transaction will be returned in the first response on the stream. This defaults to a read-only transaction. |
| `↳ read_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. |

### getDatabase

Required. Database identifier, in the form
`projects/{project}/databases/{database}`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setDatabase

Required. Database identifier, in the form
`projects/{project}/databases/{database}`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getStructuredPipeline

A pipelined operation.

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

### hasStructuredPipeline

### setStructuredPipeline

A pipelined operation.

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

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

### getTransaction

Run the query within an already active transaction.

The value here is the opaque transaction ID to execute the query in.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasTransaction

### setTransaction

Run the query within an already active transaction.

The value here is the opaque transaction ID to execute the query in.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getNewTransaction

Execute the pipeline in a new transaction.

The identifier of the newly created transaction will be returned in the
first response on the stream. This defaults to a read-only transaction.

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

### hasNewTransaction

### setNewTransaction

Execute the pipeline in a new transaction.

The identifier of the newly created transaction will be returned in the
first response on the stream. This defaults to a read-only transaction.

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

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

### getReadTime

Execute the pipeline in a snapshot transaction at the given time.

This must be a microsecond precision timestamp within the past one hour,
or if Point-in-Time Recovery is enabled, can additionally be a whole
minute timestamp within the past 7 days.

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

### hasReadTime

### setReadTime

Execute the pipeline in a snapshot transaction at the given time.

This must be a microsecond precision timestamp within the past one hour,
or if Point-in-Time Recovery is enabled, can additionally be a whole
minute timestamp within the past 7 days.

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

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

### getPipelineType

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### getConsistencySelector

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |