Class: Google::Firestore::V1::BatchGetDocumentsRequest

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

Overview

The request for Firestore::BatchGetDocuments.

Instance Attribute Summary collapse

Instance Attribute Details

#databaseString

Returns Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

Returns:

  • (String)

    Required. The database name. In the format: projects/{project_id}/databases/{database_id}.



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

class BatchGetDocumentsRequest; end

#documentsArray<String>

Returns The names of the documents to retrieve. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. The request will fail if any of the document is not a child resource of the given database. Duplicate names will be elided.

Returns:

  • (Array<String>)

    The names of the documents to retrieve. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. The request will fail if any of the document is not a child resource of the given database. Duplicate names will be elided.



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

class BatchGetDocumentsRequest; end

#maskGoogle::Firestore::V1::DocumentMask

Returns The fields to return. If not set, returns all fields.

If a document has a field that is not present in this mask, that field will not be returned in the response.

Returns:

  • (Google::Firestore::V1::DocumentMask)

    The fields to return. If not set, returns all fields.

    If a document has a field that is not present in this mask, that field will not be returned in the response.



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

class BatchGetDocumentsRequest; end

#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.



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

class BatchGetDocumentsRequest; end

#read_timeGoogle::Protobuf::Timestamp

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

Returns:



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

class BatchGetDocumentsRequest; end

#transactionString

Returns Reads documents in a transaction.

Returns:

  • (String)

    Reads documents in a transaction.



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

class BatchGetDocumentsRequest; end