Constructor
new ListDocumentsRequest(propertiesopt)
Constructs a new ListDocumentsRequest.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.firestore.v1beta1.IListDocumentsRequest |
<optional> |
Properties to set |
- Implements:
-
- IListDocumentsRequest
Members
collectionId :string
ListDocumentsRequest collectionId.
consistencySelector :"transaction"|"readTime"|undefined
ListDocumentsRequest consistencySelector.
mask :google.firestore.v1beta1.IDocumentMask|null|undefined
ListDocumentsRequest mask.
orderBy :string
ListDocumentsRequest orderBy.
pageSize :number
ListDocumentsRequest pageSize.
pageToken :string
ListDocumentsRequest pageToken.
parent :string
ListDocumentsRequest parent.
readTime :google.protobuf.ITimestamp|null|undefined
ListDocumentsRequest readTime.
showMissing :boolean
ListDocumentsRequest showMissing.
transaction :Uint8Array
ListDocumentsRequest transaction.
Methods
(static) fromObject(object) → {google.firestore.v1beta1.ListDocumentsRequest}
Creates a ListDocumentsRequest 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 ListDocumentsRequest message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.firestore.v1beta1.ListDocumentsRequest |
ListDocumentsRequest |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
toJSON() → {Object.<string, *>}
Converts this ListDocumentsRequest to JSON.