Cloud Firestore V1beta1 Client - Class RunQueryRequest (1.39.0)

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
NameDescription
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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getStructuredQuery

A structured query.

Returns
TypeDescription
Google\Cloud\Firestore\V1beta1\StructuredQuery

setStructuredQuery

A structured query.

Parameter
NameDescription
var Google\Cloud\Firestore\V1beta1\StructuredQuery
Returns
TypeDescription
$this

getTransaction

Reads documents in a transaction.

Returns
TypeDescription
string

setTransaction

Reads documents in a transaction.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Cloud\Firestore\V1beta1\TransactionOptions
Returns
TypeDescription
$this

getReadTime

Reads documents as they were at the given time.

This may not be older than 60 seconds.

Returns
TypeDescription
Google\Protobuf\Timestamp

setReadTime

Reads documents as they were at the given time.

This may not be older than 60 seconds.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getQueryType

Returns
TypeDescription
string

getConsistencySelector

Returns
TypeDescription
string