Interface StructuredAggregationQueryOrBuilder (3.12.1)

Version 3.12.1

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public interface StructuredAggregationQueryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAggregations(int index)

public abstract StructuredAggregationQuery.Aggregation getAggregations(int index)

Optional. Series of aggregations to apply over the results of the structured_query. Requires:

• A minimum of one and maximum of five aggregations per query.

repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
StructuredAggregationQuery.Aggregation

getAggregationsCount()

public abstract int getAggregationsCount()

Optional. Series of aggregations to apply over the results of the structured_query. Requires:

• A minimum of one and maximum of five aggregations per query.

repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getAggregationsList()

public abstract List<StructuredAggregationQuery.Aggregation> getAggregationsList()

Optional. Series of aggregations to apply over the results of the structured_query. Requires:

• A minimum of one and maximum of five aggregations per query.

repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Aggregation>

getAggregationsOrBuilder(int index)

public abstract StructuredAggregationQuery.AggregationOrBuilder getAggregationsOrBuilder(int index)

Optional. Series of aggregations to apply over the results of the structured_query. Requires:

• A minimum of one and maximum of five aggregations per query.

repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
StructuredAggregationQuery.AggregationOrBuilder

getAggregationsOrBuilderList()

public abstract List<? extends StructuredAggregationQuery.AggregationOrBuilder> getAggregationsOrBuilderList()

Optional. Series of aggregations to apply over the results of the structured_query. Requires:

• A minimum of one and maximum of five aggregations per query.

repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.firestore.v1.StructuredAggregationQuery.AggregationOrBuilder>

getQueryTypeCase()

public abstract StructuredAggregationQuery.QueryTypeCase getQueryTypeCase()

Returns
Type	Description
StructuredAggregationQuery.QueryTypeCase

getStructuredQuery()

public abstract StructuredQuery getStructuredQuery()

Nested structured query.

.google.firestore.v1.StructuredQuery structured_query = 1;

Returns
Type	Description
StructuredQuery	The structuredQuery.

getStructuredQueryOrBuilder()

public abstract StructuredQueryOrBuilder getStructuredQueryOrBuilder()

Nested structured query.

.google.firestore.v1.StructuredQuery structured_query = 1;

Returns
Type	Description
StructuredQueryOrBuilder

hasStructuredQuery()

public abstract boolean hasStructuredQuery()

Nested structured query.

.google.firestore.v1.StructuredQuery structured_query = 1;

Returns
Type	Description
boolean	Whether the structuredQuery field is set.