public final class StructuredAggregationQuery extends com.google.protobuf.GeneratedMessageV3 implements StructuredAggregationQueryOrBuilder
Firestore query for running an aggregation over a [StructuredQuery][google.firestore.v1.StructuredQuery].Protobuf type
google.firestore.v1.StructuredAggregationQuery
Modifier and Type | Class and Description |
---|---|
static class |
StructuredAggregationQuery.Aggregation
Defines an aggregation that produces a single result.
|
static interface |
StructuredAggregationQuery.AggregationOrBuilder |
static class |
StructuredAggregationQuery.Builder
Firestore query for running an aggregation over a
[StructuredQuery][google.firestore.v1.StructuredQuery].
|
static class |
StructuredAggregationQuery.QueryTypeCase |
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 |
AGGREGATIONS_FIELD_NUMBER |
static int |
STRUCTURED_QUERY_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, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int STRUCTURED_QUERY_FIELD_NUMBER
public static final int AGGREGATIONS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public StructuredAggregationQuery.QueryTypeCase getQueryTypeCase()
getQueryTypeCase
in interface StructuredAggregationQueryOrBuilder
public boolean hasStructuredQuery()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
hasStructuredQuery
in interface StructuredAggregationQueryOrBuilder
public StructuredQuery getStructuredQuery()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
getStructuredQuery
in interface StructuredAggregationQueryOrBuilder
public StructuredQueryOrBuilder getStructuredQueryOrBuilder()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
getStructuredQueryOrBuilder
in interface StructuredAggregationQueryOrBuilder
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];
getAggregationsList
in interface StructuredAggregationQueryOrBuilder
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];
getAggregationsOrBuilderList
in interface StructuredAggregationQueryOrBuilder
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];
getAggregationsCount
in interface StructuredAggregationQueryOrBuilder
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];
getAggregations
in interface StructuredAggregationQueryOrBuilder
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];
getAggregationsOrBuilder
in interface StructuredAggregationQueryOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static StructuredAggregationQuery parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static StructuredAggregationQuery parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static StructuredAggregationQuery parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static StructuredAggregationQuery parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static StructuredAggregationQuery parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static StructuredAggregationQuery parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static StructuredAggregationQuery parseFrom(InputStream input) throws IOException
IOException
public static StructuredAggregationQuery parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static StructuredAggregationQuery parseDelimitedFrom(InputStream input) throws IOException
IOException
public static StructuredAggregationQuery parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static StructuredAggregationQuery parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static StructuredAggregationQuery parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public StructuredAggregationQuery.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static StructuredAggregationQuery.Builder newBuilder()
public static StructuredAggregationQuery.Builder newBuilder(StructuredAggregationQuery prototype)
public StructuredAggregationQuery.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected StructuredAggregationQuery.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static StructuredAggregationQuery getDefaultInstance()
public static com.google.protobuf.Parser<StructuredAggregationQuery> parser()
public com.google.protobuf.Parser<StructuredAggregationQuery> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public StructuredAggregationQuery getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2023 Google LLC. All rights reserved.