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 \ V1beta1Methods
__construct
Constructor.
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
↳ 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
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
var
string
$this
getStructuredQuery
A structured query.
setStructuredQuery
A structured query.
$this
getTransaction
Reads documents in a transaction.
string
setTransaction
Reads documents in a transaction.
var
string
$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.
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.
$this
getReadTime
Reads documents as they were at the given time.
This may not be older than 60 seconds.
setReadTime
Reads documents as they were at the given time.
This may not be older than 60 seconds.
$this
getQueryType
string
getConsistencySelector
string
