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
BatchGetDocumentsRequest consistencySelector.
database
BatchGetDocumentsRequest database.
documents
BatchGetDocumentsRequest documents.
mask
BatchGetDocumentsRequest mask.
newTransaction
BatchGetDocumentsRequest newTransaction.
readTime
BatchGetDocumentsRequest readTime.
transaction
BatchGetDocumentsRequest transaction.
Methods
toJSON() → {Object.<string, *>}
Converts this BatchGetDocumentsRequest to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(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 |
Returns:
| Type | Description |
|---|---|
| google.firestore.v1.BatchGetDocumentsRequest |
BatchGetDocumentsRequest |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for BatchGetDocumentsRequest
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(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 |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |