public static final class StructuredAggregationQuery.Aggregation extends com.google.protobuf.GeneratedMessageV3 implements StructuredAggregationQuery.AggregationOrBuilder
Defines an aggregation that produces a single result.Protobuf type
google.firestore.v1.StructuredAggregationQuery.Aggregation| Modifier and Type | Class and Description |
|---|---|
static class |
StructuredAggregationQuery.Aggregation.Builder
Defines an aggregation that produces a single result.
|
static class |
StructuredAggregationQuery.Aggregation.Count
Count of documents that match the query.
|
static interface |
StructuredAggregationQuery.Aggregation.CountOrBuilder |
static class |
StructuredAggregationQuery.Aggregation.OperatorCase |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ALIAS_FIELD_NUMBER |
static int |
COUNT_FIELD_NUMBER |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int COUNT_FIELD_NUMBER
public static final int ALIAS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public StructuredAggregationQuery.Aggregation.OperatorCase getOperatorCase()
getOperatorCase in interface StructuredAggregationQuery.AggregationOrBuilderpublic boolean hasCount()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;hasCount in interface StructuredAggregationQuery.AggregationOrBuilderpublic StructuredAggregationQuery.Aggregation.Count getCount()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;getCount in interface StructuredAggregationQuery.AggregationOrBuilderpublic StructuredAggregationQuery.Aggregation.CountOrBuilder getCountOrBuilder()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;getCountOrBuilder in interface StructuredAggregationQuery.AggregationOrBuilderpublic 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];getAlias in interface StructuredAggregationQuery.AggregationOrBuilderpublic 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];getAliasBytes in interface StructuredAggregationQuery.AggregationOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static StructuredAggregationQuery.Aggregation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StructuredAggregationQuery.Aggregation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StructuredAggregationQuery.Aggregation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StructuredAggregationQuery.Aggregation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StructuredAggregationQuery.Aggregation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StructuredAggregationQuery.Aggregation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StructuredAggregationQuery.Aggregation parseFrom(InputStream input) throws IOException
IOExceptionpublic static StructuredAggregationQuery.Aggregation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static StructuredAggregationQuery.Aggregation parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static StructuredAggregationQuery.Aggregation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static StructuredAggregationQuery.Aggregation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static StructuredAggregationQuery.Aggregation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic StructuredAggregationQuery.Aggregation.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static StructuredAggregationQuery.Aggregation.Builder newBuilder()
public static StructuredAggregationQuery.Aggregation.Builder newBuilder(StructuredAggregationQuery.Aggregation prototype)
public StructuredAggregationQuery.Aggregation.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected StructuredAggregationQuery.Aggregation.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static StructuredAggregationQuery.Aggregation getDefaultInstance()
public static com.google.protobuf.Parser<StructuredAggregationQuery.Aggregation> parser()
public com.google.protobuf.Parser<StructuredAggregationQuery.Aggregation> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public StructuredAggregationQuery.Aggregation getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.