StructuredAggregationQuery

google.firestore.v1. StructuredAggregationQuery

Represents a StructuredAggregationQuery.

Constructor

new StructuredAggregationQuery(propertiesopt)

Constructs a new StructuredAggregationQuery.

Parameters:
Name Type Attributes Description
properties google.firestore.v1.IStructuredAggregationQuery <optional>

Properties to set

Implements:
  • IStructuredAggregationQuery

Classes

Aggregation

Members

aggregations

StructuredAggregationQuery aggregations.

queryType

StructuredAggregationQuery queryType.

structuredQuery

StructuredAggregationQuery structuredQuery.

Methods

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

Converts this StructuredAggregationQuery to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) fromObject(object) → {google.firestore.v1.StructuredAggregationQuery}

Creates a StructuredAggregationQuery 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.StructuredAggregationQuery

StructuredAggregationQuery

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for StructuredAggregationQuery

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 StructuredAggregationQuery message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.firestore.v1.StructuredAggregationQuery

StructuredAggregationQuery

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object