Class StructuredAggregationQuery.Builder (3.21.1)

public static final class StructuredAggregationQuery.Builder extends GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder> implements StructuredAggregationQueryOrBuilder

Firestore query for running an aggregation over a StructuredQuery.

Protobuf type google.firestore.v1.StructuredAggregationQuery

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAggregations(StructuredAggregationQuery.Aggregation value)

public StructuredAggregationQuery.Builder addAggregations(StructuredAggregationQuery.Aggregation value)

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
value StructuredAggregationQuery.Aggregation
Returns
Type Description
StructuredAggregationQuery.Builder

addAggregations(StructuredAggregationQuery.Aggregation.Builder builderForValue)

public StructuredAggregationQuery.Builder addAggregations(StructuredAggregationQuery.Aggregation.Builder builderForValue)

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
builderForValue StructuredAggregationQuery.Aggregation.Builder
Returns
Type Description
StructuredAggregationQuery.Builder

addAggregations(int index, StructuredAggregationQuery.Aggregation value)

public StructuredAggregationQuery.Builder addAggregations(int index, StructuredAggregationQuery.Aggregation value)

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];

Parameters
Name Description
index int
value StructuredAggregationQuery.Aggregation
Returns
Type Description
StructuredAggregationQuery.Builder

addAggregations(int index, StructuredAggregationQuery.Aggregation.Builder builderForValue)

public StructuredAggregationQuery.Builder addAggregations(int index, StructuredAggregationQuery.Aggregation.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue StructuredAggregationQuery.Aggregation.Builder
Returns
Type Description
StructuredAggregationQuery.Builder

addAggregationsBuilder()

public StructuredAggregationQuery.Aggregation.Builder addAggregationsBuilder()

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
StructuredAggregationQuery.Aggregation.Builder

addAggregationsBuilder(int index)

public StructuredAggregationQuery.Aggregation.Builder addAggregationsBuilder(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.Builder

addAllAggregations(Iterable<? extends StructuredAggregationQuery.Aggregation> values)

public StructuredAggregationQuery.Builder addAllAggregations(Iterable<? extends StructuredAggregationQuery.Aggregation> values)

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
values Iterable<? extends com.google.firestore.v1.StructuredAggregationQuery.Aggregation>
Returns
Type Description
StructuredAggregationQuery.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StructuredAggregationQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StructuredAggregationQuery.Builder
Overrides

build()

public StructuredAggregationQuery build()
Returns
Type Description
StructuredAggregationQuery

buildPartial()

public StructuredAggregationQuery buildPartial()
Returns
Type Description
StructuredAggregationQuery

clear()

public StructuredAggregationQuery.Builder clear()
Returns
Type Description
StructuredAggregationQuery.Builder
Overrides

clearAggregations()

public StructuredAggregationQuery.Builder clearAggregations()

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
StructuredAggregationQuery.Builder

clearField(Descriptors.FieldDescriptor field)

public StructuredAggregationQuery.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
StructuredAggregationQuery.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StructuredAggregationQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
StructuredAggregationQuery.Builder
Overrides

clearQueryType()

public StructuredAggregationQuery.Builder clearQueryType()
Returns
Type Description
StructuredAggregationQuery.Builder

clearStructuredQuery()

public StructuredAggregationQuery.Builder clearStructuredQuery()

Nested structured query.

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

Returns
Type Description
StructuredAggregationQuery.Builder

clone()

public StructuredAggregationQuery.Builder clone()
Returns
Type Description
StructuredAggregationQuery.Builder
Overrides

getAggregations(int index)

public 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

getAggregationsBuilder(int index)

public StructuredAggregationQuery.Aggregation.Builder getAggregationsBuilder(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.Builder

getAggregationsBuilderList()

public List<StructuredAggregationQuery.Aggregation.Builder> getAggregationsBuilderList()

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<Builder>

getAggregationsCount()

public 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 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 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 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>

getDefaultInstanceForType()

public StructuredAggregationQuery getDefaultInstanceForType()
Returns
Type Description
StructuredAggregationQuery

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getQueryTypeCase()

public StructuredAggregationQuery.QueryTypeCase getQueryTypeCase()
Returns
Type Description
StructuredAggregationQuery.QueryTypeCase

getStructuredQuery()

public StructuredQuery getStructuredQuery()

Nested structured query.

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

Returns
Type Description
StructuredQuery

The structuredQuery.

getStructuredQueryBuilder()

public StructuredQuery.Builder getStructuredQueryBuilder()

Nested structured query.

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

Returns
Type Description
StructuredQuery.Builder

getStructuredQueryOrBuilder()

public StructuredQueryOrBuilder getStructuredQueryOrBuilder()

Nested structured query.

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

Returns
Type Description
StructuredQueryOrBuilder

hasStructuredQuery()

public boolean hasStructuredQuery()

Nested structured query.

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

Returns
Type Description
boolean

Whether the structuredQuery field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(StructuredAggregationQuery other)

public StructuredAggregationQuery.Builder mergeFrom(StructuredAggregationQuery other)
Parameter
Name Description
other StructuredAggregationQuery
Returns
Type Description
StructuredAggregationQuery.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StructuredAggregationQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredAggregationQuery.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public StructuredAggregationQuery.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
StructuredAggregationQuery.Builder
Overrides

mergeStructuredQuery(StructuredQuery value)

public StructuredAggregationQuery.Builder mergeStructuredQuery(StructuredQuery value)

Nested structured query.

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

Parameter
Name Description
value StructuredQuery
Returns
Type Description
StructuredAggregationQuery.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StructuredAggregationQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StructuredAggregationQuery.Builder
Overrides

removeAggregations(int index)

public StructuredAggregationQuery.Builder removeAggregations(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.Builder

setAggregations(int index, StructuredAggregationQuery.Aggregation value)

public StructuredAggregationQuery.Builder setAggregations(int index, StructuredAggregationQuery.Aggregation value)

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];

Parameters
Name Description
index int
value StructuredAggregationQuery.Aggregation
Returns
Type Description
StructuredAggregationQuery.Builder

setAggregations(int index, StructuredAggregationQuery.Aggregation.Builder builderForValue)

public StructuredAggregationQuery.Builder setAggregations(int index, StructuredAggregationQuery.Aggregation.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue StructuredAggregationQuery.Aggregation.Builder
Returns
Type Description
StructuredAggregationQuery.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public StructuredAggregationQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StructuredAggregationQuery.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StructuredAggregationQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
StructuredAggregationQuery.Builder
Overrides

setStructuredQuery(StructuredQuery value)

public StructuredAggregationQuery.Builder setStructuredQuery(StructuredQuery value)

Nested structured query.

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

Parameter
Name Description
value StructuredQuery
Returns
Type Description
StructuredAggregationQuery.Builder

setStructuredQuery(StructuredQuery.Builder builderForValue)

public StructuredAggregationQuery.Builder setStructuredQuery(StructuredQuery.Builder builderForValue)

Nested structured query.

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

Parameter
Name Description
builderForValue StructuredQuery.Builder
Returns
Type Description
StructuredAggregationQuery.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final StructuredAggregationQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StructuredAggregationQuery.Builder
Overrides