Constructor
new StructuredQuery(propertiesopt)
Constructs a new StructuredQuery.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.firestore.v1beta1.IStructuredQuery |
<optional> |
Properties to set |
- Implements:
-
- IStructuredQuery
Classes
Members
endAt
StructuredQuery endAt.
from
StructuredQuery from.
limit
StructuredQuery limit.
offset
StructuredQuery offset.
orderBy
StructuredQuery orderBy.
select
StructuredQuery select.
startAt
StructuredQuery startAt.
where
StructuredQuery where.
Direction
Direction enum.
Properties:
| Name | Type | Description |
|---|---|---|
DIRECTION_UNSPECIFIED |
string |
DIRECTION_UNSPECIFIED value |
ASCENDING |
string |
ASCENDING value |
DESCENDING |
string |
DESCENDING value |
Methods
toJSON() → {Object.<string, *>}
Converts this StructuredQuery to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) fromObject(object) → {google.firestore.v1beta1.StructuredQuery}
Creates a StructuredQuery 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.StructuredQuery |
StructuredQuery |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for StructuredQuery
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 StructuredQuery message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.firestore.v1beta1.StructuredQuery |
StructuredQuery |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |