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

The response for
Firestore.RunQuery.

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

## Namespace

Google \\ Cloud \\ Firestore \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ transaction` | `string` The transaction that was started as part of this request. Can only be set in the first response, and only if [RunQueryRequest.new_transaction](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.RunQueryRequest#_Google_Cloud_Firestore_V1_RunQueryRequest__getNewTransaction__) was set in the request. If set, no other fields will be set in this response. |
| `↳ document` | `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.Document` A query result, not set when reporting partial progress. |
| `↳ read_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run. |
| `↳ skipped_results` | `int` The number of results that have been skipped due to an offset between the last response and the current response. |
| `↳ done` | `bool` If present, Firestore has completely finished the request and no more documents will be returned. |
| `↳ explain_metrics` | `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.ExplainMetrics` Query explain metrics. This is only present when the [RunQueryRequest.explain_options](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.RunQueryRequest#_Google_Cloud_Firestore_V1_RunQueryRequest__getExplainOptions__) is provided, and it is sent only once with the last response in the stream. |

### getTransaction

The transaction that was started as part of this request.

Can only be set in the first response, and only if
[RunQueryRequest.new_transaction](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.RunQueryRequest#_Google_Cloud_Firestore_V1_RunQueryRequest__getNewTransaction__)
was set in the request. If set, no other fields will be set in this
response.

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

### setTransaction

The transaction that was started as part of this request.

Can only be set in the first response, and only if
[RunQueryRequest.new_transaction](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.RunQueryRequest#_Google_Cloud_Firestore_V1_RunQueryRequest__getNewTransaction__)
was set in the request. If set, no other fields will be set in this
response.

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

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

### getDocument

A query result, not set when reporting partial progress.

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

### hasDocument

### clearDocument

### setDocument

A query result, not set when reporting partial progress.

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

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

### getReadTime

The time at which the document was read. This may be monotonically
increasing; in this case, the previous documents in the result stream are
guaranteed not to have changed between their `read_time` and this one.

If the query returns no results, a response with `read_time` and no
`document` will be sent, and this represents the time at which the query
was run.

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

### hasReadTime

### clearReadTime

### setReadTime

The time at which the document was read. This may be monotonically
increasing; in this case, the previous documents in the result stream are
guaranteed not to have changed between their `read_time` and this one.

If the query returns no results, a response with `read_time` and no
`document` will be sent, and this represents the time at which the query
was run.

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

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

### getSkippedResults

The number of results that have been skipped due to an offset between
the last response and the current response.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setSkippedResults

The number of results that have been skipped due to an offset between
the last response and the current response.

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

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

### getDone

If present, Firestore has completely finished the request and no more
documents will be returned.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### hasDone

### setDone

If present, Firestore has completely finished the request and no more
documents will be returned.

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

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

### getExplainMetrics

Query explain metrics. This is only present when the
[RunQueryRequest.explain_options](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.RunQueryRequest#_Google_Cloud_Firestore_V1_RunQueryRequest__getExplainOptions__)
is provided, and it is sent only once with the last response in the stream.

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

### hasExplainMetrics

### clearExplainMetrics

### setExplainMetrics

Query explain metrics. This is only present when the
[RunQueryRequest.explain_options](https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.RunQueryRequest#_Google_Cloud_Firestore_V1_RunQueryRequest__getExplainOptions__)
is provided, and it is sent only once with the last response in the stream.

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

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

### getContinuationSelector

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