Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::RunQueryRequest.
The request for Firestore.RunQuery.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#new_transaction
def new_transaction() -> ::Google::Cloud::Firestore::V1::TransactionOptions- (::Google::Cloud::Firestore::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.
#new_transaction=
def new_transaction=(value) -> ::Google::Cloud::Firestore::V1::TransactionOptions- value (::Google::Cloud::Firestore::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.
- (::Google::Cloud::Firestore::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.
#parent
def parent() -> ::String-
(::String) — Required. The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. For example:projects/my-project/databases/my-database/documentsorprojects/my-project/databases/my-database/documents/chatrooms/my-chatroom
#parent=
def parent=(value) -> ::String-
value (::String) — Required. The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. For example:projects/my-project/databases/my-database/documentsorprojects/my-project/databases/my-database/documents/chatrooms/my-chatroom
-
(::String) — Required. The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. For example:projects/my-project/databases/my-database/documentsorprojects/my-project/databases/my-database/documents/chatrooms/my-chatroom
#read_time
def read_time() -> ::Google::Protobuf::Timestamp-
(::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.
#read_time=
def read_time=(value) -> ::Google::Protobuf::Timestamp-
value (::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.
-
(::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.
#structured_query
def structured_query() -> ::Google::Cloud::Firestore::V1::StructuredQuery- (::Google::Cloud::Firestore::V1::StructuredQuery) — A structured query.
#structured_query=
def structured_query=(value) -> ::Google::Cloud::Firestore::V1::StructuredQuery- value (::Google::Cloud::Firestore::V1::StructuredQuery) — A structured query.
- (::Google::Cloud::Firestore::V1::StructuredQuery) — A structured query.
#transaction
def transaction() -> ::String-
(::String) — Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
#transaction=
def transaction=(value) -> ::String-
value (::String) — Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
-
(::String) — Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.