Class StructuredAggregationQuery.Builder (3.12.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
TypeDescription
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
NameDescription
valueStructuredAggregationQuery.Aggregation
Returns
TypeDescription
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
NameDescription
builderForValueStructuredAggregationQuery.Aggregation.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueStructuredAggregationQuery.Aggregation
Returns
TypeDescription
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
NameDescription
indexint
builderForValueStructuredAggregationQuery.Aggregation.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.firestore.v1.StructuredAggregationQuery.Aggregation>
Returns
TypeDescription
StructuredAggregationQuery.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StructuredAggregationQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StructuredAggregationQuery.Builder
Overrides

build()

public StructuredAggregationQuery build()
Returns
TypeDescription
StructuredAggregationQuery

buildPartial()

public StructuredAggregationQuery buildPartial()
Returns
TypeDescription
StructuredAggregationQuery

clear()

public StructuredAggregationQuery.Builder clear()
Returns
TypeDescription
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
TypeDescription
StructuredAggregationQuery.Builder

clearField(Descriptors.FieldDescriptor field)

public StructuredAggregationQuery.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StructuredAggregationQuery.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StructuredAggregationQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StructuredAggregationQuery.Builder
Overrides

clearQueryType()

public StructuredAggregationQuery.Builder clearQueryType()
Returns
TypeDescription
StructuredAggregationQuery.Builder

clearStructuredQuery()

public StructuredAggregationQuery.Builder clearStructuredQuery()

Nested structured query.

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

Returns
TypeDescription
StructuredAggregationQuery.Builder

clone()

public StructuredAggregationQuery.Builder clone()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.firestore.v1.StructuredAggregationQuery.AggregationOrBuilder>

getDefaultInstanceForType()

public StructuredAggregationQuery getDefaultInstanceForType()
Returns
TypeDescription
StructuredAggregationQuery

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getQueryTypeCase()

public StructuredAggregationQuery.QueryTypeCase getQueryTypeCase()
Returns
TypeDescription
StructuredAggregationQuery.QueryTypeCase

getStructuredQuery()

public StructuredQuery getStructuredQuery()

Nested structured query.

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

Returns
TypeDescription
StructuredQuery

The structuredQuery.

getStructuredQueryBuilder()

public StructuredQuery.Builder getStructuredQueryBuilder()

Nested structured query.

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

Returns
TypeDescription
StructuredQuery.Builder

getStructuredQueryOrBuilder()

public StructuredQueryOrBuilder getStructuredQueryOrBuilder()

Nested structured query.

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

Returns
TypeDescription
StructuredQueryOrBuilder

hasStructuredQuery()

public boolean hasStructuredQuery()

Nested structured query.

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

Returns
TypeDescription
boolean

Whether the structuredQuery field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(StructuredAggregationQuery other)

public StructuredAggregationQuery.Builder mergeFrom(StructuredAggregationQuery other)
Parameter
NameDescription
otherStructuredAggregationQuery
Returns
TypeDescription
StructuredAggregationQuery.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StructuredAggregationQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredAggregationQuery.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StructuredAggregationQuery.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StructuredAggregationQuery.Builder
Overrides

mergeStructuredQuery(StructuredQuery value)

public StructuredAggregationQuery.Builder mergeStructuredQuery(StructuredQuery value)

Nested structured query.

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

Parameter
NameDescription
valueStructuredQuery
Returns
TypeDescription
StructuredAggregationQuery.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StructuredAggregationQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
valueStructuredAggregationQuery.Aggregation
Returns
TypeDescription
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
NameDescription
indexint
builderForValueStructuredAggregationQuery.Aggregation.Builder
Returns
TypeDescription
StructuredAggregationQuery.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public StructuredAggregationQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StructuredAggregationQuery.Builder
Overrides

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

public StructuredAggregationQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StructuredAggregationQuery.Builder
Overrides

setStructuredQuery(StructuredQuery value)

public StructuredAggregationQuery.Builder setStructuredQuery(StructuredQuery value)

Nested structured query.

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

Parameter
NameDescription
valueStructuredQuery
Returns
TypeDescription
StructuredAggregationQuery.Builder

setStructuredQuery(StructuredQuery.Builder builderForValue)

public StructuredAggregationQuery.Builder setStructuredQuery(StructuredQuery.Builder builderForValue)

Nested structured query.

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

Parameter
NameDescription
builderForValueStructuredQuery.Builder
Returns
TypeDescription
StructuredAggregationQuery.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final StructuredAggregationQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StructuredAggregationQuery.Builder
Overrides