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
ListDocumentsRequest collectionId.
consistencySelector
ListDocumentsRequest consistencySelector.
mask
ListDocumentsRequest mask.
orderBy
ListDocumentsRequest orderBy.
pageSize
ListDocumentsRequest pageSize.
pageToken
ListDocumentsRequest pageToken.
parent
ListDocumentsRequest parent.
readTime
ListDocumentsRequest readTime.
showMissing
ListDocumentsRequest showMissing.
transaction
ListDocumentsRequest transaction.
Methods
toJSON() → {Object.<string, *>}
Converts this ListDocumentsRequest to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(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 |
Returns:
| Type | Description |
|---|---|
| google.firestore.v1beta1.ListDocumentsRequest |
ListDocumentsRequest |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for ListDocumentsRequest
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 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 |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |