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

The request for Firestore.RunQuery.

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

## Namespace

Google \\ Cloud \\ Firestore \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ parent` | `string` Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` |
| `↳ structured_query` | `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.StructuredQuery` A structured query. |
| `↳ 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` Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. |
| `↳ read_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Reads documents as they were 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. |
| `↳ explain_options` | `https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.ExplainOptions` Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. |

### getParent

Required. The parent resource name. In the format:
`projects/{project_id}/databases/{database_id}/documents` or
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.

For example:
`projects/my-project/databases/my-database/documents` or
`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

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

### setParent

Required. The parent resource name. In the format:
`projects/{project_id}/databases/{database_id}/documents` or
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.

For example:
`projects/my-project/databases/my-database/documents` or
`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

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

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

### getStructuredQuery

A structured query.

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

### hasStructuredQuery

### setStructuredQuery

A structured query.

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

| **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

Starts a new transaction and reads the documents.

Defaults to a read-only transaction.
The new transaction ID will be returned as the first response in the
stream.

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

### hasNewTransaction

### setNewTransaction

Starts a new transaction and reads the documents.

Defaults to a read-only transaction.
The new transaction ID will be returned as the first response in the
stream.

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

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

### getReadTime

Reads documents as they were 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

Reads documents as they were 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` |   |

### getExplainOptions

Optional. Explain options for the query. If set, additional query
statistics will be returned. If not, only query results will be returned.

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

### hasExplainOptions

### clearExplainOptions

### setExplainOptions

Optional. Explain options for the query. If set, additional query
statistics will be returned. If not, only query results will be returned.

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

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

### getQueryType

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

### getConsistencySelector

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