StructuredQuery

google.firestore.v1beta1. StructuredQuery

Represents a StructuredQuery.

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

CollectionSelector
CompositeFilter
FieldFilter
FieldReference
Filter
Order
Projection
UnaryFilter

Members

Direction

Direction enum.

Properties:
Name Type Description
DIRECTION_UNSPECIFIED string

DIRECTION_UNSPECIFIED value

ASCENDING string

ASCENDING value

DESCENDING string

DESCENDING value

endAt

StructuredQuery endAt.

from

StructuredQuery from.

limit

StructuredQuery limit.

offset

StructuredQuery offset.

orderBy

StructuredQuery orderBy.

select

StructuredQuery select.

startAt

StructuredQuery startAt.

where

StructuredQuery where.

Methods

(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) 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

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

Converts this StructuredQuery to JSON.

Returns:
Type Description
Object.<string, *>

JSON object