Class: Google::Firestore::V1::RunQueryRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb

Overview

The request for Firestore::RunQuery.

Instance Attribute Summary collapse

Instance Attribute Details

#new_transactionGoogle::Firestore::V1::TransactionOptions

Returns 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:

  • (Google::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.



289
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 289

class RunQueryRequest; end

#parentString

Returns 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:

  • (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



289
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 289

class RunQueryRequest; end

#read_timeGoogle::Protobuf::Timestamp

Returns Reads documents as they were at the given time. This may not be older than 60 seconds.

Returns:



289
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 289

class RunQueryRequest; end

#structured_queryGoogle::Firestore::V1::StructuredQuery

Returns A structured query.

Returns:



289
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 289

class RunQueryRequest; end

#transactionString

Returns Reads documents in a transaction.

Returns:

  • (String)

    Reads documents in a transaction.



289
# File 'lib/google/cloud/firestore/v1/doc/google/firestore/v1/firestore.rb', line 289

class RunQueryRequest; end