Reference documentation and code samples for the Cloud Firestore V1 Client class QueryTarget.
A target specified by a query.
Generated from protobuf message google.firestore.v1.Target.QueryTarget
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
The parent resource name. In the format: |
↳ structured_query |
Google\Cloud\Firestore\V1\StructuredQuery
A structured query. |
getParent
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
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 |
Google\Cloud\Firestore\V1\StructuredQuery|null | |
hasStructuredQuery
setStructuredQuery
A structured query.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\StructuredQuery
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryType
| Returns | |
|---|---|
| Type | Description |
string | |