Package com.google.firestore.v1

Class StructuredAggregationQuery.Aggregation.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessage.Builder<StructuredAggregationQuery.Aggregation.Builder>

com.google.firestore.v1.StructuredAggregationQuery.Aggregation.Builder

All Implemented Interfaces:

StructuredAggregationQuery.AggregationOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

StructuredAggregationQuery.Aggregation

public static final class StructuredAggregationQuery.Aggregation.Builder
extends com.google.protobuf.GeneratedMessage.Builder<StructuredAggregationQuery.Aggregation.Builder>
implements StructuredAggregationQuery.AggregationOrBuilder

 Defines an aggregation that produces a single result.
 

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation

Method Summary

Modifier and Type	Method	Description
StructuredAggregationQuery.Aggregation	build()
StructuredAggregationQuery.Aggregation	buildPartial()
StructuredAggregationQuery.Aggregation.Builder	clear()
StructuredAggregationQuery.Aggregation.Builder	clearAlias()	Optional.
StructuredAggregationQuery.Aggregation.Builder	clearAvg()	Average aggregator.
StructuredAggregationQuery.Aggregation.Builder	clearCount()	Count aggregator.
StructuredAggregationQuery.Aggregation.Builder	clearOperator()
StructuredAggregationQuery.Aggregation.Builder	clearSum()	Sum aggregator.
String	getAlias()	Optional.
com.google.protobuf.ByteString	getAliasBytes()	Optional.
StructuredAggregationQuery.Aggregation.Avg	getAvg()	Average aggregator.
StructuredAggregationQuery.Aggregation.Avg.Builder	getAvgBuilder()	Average aggregator.
StructuredAggregationQuery.Aggregation.AvgOrBuilder	getAvgOrBuilder()	Average aggregator.
StructuredAggregationQuery.Aggregation.Count	getCount()	Count aggregator.
StructuredAggregationQuery.Aggregation.Count.Builder	getCountBuilder()	Count aggregator.
StructuredAggregationQuery.Aggregation.CountOrBuilder	getCountOrBuilder()	Count aggregator.
StructuredAggregationQuery.Aggregation	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
StructuredAggregationQuery.Aggregation.OperatorCase	getOperatorCase()
StructuredAggregationQuery.Aggregation.Sum	getSum()	Sum aggregator.
StructuredAggregationQuery.Aggregation.Sum.Builder	getSumBuilder()	Sum aggregator.
StructuredAggregationQuery.Aggregation.SumOrBuilder	getSumOrBuilder()	Sum aggregator.
boolean	hasAvg()	Average aggregator.
boolean	hasCount()	Count aggregator.
boolean	hasSum()	Sum aggregator.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
StructuredAggregationQuery.Aggregation.Builder	mergeAvg(StructuredAggregationQuery.Aggregation.Avg value)	Average aggregator.
StructuredAggregationQuery.Aggregation.Builder	mergeCount(StructuredAggregationQuery.Aggregation.Count value)	Count aggregator.
StructuredAggregationQuery.Aggregation.Builder	mergeFrom(StructuredAggregationQuery.Aggregation other)
StructuredAggregationQuery.Aggregation.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
StructuredAggregationQuery.Aggregation.Builder	mergeFrom(com.google.protobuf.Message other)
StructuredAggregationQuery.Aggregation.Builder	mergeSum(StructuredAggregationQuery.Aggregation.Sum value)	Sum aggregator.
StructuredAggregationQuery.Aggregation.Builder	setAlias(String value)	Optional.
StructuredAggregationQuery.Aggregation.Builder	setAliasBytes(com.google.protobuf.ByteString value)	Optional.
StructuredAggregationQuery.Aggregation.Builder	setAvg(StructuredAggregationQuery.Aggregation.Avg value)	Average aggregator.
StructuredAggregationQuery.Aggregation.Builder	setAvg(StructuredAggregationQuery.Aggregation.Avg.Builder builderForValue)	Average aggregator.
StructuredAggregationQuery.Aggregation.Builder	setCount(StructuredAggregationQuery.Aggregation.Count value)	Count aggregator.
StructuredAggregationQuery.Aggregation.Builder	setCount(StructuredAggregationQuery.Aggregation.Count.Builder builderForValue)	Count aggregator.
StructuredAggregationQuery.Aggregation.Builder	setSum(StructuredAggregationQuery.Aggregation.Sum value)	Sum aggregator.
StructuredAggregationQuery.Aggregation.Builder	setSum(StructuredAggregationQuery.Aggregation.Sum.Builder builderForValue)	Sum aggregator.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Details

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<StructuredAggregationQuery.Aggregation.Builder>

clear

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

getDefaultInstanceForType

public StructuredAggregationQuery.Aggregation getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public StructuredAggregationQuery.Aggregation build()

Specified by:

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

Specified by:

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

buildPartial

public StructuredAggregationQuery.Aggregation buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

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

mergeFrom

public StructuredAggregationQuery.Aggregation.Builder mergeFrom(StructuredAggregationQuery.Aggregation other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<StructuredAggregationQuery.Aggregation.Builder>

mergeFrom

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

Throws:

IOException

getOperatorCase

public StructuredAggregationQuery.Aggregation.OperatorCase getOperatorCase()

Specified by:

getOperatorCase in interface StructuredAggregationQuery.AggregationOrBuilder

clearOperator

public StructuredAggregationQuery.Aggregation.Builder clearOperator()

hasCount

public boolean hasCount()

 Count aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

Specified by:

hasCount in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

Whether the count field is set.

getCount

public StructuredAggregationQuery.Aggregation.Count getCount()

 Count aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

Specified by:

getCount in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

The count.

setCount

public StructuredAggregationQuery.Aggregation.Builder setCount(StructuredAggregationQuery.Aggregation.Count value)

 Count aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

setCount

public StructuredAggregationQuery.Aggregation.Builder setCount(StructuredAggregationQuery.Aggregation.Count.Builder builderForValue)

 Count aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

mergeCount

public StructuredAggregationQuery.Aggregation.Builder mergeCount(StructuredAggregationQuery.Aggregation.Count value)

 Count aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

clearCount

public StructuredAggregationQuery.Aggregation.Builder clearCount()

 Count aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

getCountBuilder

public StructuredAggregationQuery.Aggregation.Count.Builder getCountBuilder()

 Count aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

getCountOrBuilder

public StructuredAggregationQuery.Aggregation.CountOrBuilder getCountOrBuilder()

 Count aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

Specified by:

getCountOrBuilder in interface StructuredAggregationQuery.AggregationOrBuilder

hasSum

public boolean hasSum()

 Sum aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;

Specified by:

hasSum in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

Whether the sum field is set.

getSum

public StructuredAggregationQuery.Aggregation.Sum getSum()

 Sum aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;

Specified by:

getSum in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

The sum.

setSum

public StructuredAggregationQuery.Aggregation.Builder setSum(StructuredAggregationQuery.Aggregation.Sum value)

 Sum aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;

setSum

public StructuredAggregationQuery.Aggregation.Builder setSum(StructuredAggregationQuery.Aggregation.Sum.Builder builderForValue)

 Sum aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;

mergeSum

public StructuredAggregationQuery.Aggregation.Builder mergeSum(StructuredAggregationQuery.Aggregation.Sum value)

 Sum aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;

clearSum

public StructuredAggregationQuery.Aggregation.Builder clearSum()

 Sum aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;

getSumBuilder

public StructuredAggregationQuery.Aggregation.Sum.Builder getSumBuilder()

 Sum aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;

getSumOrBuilder

public StructuredAggregationQuery.Aggregation.SumOrBuilder getSumOrBuilder()

 Sum aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;

Specified by:

getSumOrBuilder in interface StructuredAggregationQuery.AggregationOrBuilder

hasAvg

public boolean hasAvg()

 Average aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;

Specified by:

hasAvg in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

Whether the avg field is set.

getAvg

public StructuredAggregationQuery.Aggregation.Avg getAvg()

 Average aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;

Specified by:

getAvg in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

The avg.

setAvg

public StructuredAggregationQuery.Aggregation.Builder setAvg(StructuredAggregationQuery.Aggregation.Avg value)

 Average aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;

setAvg

public StructuredAggregationQuery.Aggregation.Builder setAvg(StructuredAggregationQuery.Aggregation.Avg.Builder builderForValue)

 Average aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;

mergeAvg

public StructuredAggregationQuery.Aggregation.Builder mergeAvg(StructuredAggregationQuery.Aggregation.Avg value)

 Average aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;

clearAvg

public StructuredAggregationQuery.Aggregation.Builder clearAvg()

 Average aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;

getAvgBuilder

public StructuredAggregationQuery.Aggregation.Avg.Builder getAvgBuilder()

 Average aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;

getAvgOrBuilder

public StructuredAggregationQuery.Aggregation.AvgOrBuilder getAvgOrBuilder()

 Average aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;

Specified by:

getAvgOrBuilder in interface StructuredAggregationQuery.AggregationOrBuilder

getAlias

public String getAlias()

 Optional. Optional name of the field to store the result of the
 aggregation into.

 If not provided, Firestore will pick a default name following the format
 `field_<incremental_id++>`. For example:

 ```
 AGGREGATE
 COUNT_UP_TO(1) AS count_up_to_1,
 COUNT_UP_TO(2),
 COUNT_UP_TO(3) AS count_up_to_3,
 COUNT(*)
 OVER (
 ...
 );
 ```

 becomes:

 ```
 AGGREGATE
 COUNT_UP_TO(1) AS count_up_to_1,
 COUNT_UP_TO(2) AS field_1,
 COUNT_UP_TO(3) AS count_up_to_3,
 COUNT(*) AS field_2
 OVER (
 ...
 );
 ```

 Requires:

 * Must be unique across all aggregation aliases.
 * Conform to [document field name][google.firestore.v1.Document.fields]
 limitations.
 

string alias = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAlias in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

The alias.

getAliasBytes

public com.google.protobuf.ByteString getAliasBytes()

 Optional. Optional name of the field to store the result of the
 aggregation into.

 If not provided, Firestore will pick a default name following the format
 `field_<incremental_id++>`. For example:

 ```
 AGGREGATE
 COUNT_UP_TO(1) AS count_up_to_1,
 COUNT_UP_TO(2),
 COUNT_UP_TO(3) AS count_up_to_3,
 COUNT(*)
 OVER (
 ...
 );
 ```

 becomes:

 ```
 AGGREGATE
 COUNT_UP_TO(1) AS count_up_to_1,
 COUNT_UP_TO(2) AS field_1,
 COUNT_UP_TO(3) AS count_up_to_3,
 COUNT(*) AS field_2
 OVER (
 ...
 );
 ```

 Requires:

 * Must be unique across all aggregation aliases.
 * Conform to [document field name][google.firestore.v1.Document.fields]
 limitations.
 

string alias = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAliasBytes in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

The bytes for alias.

setAlias

public StructuredAggregationQuery.Aggregation.Builder setAlias(String value)

 Optional. Optional name of the field to store the result of the
 aggregation into.

 If not provided, Firestore will pick a default name following the format
 `field_<incremental_id++>`. For example:

 ```
 AGGREGATE
 COUNT_UP_TO(1) AS count_up_to_1,
 COUNT_UP_TO(2),
 COUNT_UP_TO(3) AS count_up_to_3,
 COUNT(*)
 OVER (
 ...
 );
 ```

 becomes:

 ```
 AGGREGATE
 COUNT_UP_TO(1) AS count_up_to_1,
 COUNT_UP_TO(2) AS field_1,
 COUNT_UP_TO(3) AS count_up_to_3,
 COUNT(*) AS field_2
 OVER (
 ...
 );
 ```

 Requires:

 * Must be unique across all aggregation aliases.
 * Conform to [document field name][google.firestore.v1.Document.fields]
 limitations.
 

string alias = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The alias to set.

Returns:

This builder for chaining.

clearAlias

public StructuredAggregationQuery.Aggregation.Builder clearAlias()

 Optional. Optional name of the field to store the result of the
 aggregation into.

 If not provided, Firestore will pick a default name following the format
 `field_<incremental_id++>`. For example:

 ```
 AGGREGATE
 COUNT_UP_TO(1) AS count_up_to_1,
 COUNT_UP_TO(2),
 COUNT_UP_TO(3) AS count_up_to_3,
 COUNT(*)
 OVER (
 ...
 );
 ```

 becomes:

 ```
 AGGREGATE
 COUNT_UP_TO(1) AS count_up_to_1,
 COUNT_UP_TO(2) AS field_1,
 COUNT_UP_TO(3) AS count_up_to_3,
 COUNT(*) AS field_2
 OVER (
 ...
 );
 ```

 Requires:

 * Must be unique across all aggregation aliases.
 * Conform to [document field name][google.firestore.v1.Document.fields]
 limitations.
 

string alias = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setAliasBytes

public StructuredAggregationQuery.Aggregation.Builder setAliasBytes(com.google.protobuf.ByteString value)

 Optional. Optional name of the field to store the result of the
 aggregation into.

 If not provided, Firestore will pick a default name following the format
 `field_<incremental_id++>`. For example:

 ```
 AGGREGATE
 COUNT_UP_TO(1) AS count_up_to_1,
 COUNT_UP_TO(2),
 COUNT_UP_TO(3) AS count_up_to_3,
 COUNT(*)
 OVER (
 ...
 );
 ```

 becomes:

 ```
 AGGREGATE
 COUNT_UP_TO(1) AS count_up_to_1,
 COUNT_UP_TO(2) AS field_1,
 COUNT_UP_TO(3) AS count_up_to_3,
 COUNT(*) AS field_2
 OVER (
 ...
 );
 ```

 Requires:

 * Must be unique across all aggregation aliases.
 * Conform to [document field name][google.firestore.v1.Document.fields]
 limitations.
 

string alias = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The bytes for alias to set.

Returns:

This builder for chaining.