Cloud Firestore V1beta1 Client - Class RunQueryRequest (1.40.0)

Version 1.40.0

• 1.47.1 (latest)
• 1.47.0
• 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

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Cloud Firestore V1beta1 Client class RunQueryRequest.

The request for Firestore.RunQuery.

Generated from protobuf message google.firestore.v1beta1.RunQueryRequest

Namespace

Google \ Cloud \ Firestore \ V1beta1

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	Google\Cloud\Firestore\V1beta1\StructuredQuery A structured query.
↳ transaction	string Reads documents in a transaction.
↳ new_transaction	Google\Cloud\Firestore\V1beta1\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	Google\Protobuf\Timestamp Reads documents as they were at the given time. This may not be older than 60 seconds.

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
Google\Cloud\Firestore\V1beta1\StructuredQuery

setStructuredQuery

A structured query.

Parameter
Name	Description
var	Google\Cloud\Firestore\V1beta1\StructuredQuery

Returns
Type	Description
$this

getTransaction

Reads documents in a transaction.

Returns
Type	Description
string

setTransaction

Reads documents in a transaction.

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
Google\Cloud\Firestore\V1beta1\TransactionOptions

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	Google\Cloud\Firestore\V1beta1\TransactionOptions

Returns
Type	Description
$this

getReadTime

Reads documents as they were at the given time.

This may not be older than 60 seconds.

Returns
Type	Description
Google\Protobuf\Timestamp

setReadTime

Reads documents as they were at the given time.

This may not be older than 60 seconds.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getQueryType

Returns
Type	Description
string

getConsistencySelector

Returns
Type	Description
string