HTTP request

Path parameters

Parameters

database

string

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

Request body

The request body contains data with the following structure:

JSON representation

{"documents": [string],"mask": {object(DocumentMask)},// Union field consistency_selector can be only one of the following:"transaction": string,"newTransaction": {object(TransactionOptions)},"readTime": string// End of list of possible types for union field consistency_selector.}

Fields

documents[]

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.

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their readTime and this one.