BatchGetDocumentsRequest

google.firestore.v1. BatchGetDocumentsRequest

Represents a BatchGetDocumentsRequest.

Constructor

new BatchGetDocumentsRequest(propertiesopt)

Constructs a new BatchGetDocumentsRequest.

Parameters:
Name Type Attributes Description
properties google.firestore.v1.IBatchGetDocumentsRequest <optional>

Properties to set

Implements:
  • IBatchGetDocumentsRequest

Members

consistencySelector :"transaction"|"newTransaction"|"readTime"|undefined

BatchGetDocumentsRequest consistencySelector.

database :string

BatchGetDocumentsRequest database.

documents :Array.<string>

BatchGetDocumentsRequest documents.

mask :google.firestore.v1.IDocumentMask|null|undefined

BatchGetDocumentsRequest mask.

newTransaction :google.firestore.v1.ITransactionOptions|null|undefined

BatchGetDocumentsRequest newTransaction.

readTime :google.protobuf.ITimestamp|null|undefined

BatchGetDocumentsRequest readTime.

transaction :Uint8Array

BatchGetDocumentsRequest transaction.

Methods

(static) fromObject(object) → {google.firestore.v1.BatchGetDocumentsRequest}

Creates a BatchGetDocumentsRequest message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a BatchGetDocumentsRequest message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.firestore.v1.BatchGetDocumentsRequest

BatchGetDocumentsRequest

options $protobuf.IConversionOptions <optional>

Conversion options

toJSON() → {Object.<string, *>}

Converts this BatchGetDocumentsRequest to JSON.