class Google::Apis::FirestoreV1::BatchGetDocumentsRequest

The request for Firestore.BatchGetDocuments.

Attributes

documents[RW]

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. Corresponds to the JSON property `documents` @return [Array<String>]

mask[RW]

A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value. Corresponds to the JSON property `mask` @return [Google::Apis::FirestoreV1::DocumentMask]

new_transaction[RW]

Options for creating a new transaction. Corresponds to the JSON property `newTransaction` @return [Google::Apis::FirestoreV1::TransactionOptions]

read_time[RW]

Reads documents as they were at the given time. This may not be older than 270 seconds. Corresponds to the JSON property `readTime` @return [String]

transaction[RW]

Reads documents in a transaction. Corresponds to the JSON property `transaction` NOTE: Values are automatically base64 encoded/decoded in the client library. @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/firestore_v1/classes.rb, line 81
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/firestore_v1/classes.rb, line 86
def update!(**args)
  @documents = args[:documents] if args.key?(:documents)
  @mask = args[:mask] if args.key?(:mask)
  @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
  @read_time = args[:read_time] if args.key?(:read_time)
  @transaction = args[:transaction] if args.key?(:transaction)
end