com.google.firestore.v1

Class StructuredAggregationQuery.Aggregation.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.Builder<StructuredAggregationQuery.Aggregation.Builder>
implements StructuredAggregationQuery.AggregationOrBuilder

 Defines a aggregation that produces a single result.
 

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation

Method Summary

Modifier and Type	Method and Description
StructuredAggregationQuery.Aggregation.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
StructuredAggregationQuery.Aggregation	build()
StructuredAggregationQuery.Aggregation	buildPartial()
StructuredAggregationQuery.Aggregation.Builder	clear()
StructuredAggregationQuery.Aggregation.Builder	clearAlias() Optional.
StructuredAggregationQuery.Aggregation.Builder	clearCount() Count aggregator.
StructuredAggregationQuery.Aggregation.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
StructuredAggregationQuery.Aggregation.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
StructuredAggregationQuery.Aggregation.Builder	clearOperator()
StructuredAggregationQuery.Aggregation.Builder	clone()
String	getAlias() Optional.
com.google.protobuf.ByteString	getAliasBytes() Optional.
StructuredAggregationQuery.Aggregation.Count	getCount() Count aggregator.
StructuredAggregationQuery.Aggregation.Count.Builder	getCountBuilder() Count aggregator.
StructuredAggregationQuery.Aggregation.CountOrBuilder	getCountOrBuilder() Count aggregator.
StructuredAggregationQuery.Aggregation	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
StructuredAggregationQuery.Aggregation.OperatorCase	getOperatorCase()
boolean	hasCount() Count aggregator.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
StructuredAggregationQuery.Aggregation.Builder	mergeCount(StructuredAggregationQuery.Aggregation.Count value) Count aggregator.
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	mergeFrom(StructuredAggregationQuery.Aggregation other)
StructuredAggregationQuery.Aggregation.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
StructuredAggregationQuery.Aggregation.Builder	setAlias(String value) Optional.
StructuredAggregationQuery.Aggregation.Builder	setAliasBytes(com.google.protobuf.ByteString value) Optional.
StructuredAggregationQuery.Aggregation.Builder	setCount(StructuredAggregationQuery.Aggregation.Count.Builder builderForValue) Count aggregator.
StructuredAggregationQuery.Aggregation.Builder	setCount(StructuredAggregationQuery.Aggregation.Count value) Count aggregator.
StructuredAggregationQuery.Aggregation.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
StructuredAggregationQuery.Aggregation.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
StructuredAggregationQuery.Aggregation.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.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.GeneratedMessageV3.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.GeneratedMessageV3.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

clone

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

setField

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

clearField

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

clearOneof

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

setRepeatedField

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

addRepeatedField

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

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_UP_TO(4)
 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_UP_TO(4) 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_UP_TO(4)
 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_UP_TO(4) 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_UP_TO(4)
 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_UP_TO(4) 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_UP_TO(4)
 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_UP_TO(4) 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_UP_TO(4)
 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_UP_TO(4) 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.

setUnknownFields

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

mergeUnknownFields

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