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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
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];
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];
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];
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];
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];
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
|
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>
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public StructuredAggregationQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public StructuredAggregationQuery build()
buildPartial()
public StructuredAggregationQuery buildPartial()
clear()
public StructuredAggregationQuery.Builder clear()
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];
clearField(Descriptors.FieldDescriptor field)
public StructuredAggregationQuery.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public StructuredAggregationQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearQueryType()
public StructuredAggregationQuery.Builder clearQueryType()
clearStructuredQuery()
public StructuredAggregationQuery.Builder clearStructuredQuery()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
clone()
public StructuredAggregationQuery.Builder clone()
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
|
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
|
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];
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];
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
|
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()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getQueryTypeCase()
public StructuredAggregationQuery.QueryTypeCase getQueryTypeCase()
getStructuredQuery()
public StructuredQuery getStructuredQuery()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
getStructuredQueryBuilder()
public StructuredQuery.Builder getStructuredQueryBuilder()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
getStructuredQueryOrBuilder()
public StructuredQueryOrBuilder getStructuredQueryOrBuilder()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
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()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(StructuredAggregationQuery other)
public StructuredAggregationQuery.Builder mergeFrom(StructuredAggregationQuery other)
public StructuredAggregationQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public StructuredAggregationQuery.Builder mergeFrom(Message other)
Parameter |
---|
Name | Description |
other | Message
|
Overrides
mergeStructuredQuery(StructuredQuery value)
public StructuredAggregationQuery.Builder mergeStructuredQuery(StructuredQuery value)
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StructuredAggregationQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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
|
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];
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];
setField(Descriptors.FieldDescriptor field, Object value)
public StructuredAggregationQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public StructuredAggregationQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setStructuredQuery(StructuredQuery value)
public StructuredAggregationQuery.Builder setStructuredQuery(StructuredQuery value)
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
setStructuredQuery(StructuredQuery.Builder builderForValue)
public StructuredAggregationQuery.Builder setStructuredQuery(StructuredQuery.Builder builderForValue)
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
setUnknownFields(UnknownFieldSet unknownFields)
public final StructuredAggregationQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides