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

The response for Firestore.Execute.

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

## Namespace

Google \\ Cloud \\ Firestore \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `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<https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.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__`](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.Document#_Google_Cloud_Firestore_V1_Document__getName__) and [`__update_time__`](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.Document#_Google_Cloud_Firestore_V1_Document__getUpdateTime__). 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`](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.DocumentMask). |
| `↳ execution_time` | `https://protobuf.dev/reference/php/api-docs/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` | `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.ExplainStats` Query explain stats. This is present on the **last** response 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `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.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$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__`](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.Document#_Google_Cloud_Firestore_V1_Document__getName__) and
[`__update_time__`](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.Document#_Google_Cloud_Firestore_V1_Document__getUpdateTime__). 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`](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.DocumentMask).

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

### 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__`](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.Document#_Google_Cloud_Firestore_V1_Document__getName__) and
[`__update_time__`](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.Document#_Google_Cloud_Firestore_V1_Document__getUpdateTime__). 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`](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.DocumentMask).

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$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.

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

### 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.

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

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

### getExplainStats

Query explain stats.

This is present on the **last** response 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.

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

### hasExplainStats

### clearExplainStats

### setExplainStats

Query explain stats.

This is present on the **last** response 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.

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

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