com.google.firestore.v1

Class StructuredAggregationQuery.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>

com.google.firestore.v1.StructuredAggregationQuery.Builder

All Implemented Interfaces:

StructuredAggregationQueryOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

StructuredAggregationQuery

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

 Firestore query for running an aggregation over a [StructuredQuery][google.firestore.v1.StructuredQuery].
 

Protobuf type google.firestore.v1.StructuredAggregationQuery

Method Summary

Modifier and Type	Method and Description
StructuredAggregationQuery.Builder	addAggregations(int index, StructuredAggregationQuery.Aggregation.Builder builderForValue) Optional.
StructuredAggregationQuery.Builder	addAggregations(int index, StructuredAggregationQuery.Aggregation value) Optional.
StructuredAggregationQuery.Builder	addAggregations(StructuredAggregationQuery.Aggregation.Builder builderForValue) Optional.
StructuredAggregationQuery.Builder	addAggregations(StructuredAggregationQuery.Aggregation value) Optional.
StructuredAggregationQuery.Aggregation.Builder	addAggregationsBuilder() Optional.
StructuredAggregationQuery.Aggregation.Builder	addAggregationsBuilder(int index) Optional.
StructuredAggregationQuery.Builder	addAllAggregations(Iterable<? extends StructuredAggregationQuery.Aggregation> values) Optional.
StructuredAggregationQuery.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
StructuredAggregationQuery	build()
StructuredAggregationQuery	buildPartial()
StructuredAggregationQuery.Builder	clear()
StructuredAggregationQuery.Builder	clearAggregations() Optional.
StructuredAggregationQuery.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
StructuredAggregationQuery.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
StructuredAggregationQuery.Builder	clearQueryType()
StructuredAggregationQuery.Builder	clearStructuredQuery() Nested structured query.
StructuredAggregationQuery.Builder	clone()
StructuredAggregationQuery.Aggregation	getAggregations(int index) Optional.
StructuredAggregationQuery.Aggregation.Builder	getAggregationsBuilder(int index) Optional.
List<StructuredAggregationQuery.Aggregation.Builder>	getAggregationsBuilderList() Optional.
int	getAggregationsCount() Optional.
List<StructuredAggregationQuery.Aggregation>	getAggregationsList() Optional.
StructuredAggregationQuery.AggregationOrBuilder	getAggregationsOrBuilder(int index) Optional.
List<? extends StructuredAggregationQuery.AggregationOrBuilder>	getAggregationsOrBuilderList() Optional.
StructuredAggregationQuery	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
StructuredAggregationQuery.QueryTypeCase	getQueryTypeCase()
StructuredQuery	getStructuredQuery() Nested structured query.
StructuredQuery.Builder	getStructuredQueryBuilder() Nested structured query.
StructuredQueryOrBuilder	getStructuredQueryOrBuilder() Nested structured query.
boolean	hasStructuredQuery() Nested structured query.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
StructuredAggregationQuery.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
StructuredAggregationQuery.Builder	mergeFrom(com.google.protobuf.Message other)
StructuredAggregationQuery.Builder	mergeFrom(StructuredAggregationQuery other)
StructuredAggregationQuery.Builder	mergeStructuredQuery(StructuredQuery value) Nested structured query.
StructuredAggregationQuery.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
StructuredAggregationQuery.Builder	removeAggregations(int index) Optional.
StructuredAggregationQuery.Builder	setAggregations(int index, StructuredAggregationQuery.Aggregation.Builder builderForValue) Optional.
StructuredAggregationQuery.Builder	setAggregations(int index, StructuredAggregationQuery.Aggregation value) Optional.
StructuredAggregationQuery.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
StructuredAggregationQuery.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
StructuredAggregationQuery.Builder	setStructuredQuery(StructuredQuery.Builder builderForValue) Nested structured query.
StructuredAggregationQuery.Builder	setStructuredQuery(StructuredQuery value) Nested structured query.
StructuredAggregationQuery.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>

clear

public StructuredAggregationQuery.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>

getDefaultInstanceForType

public StructuredAggregationQuery getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public StructuredAggregationQuery build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public StructuredAggregationQuery buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public StructuredAggregationQuery.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>

setField

public StructuredAggregationQuery.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>

clearField

public StructuredAggregationQuery.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>

clearOneof

public StructuredAggregationQuery.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>

setRepeatedField

public StructuredAggregationQuery.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                           int index,
                                                           Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>

addRepeatedField

public StructuredAggregationQuery.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                           Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>

mergeFrom

public StructuredAggregationQuery.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StructuredAggregationQuery.Builder>

mergeFrom

public StructuredAggregationQuery.Builder mergeFrom(StructuredAggregationQuery other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>

mergeFrom

public StructuredAggregationQuery.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StructuredAggregationQuery.Builder>

Throws:

IOException

getQueryTypeCase

public StructuredAggregationQuery.QueryTypeCase getQueryTypeCase()

Specified by:

getQueryTypeCase in interface StructuredAggregationQueryOrBuilder

clearQueryType

public StructuredAggregationQuery.Builder clearQueryType()

hasStructuredQuery

public boolean hasStructuredQuery()

 Nested structured query.
 

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

Specified by:

hasStructuredQuery in interface StructuredAggregationQueryOrBuilder

Returns:

Whether the structuredQuery field is set.

getStructuredQuery

public StructuredQuery getStructuredQuery()

 Nested structured query.
 

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

Specified by:

getStructuredQuery in interface StructuredAggregationQueryOrBuilder

Returns:

The structuredQuery.

setStructuredQuery

public StructuredAggregationQuery.Builder setStructuredQuery(StructuredQuery value)

 Nested structured query.
 

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

setStructuredQuery

public StructuredAggregationQuery.Builder setStructuredQuery(StructuredQuery.Builder builderForValue)

 Nested structured query.
 

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

mergeStructuredQuery

public StructuredAggregationQuery.Builder mergeStructuredQuery(StructuredQuery value)

 Nested structured query.
 

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

clearStructuredQuery

public StructuredAggregationQuery.Builder clearStructuredQuery()

 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;

Specified by:

getStructuredQueryOrBuilder in interface StructuredAggregationQueryOrBuilder

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

Specified by:

getAggregationsList in interface StructuredAggregationQueryOrBuilder

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

Specified by:

getAggregationsCount in interface StructuredAggregationQueryOrBuilder

getAggregations

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

Specified by:

getAggregations in interface StructuredAggregationQueryOrBuilder

setAggregations

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

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

addAggregations

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

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

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

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

addAllAggregations

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

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

removeAggregations

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

getAggregationsBuilder

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

getAggregationsOrBuilder

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

Specified by:

getAggregationsOrBuilder in interface StructuredAggregationQueryOrBuilder

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

Specified by:

getAggregationsOrBuilderList in interface StructuredAggregationQueryOrBuilder

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

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

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

setUnknownFields

public final StructuredAggregationQuery.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>

mergeUnknownFields

public final StructuredAggregationQuery.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredAggregationQuery.Builder>